package hardcaml_waveterm

  1. Overview
  2. Docs

Main graphics drawing API.

Most functions take a bounds parameter which is a rectangle to which drawing is clipped and also serves as an origin for any coordinates.

type ctx

drawing context

type style

underlying style type

val rows : ctx -> Import.int
val cols : ctx -> Import.int
val get_bounds : ctx -> rect

get context size

val get_style : Style.t -> style

convert our style info to underlying style

val clear : ctx -> Import.unit

clear display

val fill : ctx:ctx -> style:style -> bounds:rect -> Import.char -> Import.unit

fill bounds with char given style

val draw_int : ctx:ctx -> style:style -> bounds:rect -> r:Import.int -> c:Import.int -> Import.int -> Import.unit

draw int (representing unicode value)

val draw_piece : ctx:ctx -> style:style -> bounds:rect -> r:Import.int -> c:Import.int -> piece -> Import.unit

draw piece

val draw_char : ctx:ctx -> style:style -> bounds:rect -> r:Import.int -> c:Import.int -> Import.char -> Import.unit

draw char

val draw_string : ctx:ctx -> style:style -> bounds:rect -> r:Import.int -> c:Import.int -> Import.string -> Import.unit

draw string (nothing fancy - horizontal, no breaks)

val draw_box : ctx:ctx -> style:style -> bounds:rect -> Import.string -> Import.unit

draw box outline with label

val get : ctx:ctx -> bounds:rect -> r:Import.int -> c:Import.int -> Import.int * Style.t

get value and style at point

val inv : ctx:ctx -> bounds:rect -> r:Import.int -> c:Import.int -> Import.unit

invert fg and bg at point

val bold : ctx:ctx -> bounds:rect -> r:Import.int -> c:Import.int -> Import.unit

set bold on point