Semi-safe reference for Properties.
Inheritance diagram for SDL::PropertiesRef:
Collaboration diagram for SDL::PropertiesRef:
Public Member Functions | |
| PropertiesRef (PropertiesParam resource) | |
| Constructs from PropertiesParam. More... | |
| PropertiesRef (const PropertiesRef &other) | |
| Copy constructor. | |
| ~PropertiesRef () | |
| Destructor. | |
 Public Member Functions inherited from SDL::Properties | |
| constexpr | Properties ()=default |
| Default ctor. | |
| constexpr | Properties (const PropertiesID resource) |
| Constructs from PropertiesParam. More... | |
| constexpr | Properties (const Properties &other)=delete |
| Copy constructor. | |
| constexpr | Properties (Properties &&other) |
| Move constructor. | |
| constexpr | Properties (const PropertiesRef &other)=delete |
| constexpr | Properties (PropertiesRef &&other)=delete |
| ~Properties () | |
| Destructor. | |
| Properties & | operator= (Properties other) |
| Assignment operator. | |
| constexpr PropertiesID | get () const |
| Retrieves underlying PropertiesID. | |
| constexpr PropertiesID | release () |
| Retrieves underlying PropertiesID and clear this. | |
| constexpr auto | operator<=> (const Properties &other) const =default |
| Comparison. | |
| constexpr bool | operator== (std::nullptr_t _) const |
| Comparison. | |
| constexpr | operator bool () const |
| Converts to bool. | |
| constexpr | operator PropertiesParam () const |
| Converts to PropertiesParam. | |
| void | Destroy () |
| Destroy a group of properties. More... | |
| void | Copy (PropertiesParam dst) |
| Copy a group of properties. More... | |
| void | Lock () |
| Lock a group of properties. More... | |
| void | Unlock () |
| Unlock a group of properties. More... | |
| 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. More... | |
| 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. More... | |
| void | SetPointerProperty (StringParam name, void *value) |
| Set a pointer property in a group of properties. More... | |
| void | SetStringProperty (StringParam name, StringParam value) |
| Set a string property in a group of properties. More... | |
| void | SetNumberProperty (StringParam name, Sint64 value) |
| Set an integer property in a group of properties. More... | |
| void | SetFloatProperty (StringParam name, float value) |
| Set a floating point property in a group of properties. More... | |
| void | SetBooleanProperty (StringParam name, bool value) |
| Set a boolean property in a group of properties. More... | |
| bool | HasProperty (StringParam name) |
| Return whether a property exists in a group of properties. More... | |
| PropertyType | GetPropertyType (StringParam name) |
| Get the type of a property in a group of properties. More... | |
| void * | GetPointerProperty (StringParam name, void *default_value) |
| Get a pointer property from a group of properties. More... | |
| const char * | GetStringProperty (StringParam name, StringParam default_value) |
| Get a string property from a group of properties. More... | |
| Sint64 | GetNumberProperty (StringParam name, Sint64 default_value) |
| Get a number property from a group of properties. More... | |
| float | GetFloatProperty (StringParam name, float default_value) |
| Get a floating point property from a group of properties. More... | |
| bool | GetBooleanProperty (StringParam name, bool default_value) |
| Get a boolean property from a group of properties. More... | |
| void | ClearProperty (StringParam name) |
| Clear a property from a group of properties. More... | |
| void | Enumerate (EnumeratePropertiesCallback callback, void *userdata) |
| Enumerate the properties contained in a group of properties. More... | |
| void | Enumerate (EnumeratePropertiesCB callback) |
| Enumerate the properties contained in a group of properties. More... | |
| Uint64 | GetCount () |
| Returns the number of properties this has. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from SDL::Properties | |
| static Properties | Create () |
| Create a group of properties. More... | |
Constructor & Destructor Documentation
◆ PropertiesRef()
|
inline |
- Parameters
-
resource a PropertiesID or Properties.
This does not takes ownership!
The documentation for this struct was generated from the following file:
- SDL3pp/SDL3pp_properties.h
