Pote.Format.ANSI (Pote v1.0.0)

ANSI format for basic terminal colours.

Deprecated: Use Pote.ColorInfo.nearest_basic_color/1 instead for finding the nearest basic color, and Pote.ColorInfo.to_ansi/1 for ANSI escape codes. This module will be removed in a future version.

Summary

Types

parsed()

Functions

from_rgb(rgb)

Callback implementation for Pote.Format.from_rgb/1.

info(parsed)

Callback implementation for Pote.Format.info/1.

name(color)

Callback implementation for Pote.Format.name/1.

parse(color)

Callback implementation for Pote.Format.parse/1.

to_argb(color)

Callback implementation for Pote.Format.to_argb/1.

to_cmyk(color)

Callback implementation for Pote.Format.to_cmyk/1.

to_hex(color)

Callback implementation for Pote.Format.to_hex/1.

to_hsl(color)

Callback implementation for Pote.Format.to_hsl/1.

to_hsv(color)

Callback implementation for Pote.Format.to_hsv/1.

to_rgb(color)

Callback implementation for Pote.Format.to_rgb/1.

to_xterm256(color)

Callback implementation for Pote.Format.to_xterm256/1.

valid?(color)

Callback implementation for Pote.Format.valid?/1.

Types

parsed()

@type parsed() :: atom()

Functions

from_rgb(rgb)

@spec from_rgb({0..255, 0..255, 0..255}) :: parsed()

Callback implementation for Pote.Format.from_rgb/1.

info(parsed)

@spec info(parsed()) :: map()

Callback implementation for Pote.Format.info/1.

name(color)

@spec name(parsed()) :: String.t() | nil

Callback implementation for Pote.Format.name/1.

parse(color)

@spec parse(any()) :: {:ok, parsed()} | :error

Callback implementation for Pote.Format.parse/1.

to_argb(color)

@spec to_argb(parsed()) :: {0..255, 0..255, 0..255, 0..255}

Callback implementation for Pote.Format.to_argb/1.

to_cmyk(color)

@spec to_cmyk(parsed()) :: {float(), float(), float(), float()}

Callback implementation for Pote.Format.to_cmyk/1.

to_hex(color)

@spec to_hex(parsed()) :: String.t()

Callback implementation for Pote.Format.to_hex/1.

to_hsl(color)

@spec to_hsl(parsed()) :: {float(), float(), float()}

Callback implementation for Pote.Format.to_hsl/1.

to_hsv(color)

@spec to_hsv(parsed()) :: {float(), float(), float()}

Callback implementation for Pote.Format.to_hsv/1.

to_rgb(color)

@spec to_rgb(parsed()) :: {0..255, 0..255, 0..255}

Callback implementation for Pote.Format.to_rgb/1.

to_xterm256(color)

@spec to_xterm256(parsed()) :: non_neg_integer()

Callback implementation for Pote.Format.to_xterm256/1.

valid?(color)

@spec valid?(any()) :: boolean()

Callback implementation for Pote.Format.valid?/1.