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

SDL_GetBooleanProperty

Get a boolean property from a group of properties.

Header File

Defined in <SDL3/SDL_properties.h>

Syntax

SDL_bool SDL_GetBooleanProperty(SDL_PropertiesID props, const char *name, SDL_bool default_value);

Function Parameters

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

Return Value

(SDL_bool) Returns the value of the property, or default_value if it is not set or not a float property.

Remarks

You can use SDL_GetPropertyType() to query whether the property exists and is a boolean property.

Thread Safety

It is safe to call this function from any thread.

Version

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.