---
name: "SDL_GetBooleanProperty"
section: "3"
platform: "linux"
package: "libsdl3-doc"
version: "3.2.10+ds-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/SDL_GetBooleanProperty"
---

# SDL\_GetBooleanProperty(3)

Get a boolean property from a group of properties.

## NAME

SDL\_GetBooleanProperty - Get a boolean property from a group of properties.

## HEADER FILE

Defined in SDL3/SDL\_properties.h

## SYNOPSIS

```
#include "SDL3/SDL.h"
```

**bool SDL\_GetBooleanProperty(SDL\_PropertiesID props, const char \*name, bool default\_value);**

## DESCRIPTION

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.

## SEE ALSO

**•**(3), [**SDL\_GetPropertyType**(3)](/SDL_GetPropertyType/3.md), **•**(3), [**SDL\_HasProperty**(3)](/SDL_HasProperty/3.md), **•**(3), [**SDL\_SetBooleanProperty**(3)](/SDL_SetBooleanProperty/3.md)