package hardcaml_waveterm

You can search for identifiers within the package.

in-package search v0.2.0

A terminal based digital waveform viewer for Hardcaml

Install

Dune Dependency

github.com Readme Changelog MIT License Edit opam file Versions (6)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

hardcaml_waveterm-v0.13.0.tar.gz

sha256=b0eb68ea3d7fe58794bc72e5f304981a4607ff6580becf03cdef948993698c12

md5=1ab0d447fc79c059f3fcbde6ff2dcd7d

doc/hardcaml_waveterm.interactive/Hardcaml_waveterm_interactive/Draw_notty/index.html

Module `Hardcaml_waveterm_interactive.Draw_notty`

Notty based gfx API. We need to use an intermediate in memory representation for notty.

include module type of Hardcaml_waveterm.Draw.In_memory
  with type style = Hardcaml_waveterm.Draw.In_memory.style

type point = Base.Int.t * Hardcaml_waveterm.Draw.Style.t

include Hardcaml_waveterm.Draw.S
  with type ctx = point Base.Array.t Base.Array.t
   and type style = Hardcaml_waveterm.Draw.Style.t
  with type style = Hardcaml_waveterm.Draw.In_memory.style

type ctx = point Base.Array.t Base.Array.t

drawing context

type style = Hardcaml_waveterm.Draw.In_memory.style

underlying style type

val rows : ctx -> Base.Int.t

val cols : ctx -> Base.Int.t

val get_bounds : ctx -> Hardcaml_waveterm.Draw.rect

get context size

val get_style : Hardcaml_waveterm.Draw.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:Hardcaml_waveterm.Draw.rect ->
  Base.Char.t ->
  Base.Unit.t

fill bounds with char given style

val draw_int : 
  ctx:ctx ->
  style:style ->
  bounds:Hardcaml_waveterm.Draw.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:Hardcaml_waveterm.Draw.rect ->
  r:Base.Int.t ->
  c:Base.Int.t ->
  Hardcaml_waveterm.Draw.piece ->
  Base.Unit.t

draw piece

val draw_char : 
  ctx:ctx ->
  style:style ->
  bounds:Hardcaml_waveterm.Draw.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:Hardcaml_waveterm.Draw.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:Hardcaml_waveterm.Draw.rect ->
  Base.String.t ->
  Base.Unit.t

draw box outline with label

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

get value and style at point

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

invert fg and bg at point

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

set bold on point

val init : rows:Base.Int.t -> cols:Base.Int.t -> ctx

val to_image : ctx -> Notty.I.t