devela::_dep::sdl3::sys::properties

Function SDL_GetPointerProperty

pub unsafe extern "C" fn SDL_GetPointerProperty(
    props: u32,
    name: *const i8,
    default_value: *mut c_void,
) -> *mut c_void
Available on crate feature dep_sdl3 only.
Expand description

Get a pointer property from a group of properties.

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.

§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 pointer property.

§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_SetPointerProperty() or SDL_ClearProperty() on these properties from another thread. If you need to avoid this, use SDL_LockProperties() and SDL_UnlockProperties().

§Availability

This function is available since SDL 3.2.0.

§See also