SDL_SetSurfacePalette - Man Page

Set the palette used by a surface.

Synopsis

#include <SDL3/SDL_surface.h>

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

Description

Setting the palette keeps an internal reference to the palette, which can be safely destroyed afterwards.

A single palette can be shared with many surfaces.

Function Parameters

surface

the SDL_Surface structure to update.

palette

the SDL_Palette structure to use.

Return Value

Returns true on success or false on failure; call SDL_GetError() for more information.

Thread Safety

This function can be called on different threads with different surfaces.

Availability

This function is available since SDL 3.2.0.

See Also

SDL_CreatePalette(3), SDL_GetSurfacePalette(3)

Referenced By

SDL_CreatePalette(3), SDL_GetSurfacePalette(3).

SDL 3.3.2 Simple Directmedia Layer SDL3 FUNCTIONS