Function SDL_PIXELLAYOUT

pub const fn SDL_PIXELLAYOUT(format: SDL_PixelFormat) -> SDL_PackedLayout

Available on crate feature dep_sdl3 only.

A macro to retrieve the layout of an SDL_PixelFormat.

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

Parameters

• format: an SDL_PixelFormat to check.

Return value

Returns the layout of format.

Thread safety

It is safe to call this macro from any thread.

Availability

This macro is available since SDL 3.2.0.