SDL::SurfaceTextEngine Struct Reference

A surface based text engine.

Inheritance diagram for SDL::SurfaceTextEngine:

Collaboration diagram for SDL::SurfaceTextEngine:

Public Member Functions
	SurfaceTextEngine ()
	Create a text engine for drawing text on SDL surfaces. More...
void	Destroy () final
	Destroy a text engine created for drawing text on SDL surfaces. More...
Public Member Functions inherited from SDL::TextEngine
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...

Constructor & Destructor Documentation

SurfaceTextEngine()

SDL::SurfaceTextEngine::SurfaceTextEngine ( )

inline

Postcondition

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

Thread safety:

It is safe to call this function from any thread.

Since

This function is available since SDL_ttf 3.0.0.

See also

SurfaceTextEngine.Destroy

Text.DrawSurface

---

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

• SDL3pp/SDL3pp_ttf.h