Baillehache Pascal's personal website

LibCapy - color

Color class.

Macros:

#define CAPY_COLOR_H

Enumerations:

typedef enum {
  capyColorSpace_sRGB,
  capyColorSpace_HSV,
  capyColorSpace_XYZ,
  capyColorSpace_LAB,
  capyColorSpace_rgb,
  capyColorSpace_l1l2l3,
  capyColorSpace_c1c2c3,
  capyColorSpace_Oklab,
  capyColorSpace_nb,
} CapyColorSpace;

Color spaces

typedef enum {
  capyColorIlluminant_D50, // 2 degrees
  capyColorIlluminant_D65, // 2 degrees
} CapyColorIlluminant;

Color illuminant

Typedefs:

typedef double CapyColorValue_t;

Type for the color values

Struct CapyColor :

Struct CapyColor's properties:

  CapyColorData vals;

Color values

  CapyColorIlluminant illuminant;

Color illuminant for conversion (by default D65)

  CapyPad(CapyColorIlluminant, 0);

Struct CapyColor's methods:

  void (*destruct)(void);

Destructor

  CapyColorData (*RGB2HSV)(void);

Convert the color from RGB to HSV

Output and side effect(s):

Return the converted color, values in [0,1] Can be used with $$(..., CapyColorData*, ...)

  CapyColorData (*HSV2RGB)(void);

Convert the color from HSV to RGB

Output and side effect(s):

Return the converted color, values in [0,1] Can be used with $$(..., CapyColorData*, ...)

  CapyColorData (*RGB2XYZ)(void);

Convert the color from RGB (in [0,1]) to XYZ (in [0,1])

Output and side effect(s):

Return the converted color Can be used with $$(..., CapyColorData*, ...)

  CapyColorData (*XYZ2RGB)(void);

Convert the color from XYZ (in [0,1]) to RGB (in [0,1])

Output and side effect(s):

Return the converted color, values in [0,1] Can be used with $$(..., CapyColorData*, ...)

  CapyColorData (*LAB2XYZ)(void);

Convert the color from LAB to XYZ

Output and side effect(s):

Return the converted color Can be used with $$(..., CapyColorData*, ...)

  CapyColorData (*Oklab2XYZ)(void);

Convert the color from Oklab to XYZ (D65 white point)

Output and side effect(s):

Return the converted color Can be used with $$(..., CapyColorData*, ...)

  CapyColorData (*XYZ2LAB)(void);

Convert the color from XYZ to LAB

Output and side effect(s):

Return the converted color, values in [0,1] Can be used with $$(..., CapyColorData*, ...)

  CapyColorData (*XYZ2Oklab)(void);

Convert the color from XYZ (D65 white point) to Oklab

Output and side effect(s):

Return the converted color Can be used with $$(..., CapyColorData*, ...)

  CapyColorData (*RGB2rgb)(void);

Convert the color from RGB to rgb

Output and side effect(s):

Return the converted color Can be used with $$(..., CapyColorData*, ...)

  CapyColorData (*RGB2l1l2l3)(void);

Convert the color from RGB to l1l2l3

Output and side effect(s):

Return the converted color Can be used with $$(..., CapyColorData*, ...)

  CapyColorData (*RGB2c1c2c3)(void);

Convert the color from RGB to c1c2c3

Output and side effect(s):

Return the converted color Can be used with $$(..., CapyColorData*, ...)

  bool (*equalsRGB)(CapyColorData const* const color);

Check if that is equal to 'color'

Input argument(s):

color: the color to be compared with

Output and side effect(s):

Return true if the colors are identical, else false Can be used with $$(..., CapyColorData*, ...)

  bool (*equalsRGBA)(CapyColorData const* const color);

  bool (*equalsHSV)(CapyColorData const* const color);

  bool (*equalsXYZ)(CapyColorData const* const color);

  bool (*equalsLAB)(CapyColorData const* const color);

  bool (*equalsrgb)(CapyColorData const* const color);

  bool (*equalsl1l2l3)(CapyColorData const* const color);

  bool (*equalsc1c2c3)(CapyColorData const* const color);

Struct CapyColorPalette :

Struct CapyColorPalette's properties:

  size_t size;

Number of colors in the palette

  CapyColorData* colors;

Colors in the palette

Struct CapyColorPalette's methods:

  void (*destruct)(void);

Destructor

  void (*set)(
           size_t const iColor,
    CapyColorData const color);

Set a color in the palette

Input argument(s):

iColor: the index of the color
color: the color to set

Output and side effect(s):

The color is set.

  CapyColorData (*get)(size_t const iColor);

Get a color in the palette

Input argument(s):

iColor: the index of the color

Output and side effect(s):

Return the color.

  void (*setRandomRGB)(CapyRandom* const rng);

Set random colors in the palette

Input argument(s):

rng: the RNG to be used

Output and side effect(s):

The RGB colors are set.

  void (*setRandomPastelRGB)(CapyRandom* const rng);

Set random pastel colors in the palette

Input argument(s):

rng: the RNG to be used

Output and side effect(s):

The RGB colors are set.

Functions:

CapyColor CapyColorCreate(CapyColorData const color);

Create a CapyColor

Input argument(s):

color: the color values

Output and side effect(s):

Return a CapyColor

CapyColor* CapyColorAlloc(CapyColorData const color);

Allocate memory for a new CapyColor and create it

Input argument(s):

color: the color values

Output and side effect(s):

Return a CapyColor

Exception(s):

May raise CapyExc_MallocFailed.

void CapyColorFree(CapyColor** const that);

Free the memory used by a CapyColor* and reset '*that' to NULL

Input argument(s):

that: a pointer to the CapyColor to free

CapyColorPalette CapyColorPaletteCreate(size_t const size);

Create a CapyColorPalette

Input argument(s):

size: the number of colors in the palette

Output and side effect(s):

Return a CapyColorPalette, all colors initialised to capyColorRGBABlack

CapyColorPalette* CapyColorPaletteAlloc(size_t const size);

Allocate memory for a new CapyColorPalette and create it

Input argument(s):

size: the number of colors in the palette

Output and side effect(s):

Return a CapyColorPalette, all colors initialised to capyColorRGBABlack

Exception(s):

May raise CapyExc_MallocFailed.

void CapyColorPaletteFree(CapyColorPalette** const that);

Free the memory used by a CapyColorPalette* and reset '*that' to NULL

Input argument(s):

that: a pointer to the CapyColorPalette to free

2021-10-08
in LibCapy,
84 views