devela::_dep::sdl3::sys::pixels

Function SDL_GetPixelFormatDetails

pub unsafe extern "C" fn SDL_GetPixelFormatDetails(
    format: SDL_PixelFormat,
) -> *const SDL_PixelFormatDetails
Available on crate feature dep_sdl3 only.
Expand description

Create an SDL_PixelFormatDetails structure corresponding to a pixel format.

Returned structure may come from a shared global cache (i.e. not newly allocated), and hence should not be modified, especially the palette. Weird errors such as Blit combination not supported may occur.

§Parameters

§Return value

Returns a pointer to a SDL_PixelFormatDetails structure or NULL on failure; call SDL_GetError() for more information.

§Thread safety

It is safe to call this function from any thread.

§Availability

This function is available since SDL 3.2.0.