1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
use re_entity_db::FetchStage;
use re_log_types::TimestampFormat;
use re_memory::MemoryLimit;
use re_video::{DecodeHardwareAcceleration, DecodeSettings};
const MAPBOX_ACCESS_TOKEN_ENV_VAR: &str = "RERUN_MAPBOX_ACCESS_TOKEN";
/// Global options for the viewer.
#[derive(Debug, PartialEq, serde::Deserialize, serde::Serialize)]
#[serde(default)]
pub struct AppOptions {
/// Experimental feature flags.
pub experimental: ExperimentalAppOptions,
/// Warn if the e2e latency exceeds this value.
pub warn_e2e_latency: f32,
/// Show milliseconds, RAM usage, etc.
pub show_metrics: bool,
/// Show toasts for log messages?
///
/// If false, you can still view them in the notifications panel.
pub show_notification_toasts: bool,
/// Use Rerun's custom window decorations instead of the native OS decorations.
pub custom_window_decorations: bool,
/// Include the "Welcome screen" application in the recordings panel?
#[serde(alias = "include_welcome_screen_button_in_recordings_panel")]
pub include_rerun_examples_button_in_recordings_panel: bool,
/// Displays an overlay for debugging picking.
pub show_picking_debug_overlay: bool,
/// Inspect the blueprint timeline.
pub inspect_blueprint_timeline: bool,
/// Is garbage collection of the blueprint enabled?
pub blueprint_gc: bool,
/// What time zone to display timestamps in.
#[serde(rename = "timestamp_format")]
pub timestamp_format: TimestampFormat,
/// Video decoding options.
pub video: VideoOptions,
/// Whether per-visualizer instance/element limits are enabled.
///
/// Several visualizers (3D shapes, time series lines, etc.) cap the number of elements
/// they process to avoid hangs. When disabled, those caps are removed entirely,
/// which may cause the viewer to become unresponsive with very large data sets.
pub visualizer_limits_enabled: bool,
/// Mapbox API key (used to enable Mapbox-based map view backgrounds).
///
/// Can also be set using the `RERUN_MAPBOX_ACCESS_TOKEN` environment variable.
pub mapbox_access_token: String,
/// When the total process RAM reaches this limit, we GC old data.
pub memory_limit: MemoryLimit,
/// Only prefetch chunks up to (and including) this stage.
///
/// Useful for debugging and for users who want to limit how aggressively
/// we prefetch data ahead of what is strictly needed.
pub max_fetch_stage: FetchStage,
/// Path to the directory suitable for storing cache data.
///
/// By cache data, we mean data that is safe to be garbage collected by the OS. Defaults to
/// to [`directories::ProjectDirs::cache_dir`].
///
/// *NOTE*: subsystems making use of the cache directory should use a unique sub-directory name,
/// see [`AppOptions::cache_subdirectory`].
#[cfg(not(target_arch = "wasm32"))]
pub cache_directory: Option<std::path::PathBuf>,
}
impl Default for AppOptions {
fn default() -> Self {
Self {
experimental: Default::default(),
warn_e2e_latency: 1.0,
show_metrics: cfg!(debug_assertions),
show_notification_toasts: true,
custom_window_decorations: re_ui::custom_window_decorations_default(),
include_rerun_examples_button_in_recordings_panel: true,
show_picking_debug_overlay: false,
inspect_blueprint_timeline: false,
blueprint_gc: true,
timestamp_format: TimestampFormat::default(),
video: Default::default(),
visualizer_limits_enabled: true,
mapbox_access_token: String::new(),
memory_limit: MemoryLimit::default_for_current_platform(),
max_fetch_stage: FetchStage::default(),
#[cfg(not(target_arch = "wasm32"))]
cache_directory: Self::default_cache_directory(),
}
}
}
impl AppOptions {
pub fn test() -> Self {
Self {
memory_limit: MemoryLimit::UNLIMITED,
show_metrics: false, // flaky in snapshot tests
#[cfg(any(target_os = "windows", target_os = "linux"))]
custom_window_decorations: false,
..Default::default()
}
}
pub fn mapbox_access_token(&self) -> Option<String> {
if self.mapbox_access_token.is_empty() {
std::env::var(MAPBOX_ACCESS_TOKEN_ENV_VAR).ok()
} else {
Some(self.mapbox_access_token.clone())
}
}
#[cfg(not(target_arch = "wasm32"))]
pub fn cache_subdirectory(
&self,
sub_dir: impl AsRef<std::path::Path>,
) -> Option<std::path::PathBuf> {
self.cache_directory
.as_ref()
.map(|cache_dir| cache_dir.join(sub_dir))
}
/// Default cache directory
pub fn default_cache_directory() -> Option<std::path::PathBuf> {
directories::ProjectDirs::from("io", "rerun", "Rerun")
.map(|dirs| dirs.cache_dir().to_owned())
}
/// Get the video decoder settings.
pub fn video_decoder_settings(&self) -> DecodeSettings {
DecodeSettings {
hw_acceleration: self.video.hw_acceleration,
#[cfg(not(target_arch = "wasm32"))]
ffmpeg_path: self
.video
.override_ffmpeg_path
.then(|| std::path::PathBuf::from(&self.video.ffmpeg_path)),
}
}
}
#[derive(Debug, Default, PartialEq, Eq, serde::Deserialize, serde::Serialize)]
#[serde(default)]
pub struct VideoOptions {
/// Preferred method for video decoding on web.
pub hw_acceleration: DecodeHardwareAcceleration,
/// Override the path to the FFmpeg binary.
///
/// If set, use `video_decoder_ffmpeg_path` as the path to the FFmpeg binary.
/// Don't use this field directly, use [`AppOptions::video_decoder_settings`] instead.
///
/// Implementation note: we avoid using `Option<PathBuf>` here to avoid losing the user-defined
/// path when disabling the override.
#[expect(clippy::doc_markdown)]
pub override_ffmpeg_path: bool,
/// Custom path to the FFmpeg binary.
///
/// Don't use this field directly, use [`AppOptions::video_decoder_settings`] instead.
#[expect(clippy::doc_markdown)]
pub ffmpeg_path: String,
}
#[derive(Debug, Default, PartialEq, Eq, serde::Deserialize, serde::Serialize)]
#[serde(default)]
pub struct ExperimentalAppOptions {
/// Enable table cards and blueprints.
///
/// This enables table blueprints embedded in Arrow schema metadata,
/// plus the table/grid view toggle for card-based table layouts.
pub table_cards_and_blueprints: bool,
}