gitea/SDL3_fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Sync SDL3 wiki -> header

Browse Source
This commit is contained in:
SDL Wiki Bot
2024-05-26 16:19:32 +00:00
parent 2626304e70
commit a6da2e6f8b
1 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
include/SDL3/SDL_properties.h
View File

@@ -148,11 +148,11 @@ extern SDL_DECLSPEC void SDLCALL SDL_UnlockProperties(SDL_PropertiesID props);
/** /**
* A callback used to free resources when a property is deleted. * A callback used to free resources when a property is deleted.
* *
* This should release any resources associated with `value` that are * This should release any resources associated with `value` that are no
* no longer needed. * longer needed.
* *
* This callback is set per-property. Different properties in the same * This callback is set per-property. Different properties in the same set can
* set can have different cleanup callbacks. * have different cleanup callbacks.
* *
* This callback will be called _during_ SDL_SetPropertyWithCleanup if the * This callback will be called _during_ SDL_SetPropertyWithCleanup if the
* function fails for any reason. * function fails for any reason.
@@ -160,8 +160,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_UnlockProperties(SDL_PropertiesID props);
* \param userdata an app-defined pointer passed to the callback. * \param userdata an app-defined pointer passed to the callback.
* \param value the pointer assigned to the property to clean up. * \param value the pointer assigned to the property to clean up.
* *
* \threadsafety This callback may fire without any locks held; if this is * \threadsafety This callback may fire without any locks held; if this is a
* a concern, the app should provide its own locking. * concern, the app should provide its own locking.
* *
* \since This datatype is available since SDL 3.0.0. * \since This datatype is available since SDL 3.0.0.
* *
@@ -176,8 +176,8 @@ typedef void (SDLCALL *SDL_CleanupPropertyCallback)(void *userdata, void *value)
* The cleanup function is also called if setting the property fails for any * The cleanup function is also called if setting the property fails for any
* reason. * reason.
* *
* For simply setting basic data types, like numbers, bools, or strings, * For simply setting basic data types, like numbers, bools, or strings, use
* use SDL_SetNumberProperty, SDL_SetBooleanProperty, or SDL_SetStringProperty * SDL_SetNumberProperty, SDL_SetBooleanProperty, or SDL_SetStringProperty
* instead, as those functions will handle cleanup on your behalf. This * instead, as those functions will handle cleanup on your behalf. This
* function is only for more complex, custom data. * function is only for more complex, custom data.
* *
@@ -466,7 +466,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_ClearProperty(SDL_PropertiesID props, const
* \param props the SDL_PropertiesID that is being enumerated. * \param props the SDL_PropertiesID that is being enumerated.
* \param name the next property name in the enumeration. * \param name the next property name in the enumeration.
* *
* \threadsafety SDL_EnumerateProperties holds a lock on `props` during this callback. * \threadsafety SDL_EnumerateProperties holds a lock on `props` during this
* callback.
* *
* \since This datatype is available since SDL 3.0.0. * \since This datatype is available since SDL 3.0.0.
* *