package ecaml

  1. Overview
  2. Docs
package ecaml
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Ecaml.ColorSource

A color name specifies a color.

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

Sourcemodule Frame : sig ... end
include Ecaml_value.Value.Subtype
Sourcetype t = private Ecaml_value.Value.t

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.

Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval 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.

Sourceval is_in_subtype : Ecaml_value.Value.t -> bool
Sourceval of_value_exn : Ecaml_value__.Value0.t -> t
Sourceval to_value : t -> Ecaml_value__.Value0.t
Sourceval type_ : t Ecaml_value.Value.Type.t
Sourceval of_name : string -> t
Sourceval to_name : t -> string
Sourceval black : t
Sourceval blue : t
Sourceval cyan : t
Sourceval green : t
Sourceval magenta : t
Sourceval orange : t
Sourceval red : t
Sourceval white : t
Sourceval yellow : t
Sourceval is_gray : ?on:Frame.t -> t -> bool

(describe-function 'color-gray-p)

Sourceval is_defined : ?on:Frame.t -> t -> bool

(describe-function 'color-defined-p)

Sourceval is_supported : ?on:Frame.t -> t -> bool

(describe-function 'color-supported-p)

Sourceval defined : ?on:Frame.t -> unit -> t list

(describe-function 'defined-colors)

Sourcemodule RGB : sig ... end
Sourceval rgb_exn : ?on:Frame.t -> t -> RGB.t

(describe-function 'color-values)

Sourceval of_rgb : RGB.t -> t
Sourceval of_rgb8 : r:int -> g:int -> b:int -> t

r, g, and b should be in the range 0, 255.