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

SDL_SetPixelFormatPalette

Set the palette for a pixel format structure.

Header File

Defined in SDL_pixels.h

Syntax

int SDL_SetPixelFormatPalette(SDL_PixelFormat * format,
                              SDL_Palette *palette);

Function Parameters

format the SDL_PixelFormat structure that will use the palette
palette the SDL_Palette structure that will be used

Return Value

Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Version

This function is available since SDL 2.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryPixels