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

SDL_FreePalette

Free a palette created with SDL_AllocPalette().

Header File

Defined in SDL_pixels.h

Syntax

void SDL_FreePalette(SDL_Palette * palette);

Function Parameters

Version

This function is available since SDL 2.0.0.

See Also

• SDL_AllocPalette

Example

SDL_Palette* palette = NULL;

/* ... */

SDL_Init(SDL_INIT_VIDEO);

// Create window and renderer

SDL_Window *window;
SDL_Renderer *renderer;
SDL_CreateWindowAndRenderer(640, 480, 0, &window, &renderer);

// Create new palette with 4 colors

palette = SDL_AllocPalette(4);

if (palette == NULL) printf( "Error: %s\n", SDL_GetError() );

/* ... */

// Set green and blue of the first color in the palette to 0

palette->colors[0].g = 0;
palette->colors[0].b = 0;

// Set render draw color to red

SDL_SetRenderDrawColor(renderer, palette->colors[0].r, palette->colors[0].g, palette->colors[0].b, palette->colors[0].a);

/* ... */

SDL_FreePalette(palette);
palette = NULL;

CategoryAPI, CategoryAPIFunction, CategoryPixels