Function SDL_PIXELORDER

pub const fn SDL_PIXELORDER(format: SDL_PixelFormat) -> i32

Available on crate feature dep_sdl3 only.

A macro to retrieve the order of an SDL_PixelFormat.

This is usually a value from the SDL_BitmapOrder, SDL_PackedOrder, or SDL_ArrayOrder enumerations, depending on the format type.

Parameters

• format: an SDL_PixelFormat to check.

Return value

Returns the order of format.

Thread safety

It is safe to call this macro from any thread.

Availability

This macro is available since SDL 3.2.0.