SDL_GetBooleanProperty(3)

SDL_GetBooleanProperty3

Get a boolean property from a group of properties.

Usage

#include "SDL3/SDL.h"

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

Header file

Defined in SDL3/SDL_properties.h

Overview

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

Function parameters

props

the properties to query.

name

the name of the property to query.

default_value

the default value of the property.

Return value

Returns the value of the property, or default_value if it is not set or not a boolean property.

Thread safety

It is safe to call this function from any thread.

Availability

This function 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.