logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

SDL_SetPointerPropertyWithCleanup - Set a pointer property in a group of properties with a cleanup

Availability

       This function is available since SDL 3.2.0.

Description

       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.

Function Parameters

props  the properties to modify.

       name   the name of the property to modify.

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

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

       userdata
              a pointer that is passed to the cleanup function.

Header File

       Defined in SDL3/SDL_properties.h

Name

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

Return Value

       Returns true on success or false on failure; call

       SDL_GetError () for more information.

See Also

(3),          SDL_GetPointerProperty(3),          (3),         SDL_SetPointerProperty(3),         (3),
       SDL_CleanupPropertyCallback(3type)

Simple Directmedia Layer                           SDL 3.2.10               SDL_SetPointerPropertyWithCleanup(3)

Synopsis

#include"SDL3/SDL.h"boolSDL_SetPointerPropertyWithCleanup(SDL_PropertiesIDprops,constchar*name,void*value,SDL_CleanupPropertyCallbackcleanup,void*userdata);

Thread Safety

       It is safe to call this function from any thread.

See Also