ExUnion v0.1.2

View Source Color (ExUnion v0.1.2)

Link to this section Summary

Types

t()
union()
union_hex()
union_hsl()
union_hsla()
union_rgb()
union_rgba()

Functions

hex(string)

See Color.Hex.new/1.

hsl(fields)

See Color.Hsl.new/1.

hsl(hue, saturation, lightness)

See Color.Hsl.new/3.

hsla(fields)

See Color.Hsla.new/1.

hsla(hue, saturation, lightness, alpha)

See Color.Hsla.new/4.

is_color(value)
rgb(fields)

See Color.Rgb.new/1.

rgb(red, green, blue)

See Color.Rgb.new/3.

rgba(fields)

See Color.Rgba.new/1.

rgba(red, green, blue, alpha)

See Color.Rgba.new/4.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: union()
Link to this type

union()

View Source 
@type union() ::
  Color.Hsla.t()
  | Color.Hsl.t()
  | Color.Rgba.t()
  | Color.Rgb.t()
  | Color.Hex.t()
Link to this type

union_hex()

View Source 
@type union_hex() :: Color.Hex.t()
Link to this type

union_hsl()

View Source 
@type union_hsl() :: Color.Hsl.t()
Link to this type

union_hsla()

View Source 
@type union_hsla() :: Color.Hsla.t()
Link to this type

union_rgb()

View Source 
@type union_rgb() :: Color.Rgb.t()
Link to this type

union_rgba()

View Source 
@type union_rgba() :: Color.Rgba.t()

Link to this section Functions

Link to this function

hex(string)

View Source 
@spec hex(string :: String.t()) :: Color.Hex.t()

See Color.Hex.new/1.

Link to this function

hsl(fields)

View Source 
@spec hsl(fields :: %{hue: 0..360, saturation: float(), lightness: float()}) ::
  Color.Hsl.t()
@spec hsl(fields :: [hue: 0..360, saturation: float(), lightness: float()]) ::
  Color.Hsl.t()

See Color.Hsl.new/1.

Link to this function

hsl(hue, saturation, lightness)

View Source 
@spec hsl(hue :: 0..360, saturation :: float(), lightness :: float()) :: Color.Hsl.t()

See Color.Hsl.new/3.

Link to this function

hsla(fields)

View Source 
@spec hsla(
  fields :: %{
    hue: 0..360,
    saturation: float(),
    lightness: float(),
    alpha: float()
  }
) ::
  Color.Hsla.t()
@spec hsla(
  fields :: [
    hue: 0..360,
    saturation: float(),
    lightness: float(),
    alpha: float()
  ]
) ::
  Color.Hsla.t()

See Color.Hsla.new/1.

Link to this function

hsla(hue, saturation, lightness, alpha)

View Source 
@spec hsla(
  hue :: 0..360,
  saturation :: float(),
  lightness :: float(),
  alpha :: float()
) ::
  Color.Hsla.t()

See Color.Hsla.new/4.

Link to this macro

is_color(value)

View Source (macro)
Link to this function

rgb(fields)

View Source 
@spec rgb(fields :: %{red: 0..255, green: 0..255, blue: 0..255}) :: Color.Rgb.t()
@spec rgb(fields :: [red: 0..255, green: 0..255, blue: 0..255]) :: Color.Rgb.t()

See Color.Rgb.new/1.

Link to this function

rgb(red, green, blue)

View Source 
@spec rgb(red :: 0..255, green :: 0..255, blue :: 0..255) :: Color.Rgb.t()

See Color.Rgb.new/3.

Link to this function

rgba(fields)

View Source 
@spec rgba(fields :: %{red: 0..255, green: 0..255, blue: 0..255, alpha: float()}) ::
  Color.Rgba.t()
@spec rgba(fields :: [red: 0..255, green: 0..255, blue: 0..255, alpha: float()]) ::
  Color.Rgba.t()

See Color.Rgba.new/1.

Link to this function

rgba(red, green, blue, alpha)

View Source 
@spec rgba(red :: 0..255, green :: 0..255, blue :: 0..255, alpha :: float()) ::
  Color.Rgba.t()

See Color.Rgba.new/4.