Skip to main content

SDL_GetBooleanProperty

sdl3_sys::properties

Function SDL_GetBooleanProperty 

Source 
pub unsafe extern "C" fn SDL_GetBooleanProperty(
    props: SDL_PropertiesID,
    name: *const c_char,
    default_value: bool,
) -> bool
Expand description

Get a boolean property from a group of properties.

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

§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