Pote.Converters.RGB (Pote v3.0.0)

Copy Markdown View Source

Conversions to/from RGB.

Examples

iex> Pote.Converters.RGB.to_hex({255, 128, 0})
"#FF8000"

iex> Pote.Converters.RGB.to_cmyk({255, 128, 0})
{0.0, 49.8, 100.0, 0.0}

Summary

Types

cmyk()
hex()
hsl()
hsv()
rgb()
xterm256()

Functions

blend(arg1, arg2, factor)

Blends two RGB colors with a given factor.

clamp(value)

Clamps a value to the 0-255 range.

color_distance(arg1, arg2)

Calculates the Manhattan distance between two RGB colors.

from_hex(hex)

Converts hexadecimal to RGB.

to_cmyk(arg)

Converts RGB to CMYK.

to_hex(arg)

Converts RGB to hexadecimal.

to_hsl(arg)

Converts RGB to HSL.

to_hsv(arg)

Converts RGB to HSV.

to_xterm256(arg)

Converts RGB to XTerm256.

Types

cmyk()

@type cmyk() :: Pote.cmyk()

hex()

@type hex() :: Pote.hex()

hsl()

@type hsl() :: Pote.hsl()

hsv()

@type hsv() :: Pote.hsv()

rgb()

@type rgb() :: Pote.rgb()

xterm256()

@type xterm256() :: Pote.xterm256()

Functions

blend(arg1, arg2, factor)

@spec blend(rgb(), rgb(), float()) :: rgb()

Blends two RGB colors with a given factor.

clamp(value)

@spec clamp(integer()) :: 0..255

Clamps a value to the 0-255 range.

color_distance(arg1, arg2)

@spec color_distance(rgb(), rgb()) :: non_neg_integer()

Calculates the Manhattan distance between two RGB colors.

from_hex(hex)

@spec from_hex(hex()) :: {:ok, rgb()} | {:error, :invalid_hex_format}

Converts hexadecimal to RGB.

to_cmyk(arg)

@spec to_cmyk(rgb()) :: cmyk()

Converts RGB to CMYK.

to_hex(arg)

@spec to_hex(rgb()) :: hex()

Converts RGB to hexadecimal.

to_hsl(arg)

@spec to_hsl(rgb()) :: hsl()

Converts RGB to HSL.

to_hsv(arg)

@spec to_hsv(rgb()) :: hsv()

Converts RGB to HSV.

to_xterm256(arg)

@spec to_xterm256(rgb()) :: xterm256()

Converts RGB to XTerm256.