SDL::IConv Struct Reference

Handle to an owned iConv. More...

Inheritance diagram for SDL::IConv:

Public Member Functions
void	close ()
	This function frees a context used for character set conversion.
IConvShared	share ()
	Move this iConv into a IConvShared.
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< IConvRef >
constexpr	ResourceUnique (std::nullptr_t=nullptr)
	Default constructor.
constexpr	ResourceUnique (base::value_type value, DefaultDeleter< IConvRef > 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 IConv	open (StringParam tocode, StringParam fromcode)
	This function allocates a context for the specified character set conversion.

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

IConvRef

Member Function Documentation

close()

void SDL::IConv::close ( )

inline

Returns

0 on success.

Exceptions

Error

on failure.

Since

This function is available since SDL 3.2.0.

See also

IConvRef.iconv

IConv.open

iconv_string

open()

static IConv SDL::IConv::open ( StringParam  tocode, StringParam  fromcode  )

inlinestatic

Parameters

tocode	The target character encoding, must not be nullptr.
fromcode	The source character encoding, must not be nullptr.

Returns

this becomes a valid handle convertible to true on success, or convertible to false on failure.

Since

This function is available since SDL 3.2.0.

See also

IConvRef.iconv

IConv.close

iconv_string

---

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

• SDL3pp/SDL3pp_stdinc.h