(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_SetSurfacePalette

Set the palette used by a surface.

Header File

Defined in SDL_surface.h

Syntax

int 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

(int) 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 2.0.0.

---

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.