Render (hardcaml_waveterm.hardcaml_waveterm.kernel.Hardcaml_waveterm

Functions for drawing waves, signal names and values

val get_max_signal_width_in_chars : Waves.t -> Base.int

max width of name window

val get_estimated_max_value_width : Waves.t -> Base.int

gets an estimate fo the max with of values. Inaccruate for the constructors U, S and F.

val total_cycles_in_waveform : Waves.t -> Base.int

max no of wave cycles

val total_signals_in_waveform : Waves.t -> Base.int

max no of wave signals

val wave_width_of_code : 
  Base.int ->
  [ `Cycles_per_char of Base.int | `Chars_per_cycle of Base.int ]

Turn the UI integer representation of wave_width into a the rendering form.

val draw_clock_cycles : 
  ctx:Draw.ctx ->
  style:Style.t ->
  bounds:Rect.t ->
  wave_width:[ `Cycles_per_char of Base.int | `Chars_per_cycle of Base.int ] ->
  cnt:Base.int ->
  Base.unit

draws cnt clock cycles

val draw_binary_data : 
  ctx:Draw.ctx ->
  style:Style.t ->
  bounds:Rect.t ->
  wave_width:[ `Cycles_per_char of Base.int | `Chars_per_cycle of Base.int ] ->
  data:Data.t ->
  off:Base.int ->
  Base.unit

draw binary waveform data

val draw_data : 
  ctx:Draw.ctx ->
  style:Style.t ->
  bounds:Rect.t ->
  to_str:(Hardcaml.Bits.t -> Base.string) ->
  alignment:Text_alignment.t ->
  wave_width:[ `Cycles_per_char of Base.int | `Chars_per_cycle of Base.int ] ->
  data:Data.t ->
  off:Base.int ->
  Base.unit

draw arbitrary waveform data

type 'a draw_item =
  ?style:Style.t ->
  ctx:Draw.ctx ->
  bounds:Rect.t ->
  Waves.t ->
  'a

val with_border : 
  draw:'a draw_item ->
  label:Base.string ->
  ?border:Style.t ->
  'a draw_item

val draw_cursor : 
  ctx:Draw.ctx ->
  bounds:Rect.t ->
  wave_cursor:Base.int ->
  primary:Base.bool ->
  state:Waves.t ->
  Base.unit

draw cursor

val draw_wave : 
  ?style:Style.t ->
  ?wave_cursors:[ `Primary of Base.int | `Secondary of Base.int ] Base.list ->
  selected_wave_index:Base.int Base.option ->
  ctx:Draw.ctx ->
  bounds:Rect.t ->
  Waves.t ->
  Base.unit

draw waveforms

val draw_signals : 
  ?alignment:Text_alignment.t ->
  ?style:Style.t ->
  selected_wave_index:Base.int Base.option ->
  ctx:Draw.ctx ->
  bounds:Rect.t ->
  Waves.t ->
  Base.unit

draw signal names

val draw_values : 
  ?style:Style.t ->
  ?wave_cursor:Base.int ->
  selected_wave_index:Base.int Base.option ->
  ctx:Draw.ctx ->
  bounds:Rect.t ->
  Waves.t ->
  Base.int

draw signal values

val draw_status : 
  ?style:Style.t ->
  ?wave_cursor:Base.int ->
  ctx:Draw.ctx ->
  bounds:Rect.t ->
  Waves.t ->
  Base.unit

val draw_ui : 
  ?signals_alignment:Text_alignment.t ->
  ?style:Window_styles.t ->
  ?bounds:Window_bounds.t ->
  ctx:Draw.ctx ->
  Waves.t ->
  Base.unit

draw standard user inferface (names, values, waveforms left to right

val draw_help : 
  ?style:Style.t ->
  ctx:Draw.ctx ->
  bounds:Rect.t ->
  Key_help.t Base.list ->
  offset:Base.int ->
  Base.unit

type pick =

| Wave of {
1. cycle : Base.int;
2. signal_index : Base.int Base.option;
}
| Value of {
1. signal_index : Base.int Base.option;
}
| Signal of {
1. signal_index : Base.int Base.option;
}
| Status
| No_pick

val pick : 
  bounds:Window_bounds.t ->
  r:Base.int ->
  c:Base.int ->
  Waves.t ->
  pick

module Static : sig ... end