(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_GetPixelFormatName

Get the human readable name of a pixel format.

Header File

Defined in <SDL3/SDL_pixels.h>

Syntax

const char* SDL_GetPixelFormatName(SDL_PixelFormatEnum format);

Function Parameters

Return Value

Returns the human readable name of the specified pixel format or SDL_PIXELFORMAT_UNKNOWN if the format isn't recognized.

Version

This function is available since SDL 3.0.0.

Code Examples

SDL_Surface* surface; // a valid surface from wherever.
SDL_PixelFormat* pixelFormat = surface->format;
Uint32 pixelFormatEnum = pixelFormat->format;
const char* surfacePixelFormatName = SDL_GetPixelFormatName(pixelFormatEnum);
SDL_Log("The surface's pixelformat is %s", surfacePixelFormatName);
// prints something like "The surface's pixelformat is SDL_PIXELFORMAT_ABGR8888"

CategoryAPI, CategoryAPIFunction, CategoryPixels