(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_GetWindowPixelFormat

Get the pixel format associated with the window.

Header File

Defined in <SDL3/SDL_video.h>

Syntax

SDL_PixelFormat SDL_GetWindowPixelFormat(SDL_Window *window);

Function Parameters

SDL_Window *

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.

Version

This function is available since SDL 3.1.3.

---

CategoryAPI, CategoryAPIFunction, CategoryVideo

[ 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.