Scroll to navigation

SDL_CleanupPropertyCallback(3type) SDL3 DATATYPES SDL_CleanupPropertyCallback(3type)

NAME

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

HEADER FILE

Defined in SDL3/SDL_properties.h

SYNOPSIS

#include "SDL3/SDL.h"
typedef void (SDLCALL *SDL_CleanupPropertyCallback)(void *userdata, void *value);

DESCRIPTION

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.

FUNCTION PARAMETERS

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

THREAD SAFETY

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

AVAILABILITY

This datatype is available since SDL 3.1.3.

SEE ALSO

(3), SDL_SetPointerPropertyWithCleanup(3)

SDL 3.1.6 Simple Directmedia Layer