Realm

oa::viewer::TrainingViewerSource

Non-owning TrainingSession dashboard source for Viewer live mode. Donor: oa::TrainingViewerSource.

StRust public API

Declaration

pub struct TrainingViewerSource { /* private fields */ }
Public Rust declaration.

Public Methods

pub fn publish_preview(&self, frame: TrainingPreviewFrame) -> Result<()>
pub const fn config(&self) -> &TrainingViewerConfig
pub fn latest_snapshot(&self) -> Option<TrainingSessionSnapshot>
pub fn latest_preview(&self) -> Option<TrainingPreviewFrame>
pub fn metric_series_count(&self) -> u32
pub fn metric_sample_count(&self, name: &str) -> u32
fn capabilities(&self) -> ViewerLiveCapabilities
fn open(&mut self, _engine: &Engine) -> Result<()>
fn on_event(&mut self, event: &InputEvent) -> Result<()>
fn update(&mut self, delta_ms: f32) -> Result<()>
fn render(&mut self, ui: &mut Ui<'_>, width: u32, height: u32) -> Result<()>
fn close(&mut self) -> Result<()>

Associated Functions

pub fn new(session: &TrainingSession, config: TrainingViewerConfig) -> Self

Public Method Documentation

pub fn publish_preview(&self, frame: TrainingPreviewFrame) -> Result<()>
No public source comment is attached to this declaration.
pub const fn config( &self ) -> &TrainingViewerConfig
No public source comment is attached to this declaration.
pub fn latest_snapshot( &self ) -> Option<TrainingSessionSnapshot>
No public source comment is attached to this declaration.
pub fn latest_preview( &self ) -> Option<TrainingPreviewFrame>
No public source comment is attached to this declaration.
pub fn metric_series_count( &self ) -> u32
No public source comment is attached to this declaration.
pub fn metric_sample_count( &self, name: &str ) -> u32
No public source comment is attached to this declaration.
fn capabilities( &self ) -> ViewerLiveCapabilities
Called once when the Viewer obtains an Engine.
fn open(&mut self, _engine: &Engine) -> Result<()>
No public source comment is attached to this declaration.
fn on_event(&mut self, event: &InputEvent) -> Result<()>
No public source comment is attached to this declaration.
fn update(&mut self, delta_ms: f32) -> Result<()>
No public source comment is attached to this declaration.
fn render(&mut self, ui: &mut Ui<'_>, width: u32, height: u32) -> Result<()>
No public source comment is attached to this declaration.
fn close(&mut self) -> Result<()>
No public source comment is attached to this declaration.
pub fn new( session: &TrainingSession, config: TrainingViewerConfig ) -> Self
No public source comment is attached to this declaration.