Urho3D::Font Class Reference
Public Member Functions |
Static Public Member Functions |
Private Member Functions |
Private Attributes |
List of all members
Urho3D::Font Class Reference
Font resource. More...
#include <Urho3D/UI/Font.h>
Inheritance diagram for Urho3D::Font:
Collaboration diagram for Urho3D::Font:
Public Member Functions | |
| Font (Context *context) | |
| Construct. | |
| ~Font () override | |
| Destruct. | |
| bool | BeginLoad (Deserializer &source) override |
| Load resource from stream. May be called from a worker thread. Return true if successful. | |
| bool | SaveXML (Serializer &dest, int pointSize, bool usedGlyphs=false, const String &indentation="\t") |
| Save resource as a new bitmap font type in XML format. Return true if successful. | |
| void | SetAbsoluteGlyphOffset (const IntVector2 &offset) |
| void | SetScaledGlyphOffset (const Vector2 &offset) |
| FontFace * | GetFace (float pointSize) |
| Return font face. Pack and render to a texture if not rendered yet. Return null on error. | |
| FontType | GetFontType () const |
| bool | IsSDFFont () const |
| Is signed distance field font. | |
| const IntVector2 & | GetAbsoluteGlyphOffset () const |
| const Vector2 & | GetScaledGlyphOffset () const |
| IntVector2 | GetTotalGlyphOffset (float pointSize) const |
| Return the total effective offset for a point size. | |
| void | ReleaseFaces () |
| Release font faces and recreate them next time when requested. Called when font textures lost or global font properties change. | |
 Public Member Functions inherited from Urho3D::Resource | |
