Module Ecaml.Color

A color name specifies a color.

(Info-goto-node "(elisp)Color Names").

include Value.Subtype
type value
type 'a type_
type t = private value

We expose private value for free identity conversions when the value is nested in some covariant type, e.g. (symbols : Symbol.t list :> Value.t list) rather than List.map symbols ~f:Symbol.to_value.

include sig ... end
val sexp_of_t : t ‑> Sexplib.Sexp.t
val of_value_exn : value ‑> t
val to_value : t ‑> value
val eq : t ‑> t ‑> bool

eq t1 t2 = Value.eq (to_value t1) (to_value t2), i.e. eq checks whether the Emacs values underlying t1 and t2 are physically equal. This is different than phys_equal t1 t2, because we don't always wrap eq Emacs values in phys_equal OCaml values. I.e. phys_equal t1 t2 implies eq t1 t2, but not the converse.

val type_ : t type_
val of_name : string ‑> t
val to_name : t ‑> string
val black : t
val blue : t
val cyan : t
val green : t
val magenta : t
val red : t
val white : t
val yellow : t
val is_gray : ?⁠on:Frame.t ‑> t ‑> bool

(describe-function 'color-gray-p)

val is_defined : ?⁠on:Frame.t ‑> t ‑> bool

(describe-function 'color-defined-p)

val is_supported : ?⁠on:Frame.t ‑> t ‑> bool

(describe-function 'color-supported-p)

val defined : ?⁠on:Frame.t ‑> unit ‑> t list

(describe-function 'defined-colors)

module RGB : sig ... end
val rgb_exn : ?⁠on:Frame.t ‑> t ‑> RGB.t

(describe-function 'color-values)

val of_rgb : RGB.t ‑> t