rigidity_viz/lib.rs
1//! Debug visualisation through Rerun, behind the `rerun` feature.
2//!
3//! No viewer of our own is written. Rerun is used as a log sink through
4//! its stable SDK; embedding `re_viewer` is deliberately avoided, as its
5//! custom-view interface breaks on every release.
6//!
7//! The core knows nothing about this crate: the dependency runs one way,
8//! and an ordinary build does not pull Rerun in.
9//!
10//! # Example
11//!
12//! ```no_run
13//! # #[cfg(feature = "rerun")]
14//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
15//! use rigidity_viz::Recorder;
16//! let recorder = Recorder::spawn("rigidity")?;
17//! # Ok(())
18//! # }
19//! # #[cfg(not(feature = "rerun"))]
20//! # fn main() {}
21//! ```
22
23#[cfg(feature = "rerun")]
24mod recorder;
25
26#[cfg(feature = "rerun")]
27pub use recorder::{Recorder, VizError};