SDL3pp
A slim C++ wrapper for SDL3
Loading...
Searching...
No Matches
Public Member Functions | List of all members
SDL::TextEngine Struct Reference

Handle to an owned textEngine. More...

Inheritance diagram for SDL::TextEngine:
Inheritance graph
[legend]

Public Member Functions

constexpr TextEngine (TTF_TextEngine *resource={})
 Constructs from the underlying resource.
 
constexpr TextEngine (const TextEngine &other)=delete
 
constexpr TextEngine (TextEngine &&other)=default
 Move constructor.
 
 ~TextEngine ()
 Frees up resource when object goes out of scope.
 
TextEngineoperator= (TextEngine other)
 Assignment operator.
 
constexpr TextEngineRef (const TextEngineRef &other)
 Copy constructor.
 
constexpr TextEngineRef (TextEngineRef &&other)
 Move constructor.
 
- Public Member Functions inherited from SDL::TextEngineRef
constexpr TextEngineRef (const TextEngineRef &other)
 Copy constructor.
 
constexpr TextEngineRef (TextEngineRef &&other)
 Move constructor.
 
constexpr ~TextEngineRef ()=default
 Default constructor.
 
TextEngineRefoperator= (TextEngineRef other)
 Assignment operator.
 
void reset (TTF_TextEngine *newResource={})
 frees up TextEngineBase.
 
constexpr TextEngineBase (TTF_TextEngine *engine, void(*destroy)(TTF_TextEngine *engine))
 Create from engine and custom destroyer.
 
- Public Member Functions inherited from SDL::TextEngineBase
constexpr TextEngineBase (TTF_TextEngine *engine, void(*destroy)(TTF_TextEngine *engine))
 Create from engine and custom destroyer.
 
void SetGPUWinding (GPUTextEngineWinding winding)
 Sets the winding order of the vertices returned by TextBase.GetGPUDrawData for a particular GPU text engine.
 
GPUTextEngineWinding GetGPUWinding () const
 Get the winding order of the vertices returned by TextBase.GetGPUDrawData for a particular GPU text engine.
 
constexpr Resource (T resource={})
 Constructs the underlying resource.
 
constexpr Resource (std::nullptr_t)
 Equivalent to default ctor.
 
constexpr Resource (std::nullopt_t)
 Equivalent to default ctor.
 
 Resource (const Resource &other)=delete
 
 Resource (Resource &&other)=delete
 
- Public Member Functions inherited from SDL::Resource< TTF_TextEngine * >
constexpr Resource (TTF_TextEngine * resource={})
 Constructs the underlying resource.
 
constexpr Resource (std::nullptr_t)
 Equivalent to default ctor.
 
constexpr Resource (std::nullopt_t)
 Equivalent to default ctor.
 
 Resource (const Resource &other)=delete
 
 Resource (Resource &&other)=delete
 
Resourceoperator= (const Resource &other)=delete
 
Resourceoperator= (Resource &&other)=delete
 
constexpr operator bool () const
 True if contains a valid resource.
 
constexpr bool operator== (const Resource &other) const=default
 Comparison.
 
constexpr bool operator== (std::nullopt_t) const
 Comparison.
 
constexpr bool operator== (std::nullptr_t) const
 Comparison.
 
constexpr TTF_TextEngine * get () const
 Return contained resource;.
 
constexpr TTF_TextEngine * release (TTF_TextEngine * newResource={})
 Return contained resource and empties or replace value.
 
constexpr const TTF_TextEngine * operator-> () const
 Access to fields.
 
constexpr TTF_TextEngine * operator-> ()
 Access to fields.
 

Additional Inherited Members

- Protected Attributes inherited from SDL::TextEngineBase
void(* m_destroy )(TTF_TextEngine *engine) = nullptr
 Custom destroyer.
 

Detailed Description

Category:
Resource
See also
TextEngineBase
TextEngineRef

The documentation for this struct was generated from the following file: