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

SDL_GetPixelFormatDetails

Create an SDL_PixelFormatDetails structure corresponding to a pixel format.

Header File

Defined in <SDL3/SDL_pixels.h>

Syntax

const SDL_PixelFormatDetails * SDL_GetPixelFormatDetails(SDL_PixelFormat format);

Function Parameters

SDL_PixelFormat

format

one of the SDL_PixelFormat values.

Return Value

(const SDL_PixelFormatDetails *) Returns a pointer to a SDL_PixelFormatDetails structure or NULL on failure; call SDL_GetError() for more information.

Remarks

Returned structure may come from a shared global cache (i.e. not newly allocated), and hence should not be modified, especially the palette. Weird errors such as Blit combination not supported may occur.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.1.3.

---

CategoryAPI, CategoryAPIFunction, CategoryPixels

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