SDL_EnumerateProperties - Man Page

Enumerate the properties contained in a group of properties.

Header File

Defined in SDL3/SDL_properties.h

Synopsis

#include "SDL3/SDL.h"

bool SDL_EnumerateProperties(SDL_PropertiesID props, SDL_EnumeratePropertiesCallback callback, void *userdata);

Description

The callback function is called for each property in the group of properties. The properties are locked during enumeration.

Function Parameters

props

the properties to query.

callback

the function to call for each property.

userdata

a pointer that is passed to callback .

Return Value

Returns true on success or false on failure; call

SDL_GetError () for more information.

Thread Safety

It is safe to call this function from any thread.

Availability

This function is available since SDL 3.2.0.

Referenced By

SDL_EnumeratePropertiesCallback.3type(3).

SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS