Handle to an owned textEngine. More...

Inheritance diagram for SDL::TextEngine:

[legend]

Public Member Functions
TextEngineShared	share ()
	Move this textEngine into a TextEngineShared.

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< TextEngineRef, TextEngineDeleter >
constexpr	ResourceUnique (std::nullptr_t=nullptr)
	Default constructor.

constexpr	ResourceUnique (base::value_type value, TextEngineDeleter 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 TextEngine	CreateSurface ()
	Create a text engine for drawing text on SDL surfaces.

static TextEngine	CreateRenderer (RendererRef renderer)
	Create a text engine for drawing text on an SDL renderer.

static TextEngine	CreateRendererWithProperties (PropertiesRef props)
	Create a text engine for drawing text on an SDL renderer, with the specified properties.

static TextEngine	CreateGPU (SDL_GPUDevice *device)
	Create a text engine for drawing text with the SDL GPU API.

static TextEngine	CreateGPUWithProperties (PropertiesRef props)
	Create a text engine for drawing text with the SDL GPU API, with the specified properties.

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: TextEngineRef

Member Function Documentation

◆ CreateGPU()

static TextEngine SDL::TextEngine::CreateGPU ( SDL_GPUDevice * device )

inlinestatic

Parameters

device the SDL_GPUDevice to use for creating textures and drawing text.

Returns: a TextEngineRef object or nullptr on failure; call GetError() for more information.

Thread safety:: This function should be called on the thread that created the device.

Since: This function is available since SDL_ttf 3.0.0.

See also: TextEngine.CreateGPUWithProperties; TTF_DestroyGPUTextEngine; TextRef.GetGPUDrawData

◆ CreateGPUWithProperties()

static TextEngine SDL::TextEngine::CreateGPUWithProperties ( PropertiesRef props )

inlinestatic

These are the supported properties:

prop::GpuTextEngine.DEVICE_POINTER: the SDL_GPUDevice to use for creating textures and drawing text.
prop::GpuTextEngine.ATLAS_TEXTURE_SIZE_NUMBER: the size of the texture atlas

Parameters

props the properties to use.

Returns: a TextEngineRef object or nullptr on failure; call GetError() for more information.

Thread safety:: This function should be called on the thread that created the device.

Since: This function is available since SDL_ttf 3.0.0.

See also: TextEngine.CreateGPU; TTF_DestroyGPUTextEngine; TextRef.GetGPUDrawData

◆ CreateRenderer()

static TextEngine SDL::TextEngine::CreateRenderer ( RendererRef renderer )

inlinestatic

Parameters

renderer the renderer to use for creating textures and drawing text.

Returns: a TextEngineRef object or nullptr on failure; call GetError() for more information.

Thread safety:: This function should be called on the thread that created the renderer.

Since: This function is available since SDL_ttf 3.0.0.

See also: TTF_DestroyRendererTextEngine; TextRef.DrawRenderer; TextEngine.CreateRendererWithProperties

◆ CreateRendererWithProperties()

static TextEngine SDL::TextEngine::CreateRendererWithProperties ( PropertiesRef props )

inlinestatic

These are the supported properties:

prop::RendererTextEngine.RENDERER_POINTER: the renderer to use for creating textures and drawing text
prop::RendererTextEngine.ATLAS_TEXTURE_SIZE_NUMBER: the size of the texture atlas

Parameters

props the properties to use.

Returns: a TextEngineRef object or nullptr on failure; call GetError() for more information.

Thread safety:: This function should be called on the thread that created the renderer.

Since: This function is available since SDL_ttf 3.0.0.

See also: TextEngine.CreateRenderer; TTF_DestroyRendererTextEngine; TextRef.DrawRenderer

◆ CreateSurface()

static TextEngine SDL::TextEngine::CreateSurface ( )

inlinestatic

Returns: a TextEngineRef 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: TTF_DestroySurfaceTextEngine; TextRef.DrawSurface

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

SDL3pp/SDL3pp_ttf.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateGPU()

◆ CreateGPUWithProperties()

◆ CreateRenderer()

◆ CreateRendererWithProperties()

◆ CreateSurface()