SDL_CreatePalette

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

Header File

Defined in <SDL3/SDL_pixels.h>

Syntax

SDL_Palette * SDL_CreatePalette(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

If ncolors is larger than the palette's size - firstcolor, it is truncated to the amount that will fit.

The palette entries are initialized to white.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.2.0.

See Also

• SDL_DestroyPalette
• SDL_SetPaletteColors
• SDL_SetSurfacePalette

---

CategoryAPI, CategoryAPIFunction, CategoryPixels

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