(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous 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_PixelFormat format);

Function Parameters

SDL_PixelFormat

format

the pixel format to query.

Return Value

(const char *) Returns the human readable name of the specified pixel format or "SDL_PIXELFORMAT_UNKNOWN" if the format isn't recognized.

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.