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

SDL_SetSurfacePalette

Set the palette used by a surface.

Header File

Defined in <SDL3/SDL_surface.h>

Syntax

int SDL_SetSurfacePalette(SDL_Surface *surface, SDL_Palette *palette);

Function Parameters

surface the SDL_Surface structure to update
palette the SDL_Palette structure to use

Return Value

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

Remarks

A single palette can be shared with many surfaces.

Version

This function is available since SDL 3.0.0.

CategoryAPI, CategoryAPIFunction, CategorySurface