CobbletextEngineProperties Struct Reference

Properties for controlling output parameters on a struct CobbletextEngine instance. More...

#include <engine_properties.h>

Public Attributes
uint32_t	line_length
	Line length in pixels. More...
const char *	locale
	Locale as a BCP 47 language tag. More...
CobbletextTextAlignment	text_alignment
	Controls the alignment of text in each line. More...

Detailed Description

Properties for controlling output parameters on a struct CobbletextEngine instance.

Member Data Documentation

line_length

uint32_t CobbletextEngineProperties::line_length

Line length in pixels.

If the value is 0, no word wrapping is performed. Otherwise, lines will be word wrapped at the given pixel width.

locale

const char* CobbletextEngineProperties::locale

Locale as a BCP 47 language tag.

This value is used for assisting lower-level functions to tailor the presentation of the text to your application's user. It is typically the GUI's locale or a document's language.

The default is an empty string which indicates automatic detection of the user's locale if possible.

A tag is 2 characters or longer.

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

text_alignment

CobbletextTextAlignment CobbletextEngineProperties::text_alignment

Controls the alignment of text in each line.

Default is not specified.

---

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

• cobbletext/engine_properties.h