Struct re_viewer_context::app_options::AppOptions

pub struct AppOptions {

    pub low_latency: f32,
    pub warn_latency: f32,
    pub show_metrics: bool,
    pub include_welcome_screen_button_in_recordings_panel: bool,
    pub experimental_space_view_screenshots: bool,
    pub show_picking_debug_overlay: bool,
    pub inspect_blueprint_timeline: bool,
    pub blueprint_gc: bool,
    pub time_zone: TimeZone,
    pub video_decoder_hw_acceleration: DecodeHardwareAcceleration,
    pub video_decoder_override_ffmpeg_path: bool,
    pub video_decoder_ffmpeg_path: String,
    pub mapbox_access_token: String,
    pub cache_directory: Option<PathBuf>,
}

Global options for the viewer.

Fields

low_latency: f32

warn_latency: f32

show_metrics: bool

Show milliseconds, RAM usage, etc.

include_welcome_screen_button_in_recordings_panel: bool

Include the “Welcome screen” application in the recordings panel?

experimental_space_view_screenshots: bool

Enable the experimental feature for space view screenshots.

show_picking_debug_overlay: bool

Displays an overlay for debugging picking.

inspect_blueprint_timeline: bool

Inspect the blueprint timeline.

blueprint_gc: bool

Disable garbage collection of the blueprint.

time_zone: TimeZone

What time zone to display timestamps in.

video_decoder_hw_acceleration: DecodeHardwareAcceleration

Preferred method for video decoding on web.

video_decoder_override_ffmpeg_path: bool

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 loosing the user-defined path when disabling the override.

video_decoder_ffmpeg_path: String

Custom path to the FFmpeg binary.

Don’t use this field directly, use AppOptions::video_decoder_settings instead.

mapbox_access_token: String

Mapbox API key (used to enable Mapbox-based map view backgrounds).

Can also be set using the RERUN_MAPBOX_ACCESS_TOKEN environment variable.

cache_directory: Option<PathBuf>

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.

Implementations

impl AppOptions

pub fn mapbox_access_token(&self) -> Option<String>

pub fn cache_subdirectory(&self, sub_dir: impl AsRef<Path>) -> Option<PathBuf>

pub fn default_cache_directory() -> Option<PathBuf>

Default cache directory

pub fn video_decoder_settings(&self) -> DecodeSettings

Get the video decoder settings.

Trait Implementations

impl Debug for AppOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AppOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AppOptions

where AppOptions: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AppOptions

fn eq(&self, other: &AppOptions) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for AppOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AppOptions