Skip to main content

Module report

Module report 

Source
Expand description

Rendering for water bench reports.

Budget evaluation happens inside waterui-testing while the benches run; this module only aggregates the collected BenchReports and renders them as JSON, GitHub-Action-benchmark JSON, or a standalone HTML page. The terminal layer prints the human summary itself.

Structs§

BenchResourceSummary
CPU, memory, GPU and scene-complexity aggregates over a measurement’s frames.

Functions§

bench_target_label
crate/bench label identifying one report in every output format.
bytes_label
Render a byte count the way the bench report displays it.
micros_label
Render a microsecond count the way the bench report displays it.
resource_summary
Aggregate a measurement’s per-frame resource samples, if it recorded any.
write_bench_gha_json
Write the github-action-benchmark customSmallerIsBetter JSON.
write_bench_html
Render every report into a standalone HTML page.
write_bench_output_json
Write every report as JSON to a file.
write_bench_stdout_json
Write every report as JSON on stdout.