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

SDL_AllocPalette

Create a palette structure with the specified number of color entries.

Header File

Syntax

SDL_Palette* SDL_AllocPalette(int ncolors);

Function Parameters

int

ncolors

represents the number of color entries in the color palette.

Return Value

(SDL_Palette *) Returns a new SDL_Palette structure on success or NULL on failure (e.g. if there wasn't enough memory); call SDL_GetError() for more information.

Remarks

The palette entries are initialized to white.

Version

This function is available since SDL 2.0.0.