SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_EnumerateProperties

Enumerate the properties contained in a group of properties.

Header File

Defined in <SDL3/SDL_properties.h>

Syntax

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

Function Parameters

SDL_PropertiesID props the properties to query.
SDL_EnumeratePropertiesCallback callback the function to call for each property.
void * userdata a pointer that is passed to callback.

Return Value

(int) Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Remarks

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

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.0.0.


CategoryAPI, CategoryAPIFunction, CategoryProperties


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.