Skip to main content

SetLayerPalette

Updated
globalmapper.SetLayerPalette(GM_LayerHandle_t32 aLayer, GM_PaletteEntry_t aNewPalette, uint32 aReserved=0) → GM_Error_t32

Sets the color palette for a given layer. The layer must be a palette-based image. The mPalette and mPaletteSize values in GM_LayerInfo_t for the layer will indicate the size and values in the current palette. You can restore the original palette for a layer by passing None. If you pass in fewer colors than in the original palette, only those colors that you provide will be updated.

Parameters:

  • aLayer (GM_LayerHandle_t32) – layer to set palette for

  • aNewPalette (GM_PaletteEntry_t) – pointer to list of palette entries to use for layer or None to reset palette to original palette

  • aReserved (uint32) – Reserved for future use; defaults to 0

Returns:

Error Code

Return type:

GM_Error_t32

Example

The following is an example of SetLayerPalette.:

gm.SetLayerPalette(layers_array[0], [new_palette_purple, new_palette_black], 0)

For more context refer to the display options/drawing sample scripts.