(This is the legacy documentation for stable SDL2, the current stable version; SDL3 is the current development version.)

SDL_GetWindowPixelFormat

Get the pixel format associated with the window.

Header File

Defined in SDL_video.h

Syntax

Uint32 SDL_GetWindowPixelFormat(SDL_Window * window);

Function Parameters

Return Value

Returns the pixel format of the window on success or SDL_PIXELFORMAT_UNKNOWN on failure; call SDL_GetError() for more information.

Version

This function is available since SDL 2.0.0.

CategoryAPI, CategoryAPIFunction, CategoryVideo