TSdlTtfTextEngine
Abstract base text engine. Use one of the following implementations:
- TSdlTtfSurfaceTextEngine * TSdlTtfRendererTextEngine * TSdlTtfGpuTextEngine
Definition
Unit: Neslib.Sdl3.Ttf
Inheritance
Derived: TSdlTtfGpuTextEngine, TSdlTtfRendererTextEngine, TSdlTtfSurfaceTextEngine
See Also
Fields
Name | Description |
---|---|
FHandle |
Constructors
Name | Description |
---|---|
Create | |
Destroy | Destructor. |
Destroy |
Methods
Name | Description |
---|---|
AfterConstruction | |
CreateText(TSdlTtfFont, String) | Create a text object for use with this engine. |
CreateText(TSdlTtfFont, UTF8String) | Create a text object for use with this engine. |
DestroyHandle |
Field Descriptions
FHandle
var FHandle: PTTF_TextEngine
Type: PTTF_TextEngine
Constructor Descriptions
Create
class constructor Create
Destroy
Destructor.
All text created by this engine should be destroyed before calling this destructor.
destructor Destroy; override
Remarks
This destructor should be called on the thread that created the engine.
Destroy
class destructor Destroy
Method Descriptions
AfterConstruction
procedure AfterConstruction; override
CreateText(TSdlTtfFont, String)
Create a text object for use with this engine.
function CreateText(const AFont: TSdlTtfFont; const AText: String): TSdlTtfText; overload; inline
Exceptions
ESdlError
: Raised on failure.
Parameters
AFont
: TSdlTtfFont
: The font to render with.
AText
: String
: The text to use.
Returns
TSdlTtfText
: A TSdlTtfText object.
See Also
Remarks
This method should be called on the thread that created the font and text engine.
CreateText(TSdlTtfFont, UTF8String)
Create a text object for use with this engine.
function CreateText(const AFont: TSdlTtfFont; const AText: UTF8String): TSdlTtfText; overload; inline
Exceptions
ESdlError
: Raised on failure.
Parameters
AFont
: TSdlTtfFont
: The font to render with.
AText
: UTF8String
: The text to use.
Returns
TSdlTtfText
: A TSdlTtfText object.
See Also
Remarks
This method should be called on the thread that created the font and text engine.
DestroyHandle
procedure DestroyHandle; virtual; abstract