Font API for grouping multiple fonts into a collection
| Namespace: | FontCollection |
| Include: | #include <dmsdk/font/fontcollection.h> |
| TYPES | |
|---|---|
| HFontCollection | Handle that holds a collection of fonts to use dur... |
| FUNCTIONS | |
|---|---|
| FontResult FontCollectionAddFont(HFontCollection coll, HFont font) | add a font to the font collection |
| HFontCollection FontCollectionCreate() | Create a font collection |
| void FontCollectionDestroy(HFontCollection coll) | destroy a font collection |
| HFont FontCollectionGetFont(HFontCollection coll) | return the font associated with the given index |
| uint32_t FontCollectionGetFontCount(HFontCollection coll) | return number of fonts in the collection |
| FontResult FontCollectionRemoveFont(HFontCollection coll, HFont font) | remove a font from the font collection |
FontResult FontCollectionAddFont(HFontCollection coll, HFont font)
add a font to the font collection
PARAMETERS
HFontCollection |
coll |
the font collection |
HFont |
font |
the font |
RETURNS
FontResult |
the result. FONT_RESULT_OK if successful |
HFontCollection FontCollectionCreate()
Create a font collection
PARAMETERS
RETURNS
HFontCollection |
the font collection |
void FontCollectionDestroy(HFontCollection coll)
destroy a font collection
PARAMETERS
HFontCollection |
coll |
the font collection |
HFont FontCollectionGetFont(HFontCollection coll)
return the font associated with the given index
PARAMETERS
HFontCollection |
coll |
the font collection |
RETURNS
HFont |
the font at the given index |
uint32_t FontCollectionGetFontCount(HFontCollection coll)
return number of fonts in the collection
PARAMETERS
HFontCollection |
coll |
the font collection |
RETURNS
uint32_t |
the number of fonts |
FontResult FontCollectionRemoveFont(HFontCollection coll, HFont font)
remove a font from the font collection
PARAMETERS
HFontCollection |
coll |
the font collection |
HFont |
font |
the font |
RETURNS
FontResult |
the result. FONT_RESULT_OK if successful |
Handle that holds a collection of fonts to use during text shaping