SDL::GPUTextEngine Struct Reference

A GPU based text engine. More...

Inheritance diagram for SDL::GPUTextEngine:

Public Member Functions
constexpr	GPUTextEngine (TextEngineRaw resource) noexcept
	Constructs from raw TextEngine.
constexpr	GPUTextEngine (GPUTextEngine &&other) noexcept
	Move constructor.
constexpr GPUTextEngine &	operator= (GPUTextEngine &&other) noexcept
	Move assignment operator.
	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 ()
	Destructor.
void	SetGPUWinding (GPUTextEngineWinding winding)
	Sets the winding order of the vertices returned by GetGPUTextDrawData for a particular GPU text engine.
GPUTextEngineWinding	GetGPUWinding () const
	Get the winding order of the vertices returned by GetGPUTextDrawData for a particular GPU text engine.
void	Destroy ()
	Destroy a text engine created for drawing text with the SDL GPU API.
Public Member Functions inherited from SDL::TextEngine
Text	CreateText (FontRef font, std::string_view text)
	Create a text object from UTF-8 text and a text engine.
constexpr	ResourceBaseT ()=default
	Default constructor, creates null/invalid resource.
constexpr	ResourceBaseT (RawPointer resource)
	Constructs from resource pointer.
constexpr	ResourceBaseT (std::nullptr_t)
	Constructs null/invalid.
constexpr	ResourceBaseT (const ResourceBaseT &)=default
	Copy constructor.
constexpr	ResourceBaseT (ResourceBaseT &&) noexcept=default
	Move constructor.
Public Member Functions inherited from SDL::ResourceBaseT< TextEngineRaw >
constexpr	ResourceBaseT ()=default
	Default constructor, creates null/invalid resource.
constexpr	operator bool () const
	Converts to bool.
constexpr auto	operator<=> (const ResourceBaseT &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::ResourceBaseT< TextEngineRaw >
using	RawPointer
	The underlying raw pointer type.
using	RawConstPointer
	The underlying const raw pointer type.
Protected Member Functions inherited from SDL::ResourceBaseT< TextEngineRaw >
constexpr	~ResourceBaseT ()=default
	Destructor.
constexpr ResourceBaseT &	operator= (const ResourceBaseT &)=default
	Assignment operator.

Detailed Description

A GPU based text engine.

Constructor & Destructor Documentation

GPUTextEngine()

SDL::GPUTextEngine::GPUTextEngine ( TextEngineRaw resource )

inlineexplicitconstexprnoexcept

Constructs from raw TextEngine.

Parameters

resource

a TextEngineRaw to be wrapped.

This assumes the ownership, call release() if you need to take back.

---

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

• SDL3pp/SDL3pp_ttf.h