An ID that represents a properties set. More...

Inheritance diagram for SDL::Properties:

Public Member Functions
constexpr	Properties (PropertiesID resource) noexcept
	Constructs from raw Properties.
constexpr	Properties (Properties &&other) noexcept
	Move constructor.
	Properties ()
	Create a group of properties.
	Properties (std::initializer_list< std::pair< StringParam, std::variant< StringParam, void *, Sint64, float, bool > > > entries)
	Create a group of properties.
	~Properties ()
	Destructor.
constexpr Properties &	operator= (Properties &&other) noexcept
	Assignment operator.
Public Member Functions inherited from SDL::PropertiesBase
void	Destroy ()
	Destroy a group of properties.
PropertyProxy	operator[] (StringParam name) const
	Access a property from a group of properties.
PropertyIterator	begin () const
	Gets an iterator to the first property in a group of properties.
std::nullptr_t	end () const
	Gets sentinel iterator for a group of properties.
PropertyMutableProxy	operator[] (StringParam name)
	Access a property from a group of properties.
void	Copy (PropertiesRef dst)
	Copy a group of properties.
PropertiesLock	Lock ()
	Lock a group of properties.
void	Unlock (PropertiesLock &&lock)
	Unlock a group of properties.
template<PropertyValue V>
void	Set (StringParam name, V &&value)
	Set a property in a group of properties.
void	SetPointerPropertyWithCleanup (StringParam name, void value, CleanupPropertyCallback cleanup, void userdata)
	Set a pointer property in a group of properties with a cleanup function that is called when the property is deleted.
void	SetPointerPropertyWithCleanup (StringParam name, void *value, CleanupPropertyCB cleanup)
	Set a pointer property in a group of properties with a cleanup function that is called when the property is deleted.
void	SetPointerProperty (StringParam name, void *value)
	Set a pointer property in a group of properties.
void	SetStringProperty (StringParam name, StringParam value)
	Set a string property in a group of properties.
void	SetNumberProperty (StringParam name, Sint64 value)
	Set an integer property in a group of properties.
void	SetFloatProperty (StringParam name, float value)
	Set a floating point property in a group of properties.
void	SetBooleanProperty (StringParam name, bool value)
	Set a boolean property in a group of properties.
bool	HasProperty (StringParam name) const
	Return whether a property exists in a group of properties.
PropertyType	GetPropertyType (StringParam name) const
	Get the type of a property in a group of properties.
PropertyProxy	Get (StringParam name) const
	Get a property from a group of properties.
void *	GetPointerProperty (StringParam name, void *default_value=nullptr) const
	Get a pointer property from a group of properties.
const char *	GetStringProperty (StringParam name, StringParam default_value="") const
	Get a string property from a group of properties.
Sint64	GetNumberProperty (StringParam name, Sint64 default_value=0) const
	Get a number property from a group of properties.
float	GetFloatProperty (StringParam name, float default_value=0) const
	Get a floating point property from a group of properties.
bool	GetBooleanProperty (StringParam name, bool default_value=false) const
	Get a boolean property from a group of properties.
void	ClearProperty (StringParam name)
	Clear a property from a group of properties.
void	Enumerate (EnumeratePropertiesCallback callback, void *userdata) const
	Enumerate the properties contained in a group of properties.
void	Enumerate (EnumeratePropertiesCB callback) const
	Enumerate the properties contained in a group of properties.
Uint64	GetCount () const
	Returns the number of properties this has.
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< PropertiesID >
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< PropertiesID >
using	RawPointer
	The underlying raw pointer type.
using	RawConstPointer
	The underlying const raw pointer type.
Protected Member Functions inherited from SDL::ResourceBaseT< PropertiesID >
constexpr	~ResourceBaseT ()=default
	Destructor.
constexpr ResourceBaseT &	operator= (const ResourceBaseT &)=default
	Assignment operator.

Detailed Description

An ID that represents a properties set.

Since: This datatype is available since SDL 3.2.0.

Category:: Resource

See also: Properties.Create; prop

Constructor & Destructor Documentation

◆ Properties() [1/2]

SDL::Properties::Properties ( PropertiesID resource )

inlineexplicitconstexprnoexcept

Constructs from raw Properties.

Parameters

resource a PropertiesID to be wrapped.

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

◆ Properties() [2/2]

SDL::Properties::Properties ( std::initializer_list< std::pair< StringParam, std::variant< StringParam, void *, Sint64, float, bool > > > entries )

inline

Create a group of properties.

All properties are automatically destroyed when Quit() is called.

Parameters

entries the properties to set on this group of properties, as a list of name-value pairs.

Postcondition: an ID for a new group of properties on success.

Exceptions

Error on failure.

Thread safety:: It is safe to call this function from any thread.

Since: This function is available since SDL 3.2.0.

See also: DestroyProperties

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

SDL3pp/SDL3pp_properties.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Properties() [1/2]

◆ Properties() [2/2]