(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_SetPaletteColors

Set a range of colors in a palette.

Header File

Defined in <SDL3/SDL_pixels.h>

Syntax

bool SDL_SetPaletteColors(SDL_Palette *palette, const SDL_Color *colors, int firstcolor, int ncolors);

Function Parameters

SDL_Palette *	palette	the SDL_Palette structure to modify.
const SDL_Color *	colors	an array of SDL_Color structures to copy into the palette.
int	firstcolor	the index of the first palette entry to modify.
int	ncolors	the number of entries to modify.

Return Value

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

Thread Safety

It is safe to call this function from any thread, as long as the palette is not modified or destroyed in another thread.

Version

This function is available since SDL 3.1.3.

---

CategoryAPI, CategoryAPIFunction, CategoryPixels

[ 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.