Crate re_viewer 

Rerun Viewer GUI.

This crate contains all the GUI code for the Rerun Viewer, including all 2D and 3D visualization code.

Failure handling overview

High-level

Errors that affect the Viewer broadly, either user error or general issues, are reported via re_log (i.e. re_log::error! / re_log::warn!). These are not scoped to a specific view or entity and are often intermittent. They are shown in the notification panel.

Per-visualizer-type in a view (re_viewer_context::VisualizerTypeReport::OverallError)

A specific visualizer type fails entirely for a view. Rare and almost always a Viewer bug.

Per-instruction (per entity × visualizer × view) (re_viewer_context::VisualizerInstructionReport)

The most common failure mode: something goes wrong for a specific entity being processed by a specific visualizer in a specific view. Collected in re_viewer_context::VisualizerTypeReport::PerInstructionReport.

See re_viewer_context::VisualizerInstructionReport for how these break down further.

Re-exports

pub use event::SelectionChangeItem;

pub use event::ViewerEvent;

pub use event::ViewerEventKind;

pub use native::run_native_app;

Modules

blueprint

Auto-generated blueprint-related types.

env_vars

event

Viewer event definitions.

external

native

viewer_test_utils

Structs

App

The Rerun Viewer as an eframe application.

AsyncRuntimeHandle

Thin abstraction over the async runtime.

CommandReceiver

Receiver for the CommandSender

CommandSender

Sender that queues up the execution of commands.

MainThreadToken

A token that (almost) proves we are on the main thread.

StartupOptions

Settings set once at startup (e.g. via command-line options) and not serialized.

Enums

AppEnvironment

Where is this App running in? Used for analytics.

SystemCommand

Commands used by internal system components

Traits

SystemCommandSender

Interface for sending SystemCommand messages.

Functions

build_info

Information about this version of the crate.

command_channel

Creates a new command channel.

customize_eframe_and_setup_renderer

Customize eframe and egui to suit the rerun viewer.

register_text_log_receiver

Hook into re_log to receive copies of text log messages on a channel, which we will then show in the notification panel.

reset_viewer_persistence

Reset the viewer state as stored on disk and local storage, keeping only the analytics state.