NAME

       SDL_CreateSurfacePalette - Create a palette and associate it with a surface.

SYNOPSIS

       #include <SDL3/SDL_surface.h>

       SDL_Palette * SDL_CreateSurfacePalette(SDL_Surface *surface);

DESCRIPTION

       This  function  creates  a palette compatible with the provided surface. The palette is then returned for
       you to modify, and the surface will automatically use the new palette in future operations.  You  do  not
       need  to  destroy the returned palette, it will be freed when the reference count reaches 0, usually when
       the surface is destroyed.

       Bitmap surfaces (with  format  SDL_PIXELFORMAT_INDEX1LSB  or  SDL_PIXELFORMAT_INDEX1MSB)  will  have  the
       palette  initialized  with  0 as white and 1 as black. Other surfaces will get a palette initialized with
       white in every entry.

       If this function is called for a surface that already has a palette, a new palette  will  be  created  to
       replace it.

FUNCTION PARAMETERS

       surface
              the SDL_Surface structure to update.

RETURN VALUE

       Returns  a  new  SDL_Palette  structure on success or NULL on failure (e.g. if the surface didn't have an
       index format); call SDL_GetError() for more information.

THREAD SAFETY

       This function is not thread safe.

AVAILABILITY

       This function is available since SDL 3.2.0.

SEE ALSO

       SDL_SetPaletteColors(3)

Simple Directmedia Layer                           SDL 3.2.20                        SDL_CreateSurfacePalette(3)