| Resource (Context *context) | |
| Construct. | |
| bool | Load (Deserializer &source) |
| Load resource synchronously. Call both BeginLoad() & EndLoad() and return true if both succeeded. | |
| virtual bool | EndLoad () |
| Finish resource loading. Always called from the main thread. Return true if successful. | |
| virtual bool | Save (Serializer &dest) const |
| Save resource. Return true if successful. | |
| bool | LoadFile (const String &fileName) |
| virtual bool | SaveFile (const String &fileName) const |
| void | SetName (const String &name) |
| void | SetMemoryUse (unsigned size) |
| Set memory use in bytes, possibly approximate. | |
| void | ResetUseTimer () |
| Reset last used timer. | |
| void | SetAsyncLoadState (AsyncLoadState newState) |
| Set the asynchronous loading state. Called by ResourceCache. Resources in the middle of asynchronous loading are not normally returned to user. | |
| const String & | GetName () const |
| StringHash | GetNameHash () const |
| Return name hash. | |
| unsigned | GetMemoryUse () const |
| unsigned | GetUseTimer () |
| AsyncLoadState | GetAsyncLoadState () const |
| Return the asynchronous loading state. | |
| Public Member Functions inherited from Urho3D::Object | |
| Object (Context *context) | |
| Construct. | |
| ~Object () override | |
| Destruct. Clean up self from event sender & receiver structures. | |
| virtual StringHash | GetType () const =0 |
| virtual const String & | GetTypeName () const =0 |
| virtual const TypeInfo * | GetTypeInfo () const =0 |
| Return type info. | |
| virtual void | OnEvent (Object *sender, StringHash eventType, VariantMap &eventData) |
| Handle event. | |
| bool | IsInstanceOf (StringHash type) const |
| Check current instance is type of specified type. | |
| bool | IsInstanceOf (const TypeInfo *typeInfo) const |
| Check current instance is type of specified type. | |
| template<typename T > | |
| bool | IsInstanceOf () const |
| Check current instance is type of specified class. | |
| template<typename T > | |
| T * | Cast () |
| Cast the object to specified most derived class. | |
| template<typename T > | |
| const T * | Cast () const |
| Cast the object to specified most derived class. | |
| void | SubscribeToEvent (StringHash eventType, EventHandler *handler) |
| Subscribe to an event that can be sent by any sender. | |
| void | SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler) |
| Subscribe to a specific sender's event. | |
| void | SubscribeToEvent (StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr) |
| Subscribe to an event that can be sent by any sender. | |
| void | SubscribeToEvent (Object *sender, StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr) |
| Subscribe to a specific sender's event. | |
| void | UnsubscribeFromEvent (StringHash eventType) |
| Unsubscribe from an event. | |
| void | UnsubscribeFromEvent (Object *sender, StringHash eventType) |
| Unsubscribe from a specific sender's event. | |
| void | UnsubscribeFromEvents (Object *sender) |
| Unsubscribe from a specific sender's events. | |
| void | UnsubscribeFromAllEvents () |
| Unsubscribe from all events. | |
| void | UnsubscribeFromAllEventsExcept (const PODVector< StringHash > &exceptions, bool onlyUserData) |
| Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events). | |
| void | SendEvent (StringHash eventType) |
| Send event to all subscribers. | |
| void | SendEvent (StringHash eventType, VariantMap &eventData) |
| Send event with parameters to all subscribers. | |
| VariantMap & | GetEventDataMap () const |
| Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps. | |
| template<typename... Args> | |
| void | SendEvent (StringHash eventType, Args... args) |
| Send event with variadic parameter pairs to all subscribers. The parameter pairs is a list of paramID and paramValue separated by comma, one pair after another. | |
| Context * | GetContext () const |
| Return execution context. | |
| const Variant & | GetGlobalVar (StringHash key) const |
| const VariantMap & | GetGlobalVars () const |
| void | SetGlobalVar (StringHash key, const Variant &value) |
| Object * | GetSubsystem (StringHash type) const |
| Return subsystem by type. | |
| Object * | GetEventSender () const |
| Return active event sender. Null outside event handling. | |
| EventHandler * | GetEventHandler () const |
| Return active event handler. Null outside event handling. | |
| bool | HasSubscribedToEvent (StringHash eventType) const |
| Return whether has subscribed to an event without specific sender. | |
| bool | HasSubscribedToEvent (Object *sender, StringHash eventType) const |
| Return whether has subscribed to a specific sender's event. | |
| bool | HasEventHandlers () const |
| Return whether has subscribed to any event. | |
| template<class T > | |
| T * | GetSubsystem () const |
| Template version of returning a subsystem. | |
| const String & | GetCategory () const |
| void | SetBlockEvents (bool block) |
| Block object from sending and receiving events. | |
| bool | GetBlockEvents () const |
| Return sending and receiving events blocking status. | |
| 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. | |
| RefCounted & | operator= (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 |
| int | WeakRefs () const |
| RefCount * | RefCountPtr () |
| Return pointer to the reference count structure. | |
Static Public Member Functions | |
| static void | RegisterObject (Context *context) |
| Register object factory. | |
| Static Public Member Functions inherited from Urho3D::Object | |
| static const TypeInfo * | GetTypeInfoStatic () |
| Return type info static. | |
Private Member Functions | |
| URHO3D_OBJECT (Font, Resource) | |
| void | LoadParameters () |
| Load font glyph offset parameters from an optional XML file. Called internally when loading TrueType fonts. | |
| FontFace * | GetFaceFreeType (float pointSize) |
| Return font face using FreeType. Called internally. Return null on error. | |
| FontFace * | GetFaceBitmap (float pointSize) |
| Return bitmap font face. Called internally. Return null on error. | |
Private Attributes | |
| HashMap< int, SharedPtr< FontFace > > | faces_ |
| Created faces. | |
| SharedArrayPtr< unsigned char > | fontData_ |
| Font data. | |
| unsigned | fontDataSize_ |
| Size of font data. | |
| IntVector2 | absoluteOffset_ |
| Absolute position adjustment for glyphs. | |
| Vector2 | scaledOffset_ |
| Point size scaled position adjustment for glyphs. | |
| FontType | fontType_ |
| Font type. | |
| bool | sdfFont_ |
| Signed distance field font flag. | |
Additional Inherited Members | |
| Protected Attributes inherited from Urho3D::Object | |
| Context * | context_ |
| Execution context. | |
Detailed Description
Font resource.
Member Function Documentation
◆ GetAbsoluteGlyphOffset()
|
inline |
Return absolute position adjustment for glyphs.
◆ GetFontType()
|
inline |
Return font type.
◆ GetScaledGlyphOffset()
|
inline |
Return point size scaled position adjustment for glyphs.
◆ SetAbsoluteGlyphOffset()
| void Urho3D::Font::SetAbsoluteGlyphOffset | ( | const IntVector2 & | offset | ) |
Set absolute (in pixels) position adjustment for glyphs.
◆ SetScaledGlyphOffset()
| void Urho3D::Font::SetScaledGlyphOffset | ( | const Vector2 & | offset | ) |
Set point size scaled position adjustment for glyphs.
The documentation for this class was generated from the following files:
- Source/Urho3D/UI/Font.h
- Source/Urho3D/UI/Font.cpp