SDL::GPUTextEngine Struct Reference

A GPU based text engine. More...

Inheritance diagram for SDL::GPUTextEngine:

Public Member Functions
	GPUTextEngine (GPUDeviceRef device)
	Create a text engine for drawing text with the SDL GPU API.
	GPUTextEngine (PropertiesRef props)
	Create a text engine for drawing text with the SDL GPU API, with the specified properties.
	GPUTextEngine (const GPUTextEngine &)=delete
GPUTextEngine &	operator= (const GPUTextEngine &)=delete
void	SetGPUWinding (GPUTextEngineWinding winding)
	Sets the winding order of the vertices returned by Text.GetGPUDrawData for a particular GPU text engine.
GPUTextEngineWinding	GetGPUWinding () const
	Get the winding order of the vertices returned by Text.GetGPUDrawData for a particular GPU text engine.
void	Destroy () final
	Destroy a text engine created for drawing text with the SDL GPU API.
Public Member Functions inherited from SDL::TextEngine
constexpr	TextEngine (TextEngineRaw resource) noexcept
	Constructs from raw TextEngine.
constexpr	TextEngine (const TextEngine &other)=delete
	Copy constructor.
constexpr	TextEngine (TextEngine &&other) noexcept
	Move constructor.
virtual	~TextEngine ()
	Destructor.
constexpr TextEngine &	operator= (TextEngine &&other) noexcept
	Assignment operator.
TextEngine &	operator= (const TextEngine &other)=delete
	Assignment operator.
Text	CreateText (FontRef font, std::string_view text)
	Create a text object from UTF-8 text and a text engine.
constexpr	ResourceBase (RawPointer resource)
	Constructs from resource pointer.
constexpr	ResourceBase (std::nullptr_t=nullptr)
	Constructs null/invalid.
Public Member Functions inherited from SDL::ResourceBase< TextEngineRaw >
constexpr	ResourceBase (RawPointer resource)
	Constructs from resource pointer.
constexpr	operator bool () const
	Converts to bool.
constexpr auto	operator<=> (const ResourceBase &other) const=default
	Comparison.
constexpr RawConstPointer	operator-> () const noexcept
	member access to underlying resource pointer.
constexpr RawPointer	get () const noexcept
	Retrieves underlying resource pointer.
constexpr RawPointer	release () noexcept
	Retrieves underlying resource pointer and clear this.

Additional Inherited Members
Public Types inherited from SDL::ResourceBase< TextEngineRaw >
using	RawPointer
	The underlying raw pointer type.
using	RawConstPointer
	The underlying const raw pointer type.

Detailed Description

A GPU based text engine.

---

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

• SDL3pp/SDL3pp_ttf.h