Fledex.Color.Names.Types (fledex v0.5.0)

View Source

Summary

Types

The allowed color names

The different properties that can be interrogated from a named color

The structure of a named color with all it's attributes.

The different values that can be returned when interrogating for some named color properties

Types

color_names_t()

@type color_names_t() :: Fledex.Color.Names.color_names_t()

The allowed color names

color_props_t()

@type color_props_t() ::
  :all
  | :index
  | :name
  | :descriptive_name
  | :hex
  | :rgb
  | :hsl
  | :hsv
  | :source

The different properties that can be interrogated from a named color

color_struct_t()

@type color_struct_t() :: %{
  index: integer(),
  name: color_names_t(),
  descriptive_name: String.t(),
  hex: Fledex.Color.Types.colorint(),
  rgb: Fledex.Color.Types.rgb(),
  hsl: Fledex.Color.Types.hsl(),
  hsv: Fledex.Color.Types.hsv(),
  source: String.t(),
  module: module()
}

The structure of a named color with all it's attributes.

color_vals_t()

@type color_vals_t() :: Fledex.Color.Types.color_any() | color_struct_t() | String.t()

The different values that can be returned when interrogating for some named color properties