ocolor 1.3.0 · OCaml Package

Basic types and values

Types

Color types

type color4 = {

r4 : bool;
g4 : bool;
b4 : bool;
intensity4 : bool;

}

The type of 4-bits colors. They are informally rgb colors where each component is in a scale from 0 to 1, with an additionnal intensity bit.

type cube6 = {

r6 : int;
g6 : int;
b6 : int;

}

The type of rgb colors with each component in [0; 5]. This is used to encode the 6*6*6 color cube of 8-bits colors?

type color8 =

| Standard of color4
| Cube6 of cube6
| Grayscale of int

The type of a 8-bits color. Such a color is either a standard color, a 6*6*6 rgb color or some kind of grey on a 24-steps grayscale. Thus, the paramter of Grayscale should be in [0; 23]

type color24 = {

r24 : int;
g24 : int;
b24 : int;

}

The type of 24-bits colors. Each component belongs to [0; 255].

type color =

| C4 of color4
| C8 of color8
| C24 of color24

The type of a color that can be a 4-, 8- or 24-bits color.

Style types

type style =

| Reset
| Bold
| Faint
| Faint_bold_off
| Italic
| Italic_fraktur_off
| Fraktur
| DoubleUnderlined
| Underlined
| Underlined_off
| Blink
| Blink_off
| Reverse_video
| Reverse_video_off
| Conceal
| Conceal_off
| Crossed_out
| Crossed_out_off
| Framed
| Framed_encircled_off
| Encircled
| Overlined
| Overlined_off
| Default_font
| Font of int
| Fg of color
| Default_fg
| Bg of color
| Default_bg

All style sequences that are implemented.

Reset disables everything (returns to default)
Bold enables bold font
Faint decreases intensity
Faint_bold_off revert the effect of Bold and Faint
Italic: italic font (likely to not work)
Fraktur: fraktur font (likely to not work)
Italic_fraktur_off: disables italic and fraktur (likely to not work)
Underlined: underlines text
Underlined_off: disable underline
Blink and Blink_off enables and disables flow blink (fast blink is rarely supported)
Reverse_video and Reverse_video_off as expected
Conceal and Conceal_off as excpected (rarely supported)
Crossed_out and Crossed_out_off as excpected
Framed, Encircled and Framed_encircled_off as excpected (rarely supported)
Overlined and Overlined_off as excpected
Default_font set font to default (rarely supported)
Font set font to specified number (in [1;9]) (rarely supported)
Fg set foreground color to specified color
Default_fg set foreground color to default color
Bg set background color to specified color
Default_bg set background color to default color

Helpers and values

Iterators on finite (small) color space

val fold_color4 : (color4 -> 'acc -> 'acc0) -> 'acc1 -> 'acc2

val fold_cube6 : (cube6 -> 'acc -> 'acc0) -> 'acc1 -> 'acc2

val fold_greyscale : (int -> 'acc -> 'acc0) -> 'acc1 -> 'acc2

val fold_color8 : (color8 -> 'acc -> 'acc0) -> 'acc1 -> 'acc2

Useful names for 4-bits colors

Standard 3-bits colors

val black : color4

val red : color4

val green : color4

val blue : color4

val yellow : color4

val magenta : color4

val cyan : color4

val white : color4

High intensity 4-bits colors

val hi_black : color4

val hi_red : color4

val hi_green : color4

val hi_blue : color4

val hi_yellow : color4

val hi_magenta : color4

val hi_cyan : color4

val hi_white : color4

Standard palettes types

type rgb = int * int * int

module Color4Map : sig ... end

module Color8Map : sig ... end

type color_palette =

| VGA
| CMD
| Terminal_app
| PuTTY
| MIRC
| Xterm
| X
| Ubuntu
| Custom_palette of rgb Color4Map.t

The kind of palette the terminal uses. It is used to match a 4-bits color to a rgb color. This is useful to find the clostest 4-bits color to a rgb color, according to the actual colors.

module ColorPaletteMap : sig ... end

package ocolor