SDL_SetSurfacePalette

Set the palette used by a surface.

Header File

Defined in <SDL3/SDL_surface.h>

Syntax

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

Function Parameters

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

Return Value

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

Remarks

A single palette can be shared with many surfaces.

Thread Safety

This function is not thread safe.

Version

This function is available since SDL 3.2.0.

See Also

• SDL_CreatePalette
• SDL_GetSurfacePalette

---

CategoryAPI, CategoryAPIFunction, CategorySurface

[ front page | index | search | recent changes | git repo | offline html ]

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