Struct RanimPreviewApp 

pub struct RanimPreviewApp {

    cmd_rx: Receiver<RanimPreviewAppCmd>,
    pub cmd_tx: Sender<RanimPreviewAppCmd>,
    title: String,
    clear_color: Color,
    scene_constructor: Arc<dyn SceneConstructor>,
    scene_config: SceneConfig,
    resolution: Resolution,
    evaluator: SceneEvaluator,
    need_eval: bool,
    last_sec: f64,
    store: RenderFrame,
    timeline_state: TimelineState,
    playback_engine: PlaybackEngine,
    renderer: Option<Renderer>,
    render_textures: Option<RenderTextures>,
    texture_id: Option<TextureId>,
    depth_texture_id: Option<TextureId>,
    view_mode: ViewMode,
    wgpu_ctx: Option<WgpuContext>,
    last_render_time: Option<Duration>,
    last_eval_time: Option<Duration>,
    depth_visual_pipeline: Option<DepthVisualPipeline>,
    depth_visual_texture: Option<Texture>,
    depth_visual_view: Option<TextureView>,
    resolution_dirty: bool,
    export_dialog_open: bool,
    export_config: Output,
    export_progress_rx: Option<Receiver<ExportProgress>>,
    export_current_frame: u64,
    export_total_frames: u64,
    playback_speed: f64,
    looping: bool,
    profiler_open: bool,
    gpu_pass_times: Vec<(String, f64)>,
    cpu_spans: Vec<(String, f64)>,
    upload_stats: BTreeMap<&'static str, UploadStats>,
    progress_samples: Vec<Option<ProgressSample>>,
    progress_total_sec: f64,
    profiler_metric: ProfilerMetric,
    profiler_stacked: bool,
}

Available on crate feature preview only.

Fields

cmd_rx: Receiver<RanimPreviewAppCmd>

cmd_tx: Sender<RanimPreviewAppCmd>

title: String

clear_color: Color

scene_constructor: Arc<dyn SceneConstructor>

scene_config: SceneConfig

resolution: Resolution

evaluator: SceneEvaluator

need_eval: bool

last_sec: f64

store: RenderFrame

timeline_state: TimelineState

playback_engine: PlaybackEngine

renderer: Option<Renderer>

render_textures: Option<RenderTextures>

texture_id: Option<TextureId>

depth_texture_id: Option<TextureId>

view_mode: ViewMode

wgpu_ctx: Option<WgpuContext>

last_render_time: Option<Duration>

last_eval_time: Option<Duration>

depth_visual_pipeline: Option<DepthVisualPipeline>

depth_visual_texture: Option<Texture>

depth_visual_view: Option<TextureView>

resolution_dirty: bool

export_dialog_open: bool

Available on crate feature render and non-target_family=wasm only.

export_config: Output

export_progress_rx: Option<Receiver<ExportProgress>>

Available on crate feature render and non-target_family=wasm only.

export_current_frame: u64

Available on crate feature render and non-target_family=wasm only.

export_total_frames: u64

Available on crate feature render and non-target_family=wasm only.

playback_speed: f64

looping: bool

profiler_open: bool

gpu_pass_times: Vec<(String, f64)>

Last rendered frame’s GPU pass times in μs, flattened from the wgpu-profiler scope tree. Empty when GPU timers are unavailable.

cpu_spans: Vec<(String, f64)>

CPU spans of the last rendered frame (ms), drained from cpu_probe.

upload_stats: BTreeMap<&'static str, UploadStats>

Last rendered frame’s per-buffer upload stats (drained each frame).

progress_samples: Vec<Option<ProgressSample>>

Profiling samples indexed by timeline position (one bucket per logic frame); playing or seeking updates the bucket at the rendered position, so the chart shows performance across scene progress.

progress_total_sec: f64

profiler_metric: ProfilerMetric

profiler_stacked: bool

Whether stackable chart metrics render stacked (per-pass colors) instead of a plain total.

Implementations

impl RanimPreviewApp

pub fn new( scene_constructor: impl SceneConstructor + 'static, title: String, scene_config: SceneConfig, ) -> Self

pub fn set_clear_color_str(&mut self, color: &str)

Set clear color str

pub fn set_clear_color(&mut self, color: Color)

Set clear color

pub fn set_resolution(&mut self, resolution: Resolution)

Set preview resolution

fn calculate_oit_layers( &self, ctx: &WgpuContext, width: u32, height: u32, ) -> usize

Calculate OIT layers based on resolution to stay within GPU buffer limits

fn handle_events(&mut self)

fn prepare_renderer(&mut self, frame: &Frame)

fn is_playing(&self) -> bool

fn play(&mut self)

Start playback from the playhead (wrapping to 0.0 at the end).

fn pause(&mut self)

Stop playback, freezing the playhead at the clock’s current reading.

fn scrub_to(&mut self, sec: f64)

Move the playhead, keeping the active clock consistent with it.

fn tick_playback(&mut self) -> bool

Read the playing clock into the playhead and handle end-of-scene (loop or stop). Returns whether the UI should keep repainting.

fn render_animation(&mut self)

fn start_export(&mut self, ctx: Context)

Available on crate feature render and non-target_family=wasm only.

Trait Implementations

impl App for RanimPreviewApp

fn ui(&mut self, ui: &mut Ui, frame: &mut Frame)

Called each time the UI needs repainting, which may be many times per second.

fn logic(&mut self, ctx: &Context, frame: &mut Frame)

Called once before each call to [Self::ui], and additionally also called when the UI is hidden, but [egui::Context::request_repaint] was called.

fn save(&mut self, _storage: &mut dyn Storage)

Called on shutdown, and perhaps at regular intervals. Allows you to save state.

fn on_exit(&mut self)

Available on non-crate feature glow only.

Called once on shutdown, after [Self::save].

fn auto_save_interval(&self) -> Duration

Time between automatic calls to [Self::save]

fn clear_color(&self, _visuals: &Visuals) -> [f32; 4]

Background color values for the app, e.g. what is sent to gl.clearColor.

fn persist_egui_memory(&self) -> bool

Controls whether or not the egui memory (window positions etc) will be persisted (only if the “persistence” feature is enabled).

fn raw_input_hook(&mut self, _ctx: &Context, _raw_input: &mut RawInput)

A hook for manipulating or filtering raw input before it is processed by [Self::ui].