Urho3D
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
Urho3D::FontFace Class Referenceabstract

Font face description. More...

#include </home/runner/work/urho3d-doxygen.github.io/urho3d-doxygen.github.io/urho3d_repo/Source/Urho3D/UI/FontFace.h>

Inheritance diagram for Urho3D::FontFace:
Urho3D::RefCounted Urho3D::FontFaceBitmap Urho3D::FontFaceFreeType

Public Member Functions

 FontFace (Font *font)
 Construct.
 
 ~FontFace () override
 Destruct.
 
virtual bool Load (const unsigned char *fontData, unsigned fontDataSize, float pointSize)=0
 Load font face. More...
 
virtual const FontGlyphGetGlyph (c32 c)
 Return pointer to the glyph structure corresponding to a character. Return null if glyph not found. More...
 
virtual bool HasMutableGlyphs () const
 Return if font face uses mutable glyphs. More...
 
float GetKerning (c32 c, c32 d) const
 Return the kerning for a character and the next character.
 
bool IsDataLost () const
 Return true when one of the texture has a data loss.
 
float GetPointSize () const
 Return point size.
 
float GetRowHeight () const
 Return row height.
 
const Vector< SharedPtr< Texture2D > > & GetTextures () const
 Return textures.
 
- Public Member Functions inherited from Urho3D::RefCounted
 RefCounted ()
 Construct. Allocate the reference count structure and set an initial self weak reference.
 
virtual ~RefCounted ()
 Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
 
 RefCounted (const RefCounted &rhs)=delete
 Prevent copy construction.
 
RefCountedoperator= (const RefCounted &rhs)=delete
 Prevent assignment.
 
void AddRef ()
 Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
 
void ReleaseRef ()
 Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
 
int Refs () const
 Return reference count.
 
int WeakRefs () const
 Return weak reference count.
 
RefCountRefCountPtr ()
 Return pointer to the reference count structure.
 

Protected Member Functions

SharedPtr< Texture2DCreateFaceTexture ()
 Create a texture for font rendering.
 
SharedPtr< Texture2DLoadFaceTexture (const SharedPtr< Image > &image)
 Load font face texture from image resource.
 

Protected Attributes

Fontfont_ {}
 Parent font.
 
HashMap< c32, FontGlyphglyphMapping_
 Glyph mapping.
 
HashMap< u32, float > kerningMapping_
 Kerning mapping.
 
Vector< SharedPtr< Texture2D > > textures_
 Glyph texture pages.
 
float pointSize_ {}
 Point size.
 
float rowHeight_ {}
 Row height.
 

Friends

class Font
 
class FontFaceBitmap
 

Detailed Description

Font face description.

Member Function Documentation

◆ GetGlyph()

const FontGlyph * Urho3D::FontFace::GetGlyph ( c32  c)
virtual

Return pointer to the glyph structure corresponding to a character. Return null if glyph not found.

Reimplemented in Urho3D::FontFaceFreeType.

◆ HasMutableGlyphs()

virtual bool Urho3D::FontFace::HasMutableGlyphs ( ) const
inlinevirtual

Return if font face uses mutable glyphs.

Reimplemented in Urho3D::FontFaceFreeType.

◆ Load()

virtual bool Urho3D::FontFace::Load ( const unsigned char *  fontData,
unsigned  fontDataSize,
float  pointSize 
)
pure virtual

Load font face.

Implemented in Urho3D::FontFaceBitmap, and Urho3D::FontFaceFreeType.


The documentation for this class was generated from the following files: