RealmOA Library

oa::Viewer

Windowed / headless media inspection session. Donor: oa::Viewer.

StRust public API

Declaration

pub struct Viewer<'src> { /* private fields */ }
Public Rust declaration.

Public Methods

pub fn set_live_source(&mut self, source: &'src mut dyn ViewerLiveSource)
pub fn run(self, engine: &Engine) -> Result<()>
pub fn run_standalone(self) -> Result<()>

Associated Functions

pub fn new(config: ViewerConfig) -> Self
pub fn with_path(path: impl Into<String>) -> Self
pub fn preview(path: &str) -> Result<()>
pub fn preview_with_config(path: &str, config: ViewerConfig) -> Result<()>
pub fn preview_with_engine(engine: &Engine, path: &str) -> Result<()>
pub fn preview_with_engine_and_config( engine: &Engine, path: &str, config: ViewerConfig, ) -> Result<()>
pub fn show(engine: &Engine, texture: &Texture) -> Result<()>
pub fn show_with_config( engine: &Engine, texture: &Texture, config: ViewerConfig, ) -> Result<()>
pub fn show_render_frame( engine: &Engine, renderer: &Renderer<'_>, frame: RenderFrame, config: ViewerConfig, ) -> Result<()>

Public Method Documentation

pub fn set_live_source( &mut self, source: &'src mut dyn ViewerLiveSource )
Open path in a new window, creating a presentation-capable engine.
pub fn run(self, engine: &Engine) -> Result<()>
No public source comment is attached to this declaration.
pub fn run_standalone(self) -> Result<()>
No public source comment is attached to this declaration.
pub fn new( config: ViewerConfig ) -> Self
Open path in a new window, creating a presentation-capable engine.
pub fn with_path( path: impl Into<String> ) -> Self
Open path in a new window, creating a presentation-capable engine.
pub fn preview(path: &str) -> Result<()>
No public source comment is attached to this declaration.
pub fn preview_with_config(path: &str, config: ViewerConfig) -> Result<()>
Open path in a new window, creating a presentation-capable engine.
pub fn preview_with_engine(engine: &Engine, path: &str) -> Result<()>
No public source comment is attached to this declaration.
pub fn preview_with_engine_and_config( engine: &Engine, path: &str, config: ViewerConfig, ) -> Result<()>
Open path in a new window, creating a presentation-capable engine.
pub fn show(engine: &Engine, texture: &Texture) -> Result<()>
No public source comment is attached to this declaration.
pub fn show_with_config( engine: &Engine, texture: &Texture, config: ViewerConfig, ) -> Result<()>
Open path in a new window, creating a presentation-capable engine.
pub fn show_render_frame( engine: &Engine, renderer: &Renderer<'_>, frame: RenderFrame, config: ViewerConfig, ) -> Result<()>
No public source comment is attached to this declaration.