View Source Ultraviolet.Color.HSV (Ultraviolet v0.1.0)

Functions for working in the HSV color space

Summary

t()

Defines the channels in an HSV / HSB color.

Converts a Color to HSV

new(channels)

Generates a new HSV color object

new(h, s, v)

Generates a new HSV color object

new(h, s, v, a)

Generates a new HSV color object

to_rgb(hsv)

Converts from HSV to an RGB Color object

@type t() :: %{h: number(), s: number(), v: number(), a: number()}

Defines the channels in an HSV / HSB color.

@spec from_rgb(Ultraviolet.Color.t(), [...]) :: {:ok, t()}

Converts a Color to HSV

:round: an integer if rounding r, g, and b channel values to N decimal places is desired; if no rounding is desired, pass false. Default: 0

@spec new(tuple() | [number()] | map() | [...]) :: {:ok, t()}

Generates a new HSV color object

iex>Ultraviolet.Color.HSV.new({60, 0.0, 0.5})
{:ok, %Ultraviolet.Color.HSV{h: 60, s: 0.0, v: 0.5}}

@spec new(number(), number(), number()) :: {:ok, t()}

Generates a new HSV color object

iex>Ultraviolet.Color.HSV.new(60, 0.0, 0.5)
{:ok, %Ultraviolet.Color.HSV{h: 60, s: 0.0, v: 0.5}}

@spec new(number(), number(), number(), number()) :: {:ok, t()}

Generates a new HSV color object

iex>Ultraviolet.Color.HSV.new(60, 0.0, 0.5, 0.5)
{:ok, %Ultraviolet.Color.HSV{h: 60, s: 0.0, v: 0.5, a: 0.5}}

@spec to_rgb(t()) :: {:ok, Ultraviolet.Color.t()}

Converts from HSV to an RGB Color object

:round: an integer if rounding r, g, and b channel values to N decimal places is desired; if no rounding is desired, pass false. Default: 0

@spec to_rgb(t(), [...]) :: {:ok, Ultraviolet.Color.t()}