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

SDL_GetSurfaceProperties

Get the properties associated with a surface.

Header File

Defined in <SDL3/SDL_surface.h>

Syntax

SDL_PropertiesID SDL_GetSurfaceProperties(SDL_Surface *surface);

Function Parameters

surface the SDL_Surface structure to query

Return Value

Returns a valid property ID on success or 0 on failure; call SDL_GetError() for more information.

Remarks

The following properties are understood by SDL:

Version

This function is available since SDL 3.0.0.

See Also


CategoryAPI, CategoryAPIFunction, CategorySurface