package hardcaml_waveterm

  1. Overview
  2. Docs
package hardcaml_waveterm
Legend:
Library
Module
Module type
Parameter
Class
Class type
val get_wave_width : (Base.int * Wave.t) -> Base.int * Base.int

get width code and actual width in chars

val get_wave_height : (Base.int * Wave.t) -> Base.int * Base.int

get height code and actual height in chars

val get_max_signal_width : Waves.t -> Base.int

max width of name window

val get_max_value_width : Waves.t -> Base.int

max width of values window. Needs to evaluate the entire waveform.

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 get_max_cycles : Waves.t -> Base.int

max no of wave cycles

val get_max_signals : Waves.t -> Base.int

max no of wave cycles

val get_max_wave_width : Waves.t -> Base.int

max width of wave window

val get_max_wave_height : Waves.t -> Base.int -> Base.int

max height of wave window

val draw_clock_cycle : ctx: (Base.int * Hardcaml_waveterm_kernel__.Draw.Style.t) Base.array Base.array -> style:Hardcaml_waveterm_kernel__.Draw.Style.t -> bounds:Hardcaml_waveterm_kernel__.Draw.rect -> w:Base.int -> h:Base.int -> c:Base.int -> Base.unit

draws one clock cycle

val draw_clock_cycles : ctx: (Base.int * Hardcaml_waveterm_kernel__.Draw.Style.t) Base.array Base.array -> style:Hardcaml_waveterm_kernel__.Draw.Style.t -> bounds:Hardcaml_waveterm_kernel__.Draw.rect -> w:Base.int -> waw:Base.int -> h:Base.int -> cnt:Base.int -> Base.unit

draws cnt clock cycles

val draw_binary_data : ctx: (Base.int * Hardcaml_waveterm_kernel__.Draw.Style.t) Base.array Base.array -> style:Hardcaml_waveterm_kernel__.Draw.Style.t -> bounds:Hardcaml_waveterm_kernel__.Draw.rect -> w:Base.int -> h:Base.int -> data:Data.t -> off:Base.int -> Base.unit

draw binary waveform data

val draw_data : ctx: (Base.int * Hardcaml_waveterm_kernel__.Draw.Style.t) Base.array Base.array -> style:Hardcaml_waveterm_kernel__.Draw.Style.t -> bounds:Hardcaml_waveterm_kernel__.Draw.rect -> to_str:(Hardcaml.Bits.t -> Base.string) -> alignment:Hardcaml_waveterm_kernel.Text_alignment.t -> w:Base.int -> h:Base.int -> data:Data.t -> off:Base.int -> Base.unit

draw arbitrary waveform data

type !'a draw_item = ?style:Hardcaml_waveterm_kernel__.Draw.Style.t -> ctx: (Base.int * Hardcaml_waveterm_kernel__.Draw.Style.t) Base.array Base.array -> bounds:Hardcaml_waveterm_kernel__.Draw.rect -> Waves.t -> 'a
val with_border : draw:'a draw_item -> label:Base.string -> ?border:Hardcaml_waveterm_kernel__.Draw.Style.t -> 'a draw_item
val draw_cursor : ctx: (Base.int * Hardcaml_waveterm_kernel__.Draw.Style.t) Base.array Base.array -> bounds:Hardcaml_waveterm_kernel__.Draw.rect -> state:Waves.t -> Base.unit

draw cursor

val draw_wave : Base.unit draw_item

draw waveforms

val draw_signals : ?alignment:Hardcaml_waveterm_kernel.Text_alignment.t -> ?style:Hardcaml_waveterm_kernel__.Draw.Style.t -> selected_wave_index:Base.int Base.option -> ctx: (Base.int * Hardcaml_waveterm_kernel__.Draw.Style.t) Base.array Base.array -> bounds:Hardcaml_waveterm_kernel__.Draw.rect -> Waves.t -> Base.unit

draw signal names

val draw_values : Base.int draw_item

draw signal values

val draw_status : Base.unit draw_item
val draw_ui : ?signals_alignment:Hardcaml_waveterm_kernel.Text_alignment.t -> ?style:Styles.t -> ?bounds:Bounds.t -> ctx: (Base.int * Hardcaml_waveterm_kernel__.Draw.Style.t) Base.array Base.array -> Waves.t -> Base.unit

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

type pick = Make(Hardcaml_waveterm_kernel__.Draw.In_memory).pick =
  1. | Wave of Base.int * Base.int
  2. | Value of Base.int
  3. | Signal of Base.int
  4. | Status
  5. | No_pick
val pick : bounds:Bounds.t -> r:Base.int -> c:Base.int -> Waves.t -> pick
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct