SDL::Text Struct Reference

Handle to an owned text. More...

Inheritance diagram for SDL::Text:

Public Member Functions
void	Destroy ()
	Destroy a text object created by a text engine.
TextShared	share ()
	Move this text into a TextShared.
constexpr	ResourceUnique (std::nullptr_t=nullptr)
	Default constructor.
constexpr	ResourceUnique (base::value_type value, DELETER deleter={})
	Constructs from raw type.
constexpr	ResourceUnique (ResourceUnique &&other)
	Move constructor.
	ResourceUnique (const ResourceUnique &other)=delete
Public Member Functions inherited from SDL::ResourceUnique< TextRef >
constexpr	ResourceUnique (std::nullptr_t=nullptr)
	Default constructor.
constexpr	ResourceUnique (base::value_type value, DefaultDeleter< TextRef > deleter={})
	Constructs from raw type.
constexpr	ResourceUnique (ResourceUnique &&other)
	Move constructor.
	ResourceUnique (const ResourceUnique &other)=delete
	~ResourceUnique ()
	Destructor.
constexpr ResourceUnique &	operator= (ResourceUnique other)
	Assignment operator.
void	reset ()
	Resets the value, destroying the resource if not nullptr.
Public Member Functions inherited from SDL::ResourceOwnerBase< RESOURCE, DELETER >
RESOURCE	release ()
	Returns reference and reset this.
Public Member Functions inherited from SDL::ResourcePtrBase< RESOURCE >
constexpr	operator bool () const
	Check if not null.
constexpr bool	operator== (const ResourcePtrBase &other) const
	Comparison.
constexpr bool	operator== (std::nullptr_t) const
	Comparison.
constexpr bool	operator== (std::nullopt_t) const
	Comparison.
constexpr reference	operator* () const
	Gets reference.
constexpr const reference *	operator-> () const
	Gets addressable reference.
constexpr reference *	operator-> ()
	Gets addressable reference.
reference	get () const
	Get reference.

Static Public Member Functions
static Text	Create (TextEngineRef engine, FontRef font, std::string_view text)
	Create a text object from UTF-8 text and a text engine.

Additional Inherited Members
Public Types inherited from SDL::ResourceOwnerBase< RESOURCE, DELETER >
using	deleter = DELETER
	The deleter type.
Public Types inherited from SDL::ResourcePtrBase< RESOURCE >
using	reference = RESOURCE
	The reference resource type.
using	value_type = typename reference::value_type
	The raw resource type.
Protected Member Functions inherited from SDL::ResourceOwnerBase< RESOURCE, DELETER >
constexpr	ResourceOwnerBase (base::value_type value={}, DELETER deleter={})
	Constructs from raw type.
void	free ()
	Frees resource.
Protected Member Functions inherited from SDL::ResourcePtrBase< RESOURCE >
constexpr	ResourcePtrBase (value_type value={})
	Constructs from raw type.
reference &	get ()
	Get reference.

Detailed Description

Category:

Resource

See also

TextRef

Member Function Documentation

Create()

static Text SDL::Text::Create ( TextEngineRef  engine, FontRef  font, std::string_view  text  )

inlinestatic

Parameters

engine	the text engine to use when creating the text object, may be nullptr.
font	the font to render with.
text	the text to use, in UTF-8 encoding.

Returns

a TextRef object or nullptr on failure; call GetError() for more information.

Thread safety:

This function should be called on the thread that created the font and text engine.

Since

This function is available since SDL_ttf 3.0.0.

See also

Text.Destroy

Destroy()

void SDL::Text::Destroy ( )

inline

Thread safety:

This function should be called on the thread that created the text.

Since

This function is available since SDL_ttf 3.0.0.

See also

Text.Create

---

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

• SDL3pp/SDL3pp_ttf.h