SDL_CleanupPropertyCallback(3type)

SDL_CleanupPropertyCallback3type

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

Usage

#include "SDL3/SDL.h"

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

Header file

Defined in SDL3/SDL_properties.h

Overview

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

userdata

an app-defined pointer passed to the callback.

value

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.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.