SDL_GetPixelFormatDetails - Man Page
Create an SDL_PixelFormatDetails structure corresponding to a pixel format.
Synopsis
#include <SDL3/SDL_pixels.h> const SDL_PixelFormatDetails * SDL_GetPixelFormatDetails(SDL_PixelFormat format);
Description
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.
Function Parameters
- format
one of the SDL_PixelFormat values.
Return Value
Returns a pointer to a SDL_PixelFormatDetails structure or NULL on failure; call SDL_GetError() for more information.
Thread Safety
It is safe to call this function from any thread.
Availability
This function is available since SDL 3.2.0.
Referenced By
SDL_GetRGB(3), SDL_GetRGBA(3), SDL_MapRGB(3), SDL_MapRGBA(3).
SDL 3.2.16 Simple Directmedia Layer SDL3 FUNCTIONS