MPLABĀ® Harmony Graphics Suite  GFX v3.13.0
Legato API Documentation
legato_palette.h File Reference

Palette functions and definitions. More...

Include dependency graph for legato_palette.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  lePalette
 This struct represents a palette asset. More...
 

Typedefs

typedef struct lePalette lePalette
 This struct represents a palette asset. More...
 

Functions

leColor lePalette_GetColor (lePalette *pal, uint32_t idx)
 Get color from a palette. More...
 

Detailed Description

Palette functions and definitions.

Defines palette assets and get palette color.

Typedef Documentation

◆ lePalette

typedef struct lePalette lePalette

This struct represents a palette asset.

A palette is a lookup table for unique colors. Given in an index, a color can be retrieved.

Function Documentation

◆ lePalette_GetColor()

leColor lePalette_GetColor ( lePalette pal,
uint32_t  idx 
)

Get color from a palette.

Gets a color from pal at idx.

lePalette * pal;
uint32_t idx;
leColor color = leColorValue(pal, idx);
Parameters
palis a color palatte.
idxis the location of the color
Returns
leColor.