![]() |
Murl Engine API
Version 2024.1
|
A collection of multiple fonts to render, see IFont. More...
#include <murl_util_font_collection.h>
A collection of multiple fonts to render, see IFont.
Public Member Functions | |
FontCollection (Real size) | |
Constructor taking a base font size. More... | |
~FontCollection () override | |
The destructor. | |
Bool | SetSize (Real size) override |
Implementation of IFont::SetSize(). More... | |
Real | GetSize () const override |
Implementation of IFont::GetSize(). More... | |
Bool | SetSpacing (Real spacing) override |
Implementation of IFont::SetSpacing(). More... | |
Real | GetSpacing () const override |
Implementation of IFont::GetSpacing(). More... | |
Bool | SetLeading (Real leading) override |
Implementation of IFont::SetLeading(). More... | |
Real | GetLeading () const override |
Implementation of IFont::GetLeading(). More... | |
Bool | SetEmbolding (Real strength) override |
Implementation of IFont::SetEmbolding(). More... | |
Real | GetEmbolding () const override |
Implementation of IFont::GetEmbolding(). More... | |
Bool | SetBlur (Real strength) override |
Implementation of IFont::SetBlur(). More... | |
Real | GetBlur () const override |
Implementation of IFont::GetBlur(). More... | |
Bool | SetSpaceWidthFactor (Real factor) override |
Implementation of IFont::SetSpaceWidthFactor(). More... | |
Real | GetSpaceWidthFactor () const override |
Implementation of IFont::GetSpaceWidthFactor(). More... | |
Bool | SetDigitWidthFactor (Real factor) override |
Implementation of IFont::SetDigitWidthFactor(). More... | |
Real | GetDigitWidthFactor () const override |
Implementation of IFont::GetDigitWidthFactor(). More... | |
Bool | SetSameDigitWidthEnabled (Bool enabled) override |
Implementation of IFont::SetSameDigitWidthEnabled(). More... | |
Bool | IsSameDigitWidthEnabled () const override |
Implementation of IFont::IsSameDigitWidthEnabled(). More... | |
Bool | SetLegacyEmboldingEnabled (Bool enabled) override |
Implementation of IFont::SetLegacyEmboldingEnabled(). More... | |
Bool | IsLegacyEmboldingEnabled () const override |
Implementation of IFont::IsLegacyEmboldingEnabled(). More... | |
Bool | RenderText (const String &text, const Color &textColor, const Color &backgroundColor, Bool clearSurface, Bool enableWordWrap, Real containerPosX, Real containerPosY, Real containerSizeX, Real containerSizeY, IEnums::TextAlignmentX alignX, IEnums::TextAlignmentY alignY, IVideoSurface *surface) const override |
Implementation of IFont::RenderText(). More... | |
Bool | QueryTextSize (const String &text, Bool enableWordWrap, Real containerPosX, Real containerPosY, Real containerSizeX, Real containerSizeY, Real &textSizeX, Real &textSizeY) const override |
Implementation of IFont::QueryTextSize(). More... | |
virtual Bool | AddFont (const String &startTag, const String &endTag, Font *font) |
Add a named font. More... | |
virtual Bool | AddColor (const String &startTag, const String &endTag, const Color &textColor, const Color &backgroundColor) |
Add a named color. More... | |
virtual Bool | AddPlaceholder (const String &startTag, const String &endTag, Real sizeX, Real sizeY, Real scale) |
Add a named placeholder. More... | |
virtual Bool | SetTagStart (const String &character, const String &escapeSequence) |
Set the tag start character & escape sequence. More... | |
virtual Bool | SetTagEnd (const String &character, const String &escapeSequence) |
Set the tag end character & escape sequence. More... | |
Murl::Util::FontCollection::FontCollection | ( | Real | size | ) |
Constructor taking a base font size.
size | The base size of the font collection. |
Implementation of IFont::SetSize().
size | The font size. |
Implements Murl::IFont.
|
overridevirtual |
Implementation of IFont::SetSpacing().
spacing | The character spacing value. |
Implements Murl::IFont.
|
overridevirtual |
Implementation of IFont::SetLeading().
leading | The leading value. |
Implements Murl::IFont.
|
overridevirtual |
Implementation of IFont::SetEmbolding().
strength | The embolding strength value. |
Implements Murl::IFont.
|
overridevirtual |
Implementation of IFont::GetEmbolding().
Implements Murl::IFont.
Implementation of IFont::SetBlur().
strength | The positive blur strength value. |
Implements Murl::IFont.
|
overridevirtual |
Implementation of IFont::SetSpaceWidthFactor().
factor | The space width factor. |
Implements Murl::IFont.
|
overridevirtual |
Implementation of IFont::GetSpaceWidthFactor().
Implements Murl::IFont.
Implementation of IFont::SetDigitWidthFactor().
factor | The digit width factor. |
Implements Murl::IFont.
|
overridevirtual |
Implementation of IFont::GetDigitWidthFactor().
Implements Murl::IFont.
Implementation of IFont::SetSameDigitWidthEnabled().
enabled | If true, all digits use the same horizontal advance value. |
Implements Murl::IFont.
|
overridevirtual |
Implementation of IFont::IsSameDigitWidthEnabled().
Implements Murl::IFont.
Implementation of IFont::SetLegacyEmboldingEnabled().
enabled | If true, legacy embolding is used. |
Implements Murl::IFont.
|
overridevirtual |
|
overridevirtual |
Implementation of IFont::RenderText().
text | The text to render. |
textColor | The text color to render. |
backgroundColor | The text background color to render. |
clearSurface | If true, the output surface is cleared before rendering. |
enableWordWrap | If true, word wrapping is enabled. |
containerPosX | The horizontal text position in the video stream. |
containerPosY | The vertical text position in the video stream. |
containerSizeX | The horizontal size of the text rectangle, or 0 if the video stream's X size should be used |
containerSizeY | The vertical size of the text rectangle, or 0 if the video stream's Y size should be used |
alignX | The horizontal text alignment. |
alignY | The vertical text alignment. |
surface | The destination video surface. |
Implements Murl::IFont.
|
overridevirtual |
Implementation of IFont::QueryTextSize().
text | The text to query. |
enableWordWrap | If true, word wrapping is enabled. |
containerPosX | The horizontal text position in the video stream. |
containerPosY | The vertical text position in the video stream. |
containerSizeX | The horizontal size of the text rectangle, or 0 if the video stream's X size should be used |
containerSizeY | The vertical size of the text rectangle, or 0 if the video stream's Y size should be used |
textSizeX | The text width return value. |
textSizeY | The text height return value. |
Implements Murl::IFont.
|
virtual |
Add a named font.
The font collection takes ownership of the given font object.
startTag | The start tag to identify the font. |
endTag | The end tag to identify the font. |
font | The font to add. |
|
virtual |
Add a named color.
startTag | The start tag to identify the font. |
endTag | The end tag to identify the font. |
textColor | The foreground color to add. |
backgroundColor | The background color to add. |
|
virtual |
Add a named placeholder.
startTag | The start tag to identify the font. |
endTag | The end tag to identify the font. |
sizeX | The horizontal size. |
sizeY | The vertical size. |
scale | The additional scale factor |
|
virtual |
Set the tag start character & escape sequence.
character | An UTF8 sequence for a single tag start character. |
escapeSequence | The escape sequence for that character. |
|
virtual |
Set the tag end character & escape sequence.
character | An UTF8 sequence for a single tag end character. |
escapeSequence | The escape sequence for that character. |