(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_CleanupPropertyCallback

A callback used to free resources when a property is deleted.

Header File

Defined in <SDL3/SDL_properties.h>

Syntax

typedef void (SDLCALL *SDL_CleanupPropertyCallback)(void *userdata, void *value);

Function Parameters

userdata	an app-defined pointer passed to the callback.
value	the pointer assigned to the property to clean up.

Remarks

This should release any resources associated with value that are no longer needed.

This callback is set per-property. Different properties in the same group can have different cleanup callbacks.

This callback will be called during SDL_SetPointerPropertyWithCleanup if the function fails for any reason.

Thread Safety

This callback may fire without any locks held; if this is a concern, the app should provide its own locking.

Version

This datatype is available since SDL 3.1.3.

See Also

• SDL_SetPointerPropertyWithCleanup

---

CategoryAPI, CategoryAPIDatatype, CategoryProperties

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.