class: ewol::resource::TexturedFont
Description:
Constructor and Destructor:
# TexturedFont (const std::string & _fontName);
# ~TexturedFont (void );
Synopsis:
+ std::vector<GlyphProperty> m_listElement;
+ int32_t getHeight (const enum ewol::font::mode _displayMode);
+ int32_t getFontSize (void );
+ int32_t getIndex (char32_t _charcode,
const enum ewol::font::mode _displayMode);
+ ewol::GlyphProperty* getGlyphPointer (const char32_t & _charcode,
const enum ewol::font::mode _displayMode);
+ enum ewol::font::mode getWrappingMode (const enum ewol::font::mode _source);
+ ewol::resource::TexturedFont* keep (const std::string & _filename);
+ void release (ewol::resource::TexturedFont* & _object);
Object Hierarchy:
+ewol::Object
+--> +ewol::Resource
+--> +ewol::resource::Texture
+--> ewol::resource::TexturedFont
Detail:
m_listElement
+ std::vector<GlyphProperty> m_listElement;
TexturedFont
# TexturedFont (const std::string & _fontName);
~TexturedFont
# ~TexturedFont (void );
getHeight
+ int32_t getHeight (const enum ewol::font::mode _displayMode);
get the display height of this font
Parameter [input]: _displayMode Mode to display the currrent font
Return: Dimention of the font need between 2 lines
getFontSize
+ int32_t getFontSize (void );
get the font height (user friendly)
Return: Dimention of the font the user requested
getIndex
+ int32_t getIndex (char32_t _charcode,
const enum ewol::font::mode _displayMode);
get the ID of a unicode charcode
Parameter [input]: _charcode The unicodeValue
Parameter [input]: _displayMode Mode to display the currrent font
Return: The ID in the table (if it does not exist : return 0)
getGlyphPointer
+ ewol::GlyphProperty* getGlyphPointer (const char32_t & _charcode,
const enum ewol::font::mode _displayMode);
get the pointer on the coresponding glyph
Parameter [input]: _charcode The unicodeValue
Parameter [input]: _displayMode Mode to display the currrent font
Return: The pointer on the glyph == > never NULL
getWrappingMode
+ enum ewol::font::mode getWrappingMode (const enum ewol::font::mode _source);
The wrapping mode is used to prevent the non existance of a specific mode.
For exemple when a blod mode does not exist, this resend a regular mode.
Parameter [input]: _source The requested mode.
Return: the best mode we have in stock.
keep
+ ewol::resource::TexturedFont* keep (const std::string & _filename);
keep the resource pointer.
Note: Never free this pointer by your own...
Parameter [input]: _filename Name of the texture font.
Return: pointer on the resource or NULL if an error occured.
release
+ void release (ewol::resource::TexturedFont* & _object);
release the keeped resources
Parameter [input] [output]: reference on the object pointer
+ewol::Object
+--> +ewol::Resource
+--> +ewol::resource::Texture
+--> ewol::resource::TexturedFont
Detail:
m_listElement
+ std::vector<GlyphProperty> m_listElement;
TexturedFont
# TexturedFont (const std::string & _fontName);
~TexturedFont
# ~TexturedFont (void );
getHeight
+ int32_t getHeight (const enum ewol::font::mode _displayMode);get the display height of this font
| Parameter [input]: | _displayMode | Mode to display the currrent font |
| Return: | Dimention of the font need between 2 lines |
getFontSize
+ int32_t getFontSize (void );get the font height (user friendly)
| Return: | Dimention of the font the user requested |
getIndex
+ int32_t getIndex (char32_t _charcode,get the ID of a unicode charcode
const enum ewol::font::mode _displayMode);
| Parameter [input]: | _charcode | The unicodeValue | Parameter [input]: | _displayMode | Mode to display the currrent font |
| Return: | The ID in the table (if it does not exist : return 0) |
getGlyphPointer
+ ewol::GlyphProperty* getGlyphPointer (const char32_t & _charcode,get the pointer on the coresponding glyph
const enum ewol::font::mode _displayMode);
| Parameter [input]: | _charcode | The unicodeValue | Parameter [input]: | _displayMode | Mode to display the currrent font |
| Return: | The pointer on the glyph == > never NULL |
getWrappingMode
+ enum ewol::font::mode getWrappingMode (const enum ewol::font::mode _source);The wrapping mode is used to prevent the non existance of a specific mode. For exemple when a blod mode does not exist, this resend a regular mode.
| Parameter [input]: | _source | The requested mode. |
| Return: | the best mode we have in stock. |
keep
+ ewol::resource::TexturedFont* keep (const std::string & _filename);keep the resource pointer.
Note: Never free this pointer by your own...
| Parameter [input]: | _filename | Name of the texture font. |
| Return: | pointer on the resource or NULL if an error occured. |
release
+ void release (ewol::resource::TexturedFont* & _object);release the keeped resources
| Parameter [input] [output]: | reference | on the object pointer |