A text engine used to create text objects. More...
Inheritance diagram for SDL::TextEngine:
Public Member Functions | |
| constexpr | TextEngine ()=default |
| Default ctor. | |
| constexpr | TextEngine (const TextEngineRaw resource) |
| Constructs from TextEngineParam. More... | |
| constexpr | TextEngine (const TextEngine &other)=delete |
| Copy constructor. | |
| constexpr | TextEngine (TextEngine &&other) |
| Move constructor. | |
| virtual | ~TextEngine ()=default |
| Destructor. | |
| TextEngine & | operator= (TextEngine &&other) |
| Assignment operator. | |
| TextEngine & | operator= (const TextEngine &other)=delete |
| Assignment operator. | |
| constexpr TextEngineRaw | get () const |
| Retrieves underlying TextEngineRaw. | |
| constexpr TextEngineRaw | release () |
| Retrieves underlying TextEngineRaw and clear this. | |
| constexpr auto | operator<=> (const TextEngine &other) const =default |
| Comparison. | |
| constexpr bool | operator== (std::nullptr_t _) const |
| Comparison. | |
| constexpr | operator bool () const |
| Converts to bool. | |
| constexpr | operator TextEngineParam () const |
| Converts to TextEngineParam. | |
| virtual void | Destroy ()=0 |
| frees up textEngine. Pure virtual More... | |
| Text | CreateText (FontParam font, std::string_view text) |
| Create a text object from UTF-8 text and a text engine. More... | |
Detailed Description
This is a public interface that can be used by applications and libraries to perform customize rendering with text objects. See <SDL3_ttf/SDL_textengine.h> for details.
There are three text engines provided with the library:
- Drawing to an Surface, created with SurfaceTextEngine.SurfaceTextEngine()
- Drawing with an SDL 2D renderer, created with RendererTextEngine.RendererTextEngine()
- Drawing with the SDL GPU API, created with GPUTextEngine.GPUTextEngine()
- Since
- This struct is available since SDL_ttf 3.0.0.
- Category:
- Resource
Constructor & Destructor Documentation
◆ TextEngine()
|
inlineexplicitconstexpr |
- Parameters
-
resource a TextEngineRaw to be wrapped.
This assumes the ownership, call release() if you need to take back.
Member Function Documentation
◆ Destroy()
|
pure virtual |
Implemented in SDL::SurfaceTextEngine, SDL::RendererTextEngine, and SDL::GPUTextEngine.
The documentation for this class was generated from the following file:
- SDL3pp/SDL3pp_ttf.h
