(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_AllocFormat

Create an SDL_PixelFormat structure corresponding to a pixel format.

Header File

Syntax

SDL_PixelFormat * SDL_AllocFormat(Uint32 pixel_format);

Function Parameters

Uint32

pixel_format

one of the SDL_PixelFormatEnum values.

Return Value

(SDL_PixelFormat *) Returns the new SDL_PixelFormat structure or NULL on failure; call SDL_GetError() for more information.

Remarks

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.

Version

This function is available since SDL 2.0.0.