(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_SetPixelFormatPalette

Set the palette for a pixel format structure.

Header File

Defined in <SDL3/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 3.0.0.

CategoryAPI, CategoryAPIFunction, CategoryPixels