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

SDL_PIXELLAYOUT

A macro to retrieve the layout of an SDL_PixelFormat.

Header File

Defined in <SDL3/SDL_pixels.h>

Syntax

#define SDL_PIXELLAYOUT(format)  (((format) >> 16) & 0x0F)

Macro Parameters

format an SDL_PixelFormat to check.

Return Value

Returns the layout of format.

Remarks

This is usually a value from the SDL_PackedLayout enumeration, or zero if a layout doesn't make sense for the format type.

Thread Safety

It is safe to call this macro from any thread.

Version

This macro is available since SDL 3.1.3.


CategoryAPI, CategoryAPIMacro, CategoryPixels


[ edit | delete | history | feedback | raw ]

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