package hardcaml_waveterm

You can search for identifiers within the package.

in-package search v0.2.0

hardcaml_waveterm
- Hardcaml_waveterm
  - Expert
  - Waveform
    
    Serialize
hardcaml_waveterm.interactive
- Hardcaml_waveterm_interactive
  - Draw_notty
  - Scroll
    
    Adjustment
    
    HScrollbar
    
    Mouse_mode
    
    Orientation
    
    Scroll_bar_mode
    
    Scroll_bar_style
    
    Scrollable
    
    Scrollbar
    
    VScrollbar
  - Widget
hardcaml_waveterm.kernel
- Hardcaml_waveterm_kernel
  - Display_rule
    
    States
  - Display_rules
    
    With_interface
    
    I
    
    All
    
    Comb
    
    Make_comb
    
    Comb
    
    Signed
    
    Sop
    
    TypedMath
    
    Unsigned
    
    Uop
    
    Names_and_widths
    
    Of_always
    
    Of_bits
    
    Of_signal
    
    Unsafe_assoc_by_port_name
  - Expert
    
    Data
    
    Draw
    
    In_memory
    
    Make
    
    B
    
    Primitives
    
    S
    
    Style
    
    Port
    
    Type
    
    Port_name
    
    Render
    
    Bounds
    
    Make
    
    G
    
    Static
    
    R
    
    Styles
    
    Sim
    
    Wave
    
    Waves
    
    Config
    
    Write
  - Text_alignment
  - Wave_format
  - Waveform

Legend:
Library
Module
Module type
Parameter
Class
Class type

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

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

In memory based API with no external requirements

type point = Base.int * Hardcaml_waveterm_kernel__.Draw.Style.t

type ctx = point Base.array Base.array

drawing context

type style = Hardcaml_waveterm.Expert.Draw.In_memory.style

underlying style type

val rows : ctx -> Base.int

val cols : ctx -> Base.int

val get_bounds : ctx -> Hardcaml_waveterm_kernel__.Draw.rect

get context size

val get_style : Hardcaml_waveterm_kernel__.Draw.Style.t -> style

convert our style info to underlying style

val clear : ctx -> Base.unit

clear display

val fill : 
  ctx:ctx ->
  style:style ->
  bounds:Hardcaml_waveterm_kernel__.Draw.rect ->
  Base.char ->
  Base.unit

fill bounds with char given style

val draw_int : 
  ctx:ctx ->
  style:style ->
  bounds:Hardcaml_waveterm_kernel__.Draw.rect ->
  r:Base.int ->
  c:Base.int ->
  Base.int ->
  Base.unit

draw int (representing unicode value)

val draw_piece : 
  ctx:ctx ->
  style:style ->
  bounds:Hardcaml_waveterm_kernel__.Draw.rect ->
  r:Base.int ->
  c:Base.int ->
  Hardcaml_waveterm_kernel__.Draw.piece ->
  Base.unit

draw piece

val draw_char : 
  ctx:ctx ->
  style:style ->
  bounds:Hardcaml_waveterm_kernel__.Draw.rect ->
  r:Base.int ->
  c:Base.int ->
  Base.char ->
  Base.unit

draw char

val draw_string : 
  ctx:ctx ->
  style:style ->
  bounds:Hardcaml_waveterm_kernel__.Draw.rect ->
  r:Base.int ->
  c:Base.int ->
  Base.string ->
  Base.unit

draw string (nothing fancy - horizontal, no breaks)

val draw_box : 
  ctx:ctx ->
  style:style ->
  bounds:Hardcaml_waveterm_kernel__.Draw.rect ->
  Base.string ->
  Base.unit

draw box outline with label

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

get value and style at point

val inv : 
  ctx:ctx ->
  bounds:Hardcaml_waveterm_kernel__.Draw.rect ->
  r:Base.int ->
  c:Base.int ->
  Base.unit

invert fg and bg at point

val bold : 
  ctx:ctx ->
  bounds:Hardcaml_waveterm_kernel__.Draw.rect ->
  r:Base.int ->
  c:Base.int ->
  Base.unit

set bold on point

val init : rows:Base.int -> cols:Base.int -> ctx

val to_image : ctx -> Notty.I.t