SDL_SetPointerPropertyWithCleanup

Set a pointer property in a group of properties with a cleanup function that is called when the property is deleted.

The cleanup function is also called if setting the property fails for any reason.

For simply setting basic data types, like numbers, bools, or strings, use SDL_SetNumberProperty, SDL_SetBooleanProperty, or SDL_SetStringProperty instead, as those functions will handle cleanup on your behalf. This function is only for more complex, custom data.

extern (C) nothrow @nogc extern
bool
SDL_SetPointerPropertyWithCleanup

Parameters

props SDL_PropertiesID

the properties to modify.

name const(char)*

the name of the property to modify.

value void*

the new value of the property, or NULL to delete the property.

cleanup SDL_CleanupPropertyCallback

the function to call when this property is deleted, or NULL if no cleanup is necessary.

userdata void*

a pointer that is passed to the cleanup function.

Return Value

Type: bool

true on success or false on failure; call SDL_GetError for more information.

Threadsafety: It is safe to call this function from any thread.

See Also

Meta