SDL_GetWindowPixelFormat(3)

SDL_GetWindowPixelFormat3

Get the pixel format associated with the window.

Usage

#include "SDL3/SDL.h"

SDL_PixelFormat SDL_GetWindowPixelFormat(SDL_Window *window);

Header file

Defined in SDL3/SDL_video.h

Function parameters

window

the window to query.

Return value

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

Thread safety

This function should only be called on the main thread.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.