SDL Wiki

SDL_CreateSurface

Allocate a new surface with a specific pixel format.

Header File

Defined in <SDL3/SDL_surface.h>

Syntax

SDL_Surface * SDL_CreateSurface(int width, int height, SDL_PixelFormat format);

Function Parameters

int width the width of the surface.
int height the height of the surface.
SDL_PixelFormat format the SDL_PixelFormat for the new surface's pixel format.

Return Value

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

Remarks

The pixels of the new surface are initialized to zero.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.2.0.

See Also


CategoryAPI, CategoryAPIFunction, CategorySurface


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.