Cobbletext  0.2.0
Complex text layout and rendering engine
Public Attributes | List of all members
CobbletextTextProperties Struct Reference

Properties for text runs on a struct CobbletextEngine instance. More...

#include <text_properties.h>

Public Attributes

const char * language
 The current language as a BCP 47 language tag. More...
 
const char * script
 The current script as a ISO 15924 string. More...
 
CobbletextScriptDirection script_direction
 The current script direction. More...
 
CobbletextFontID font
 The current font face. More...
 
double font_size
 The current font size in points. More...
 
CobbletextCustomPropertyID custom_property
 The current user-provided custom property. More...
 

Detailed Description

Properties for text runs on a struct CobbletextEngine instance.

Member Data Documentation

◆ custom_property

CobbletextCustomPropertyID CobbletextTextProperties::custom_property

The current user-provided custom property.

Default value is 0.

◆ font

CobbletextFontID CobbletextTextProperties::font

The current font face.

Default is 0 (not corresponding to a valid font face).

◆ font_size

double CobbletextTextProperties::font_size

The current font size in points.

Default is 12.

If the font file contains bitmaps and not vectors, the value represented is in pixels.

◆ language

const char* CobbletextTextProperties::language

The current language as a BCP 47 language tag.

This low-level value typically controls the glyph variant selection to use from a font file.

Default value is an empty string which indicates automatic detection.

A tag is 2 characters or longer.

  • Getter: Never null.
  • Setter: May be null. (Null interpreted as empty string).

◆ script

const char* CobbletextTextProperties::script

The current script as a ISO 15924 string.

This low-level value typically controls the rules for shaping glyphs.

A ISO 15924 string is a 4 character string such as "Latn".

Default value is an empty string which indicates automatic detection.

  • Getter: Never null.
  • Setter: May be null. (Null interpreted as empty string).

◆ script_direction

CobbletextScriptDirection CobbletextTextProperties::script_direction

The current script direction.

Default value "not specified" indicates automatic detection.


The documentation for this struct was generated from the following file: