Module webrender::profiler

Expand description

Overlay profiler

Comma-separated list of of tokens with trailing and leading spaces trimmed. Each tokens can be:

A counter name with an optional prefix. The name corresponds to the displayed name (see the counters vector below.
- By default (no prefix) the counter is shown as average + max over half a second.
- With a ‘#’ prefix the counter is shown as a graph.
- With a ‘*’ prefix the counter is shown as a change indicator.
- Some special counters such as GPU time queries have specific visualizations ignoring prefixes.
A preset name to append the preset to the UI (see PROFILER_PRESETS).
An empty token to insert a bit of vertical space.
A ‘|’ token to start a new column.
A ‘_’ token to start a new row.

Counter
CounterDescriptor
Expected
Ranges of expected value for a profile counter.
GpuProfileTag
Graph
GraphStats
ProfileScope
A simple RAII style struct to manage a profile scope.
Profiler
ProfilerFrame 🔒
ProfilerFrameCollection 🔒
TransactionProfile
A container for profiling information that moves along the rendering pipeline and is handed off to the profiler at the end.

PROFILER_HOOKS
The current global profiler callbacks, if set by embedder.
PROFILER_PRESETS 🔒
Profiler UI string presets. Defined in the profiler UI string syntax, can contain other presets.

add_event_marker
Records a marker of the given duration that just ended.
add_text_marker
Records a marker of the given duration that just ended.
bytes_to_mb
expected 🔒
find_preset 🔒
ms_to_ns
ns_to_ms
register_thread
Register a thread with the Gecko Profiler.
set_profiler_hooks
Set the profiler callbacks, or None to disable the profiler. This function must only ever be called before any WR instances have been created, or the hooks will not be set.
thread_is_being_profiled
Returns true if the current thread is being profiled.
unregister_thread
Unregister a thread with the Gecko Profiler.