Pote (Pote v1.0.0)

Pote — canonical color types, default palette, and top-level helpers.

This module defines the core color type definitions used throughout the entire library and provides access to the built-in default color palette.

Summary

argb()

cmyk()

color_input()

color_output()

hex()

hsl()

hsv()

rgb()

xterm256()

color(name)

Returns a specific color by name (alias for get_color/1).

Checks if a color name exists in the default palette.

color_names()

Returns all available color names.

default_colors()

Returns the default color palette.

get_color(name)

Looks up a color by atom name. Returns RGB tuple or nil.

@type argb() ::
  {non_neg_integer(), non_neg_integer(), non_neg_integer(), non_neg_integer()}

@type cmyk() :: {float(), float(), float(), float()}

@type color_input() ::
  rgb() | hex() | hsl() | hsv() | cmyk() | xterm256() | atom() | String.t()

@type color_output() :: rgb() | nil

@type hex() :: String.t()

@type hsl() :: {float(), float(), float()}

@type hsv() :: {float(), float(), float()}

@type rgb() :: {non_neg_integer(), non_neg_integer(), non_neg_integer()}

@type xterm256() :: 0..255

@spec color(atom()) :: {integer(), integer(), integer()} | nil

Returns a specific color by name (alias for get_color/1).

@spec color_exists?(atom()) :: boolean()

Checks if a color name exists in the default palette.

@spec color_names() :: [atom()]

Returns all available color names.

@spec default_colors() :: map()

Returns the default color palette.

@spec get_color(atom()) :: {integer(), integer(), integer()} | nil

Looks up a color by atom name. Returns RGB tuple or nil.