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

SDL_CreateRGBSurfaceWithFormat

Allocate a new RGB surface with a specific pixel format.

Header File

Syntax

SDL_Surface* SDL_CreateRGBSurfaceWithFormat
    (Uint32 flags, int width, int height, int depth, Uint32 format);

Function Parameters

Uint32	flags	the flags are unused and should be set to 0.
int	width	the width of the surface.
int	height	the height of the surface.
int	depth	the depth of the surface in bits.
Uint32	format	the SDL_PixelFormatEnum for the new surface's pixel format.

Return Value

(SDL_Surface *) Returns the new SDL_Surface structure that is created or NULL if it fails; call SDL_GetError() for more information.

Remarks

This function operates mostly like SDL_CreateRGBSurface(), except instead of providing pixel color masks, you provide it with a predefined format from SDL_PixelFormatEnum.

Version

This function is available since SDL 2.0.5.