|
Size: 1281
Comment: add code example
|
Size: 1343
Comment: Added Version section.
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 36: | Line 36: |
| == Version == This function is available since SDL 2.0.0. |
SDL_GetPixelFormatName
Use this function to get the human readable name of a pixel format.
Contents
Syntax
const char* SDL_GetPixelFormatName(Uint32 format)
Function Parameters
format |
the pixel format to query |
Return Value
Returns the human readable name of the specified pixel format or "SDL_PIXELFORMAT_UNKNOWN" if the format isn't recognized.
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);
printf("The surface's pixelformat is %s\n", surfacePixelFormatName);
// prints something like "The surface's pixelformat is SDL_PIXELFORMAT_ABGR8888"
Remarks
You can add useful comments here
Version
This function is available since SDL 2.0.0.
