SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)


Get a property on a set of properties.

Header File

Defined in <SDL3/SDL_properties.h>


void* SDL_GetProperty(SDL_PropertiesID props, const char *name, void *default_value);

Function Parameters

SDL_PropertiesID props the properties to query.
const char * name the name of the property to query.
void * default_value the default value of the property.

Return Value

(void *) Returns the value of the property, or default_value if it is not set or not a pointer property.


By convention, the names of properties that SDL exposes on objects will start with "SDL.", and properties that SDL uses internally will start with "SDL.internal.". These should be considered read-only and should not be modified by applications.

Thread Safety

It is safe to call this function from any thread, although the data returned is not protected and could potentially be freed if you call SDL_SetProperty() or SDL_ClearProperty() on these properties from another thread. If you need to avoid this, use SDL_LockProperties() and SDL_UnlockProperties().


This function is available since SDL 3.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryProperties

[ edit | delete | history | feedback | raw ]

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