package hardcaml_waveterm

You can search for identifiers within the package.

in-package search v0.2.0

Legend:
Library
Module
Module type
Parameter
Class
Class type

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 -> Base.Int.t

val cols : ctx -> Base.Int.t

val get_bounds : ctx -> rect

get context size

val get_style : Style.t -> style

convert our style info to underlying style

val clear : ctx -> Base.Unit.t

clear display

val fill : ctx:ctx -> style:style -> bounds:rect -> Base.Char.t -> Base.Unit.t

fill bounds with char given style

val draw_int : 
  ctx:ctx ->
  style:style ->
  bounds:rect ->
  r:Base.Int.t ->
  c:Base.Int.t ->
  Base.Int.t ->
  Base.Unit.t

draw int (representing unicode value)

val draw_piece : 
  ctx:ctx ->
  style:style ->
  bounds:rect ->
  r:Base.Int.t ->
  c:Base.Int.t ->
  piece ->
  Base.Unit.t

draw piece

val draw_char : 
  ctx:ctx ->
  style:style ->
  bounds:rect ->
  r:Base.Int.t ->
  c:Base.Int.t ->
  Base.Char.t ->
  Base.Unit.t

draw char

val draw_string : 
  ctx:ctx ->
  style:style ->
  bounds:rect ->
  r:Base.Int.t ->
  c:Base.Int.t ->
  Base.String.t ->
  Base.Unit.t

draw string (nothing fancy - horizontal, no breaks)

val draw_box : 
  ctx:ctx ->
  style:style ->
  bounds:rect ->
  Base.String.t ->
  Base.Unit.t

draw box outline with label

val get : 
  ctx:ctx ->
  bounds:rect ->
  r:Base.Int.t ->
  c:Base.Int.t ->
  Base.Int.t * Style.t

get value and style at point

val inv : ctx:ctx -> bounds:rect -> r:Base.Int.t -> c:Base.Int.t -> Base.Unit.t

invert fg and bg at point

val bold : 
  ctx:ctx ->
  bounds:rect ->
  r:Base.Int.t ->
  c:Base.Int.t ->
  Base.Unit.t

set bold on point