Skip to main content

Session

Struct Session 

Source
pub struct Session<E> { /* private fields */ }
Expand description

Transport-independent preview state machine: feed it Commands, send its Outputs to the UI.

Implementations§

Source§

impl<E: PreviewEngine> Session<E>

Source

pub fn new(engine: E, encode: Encoder, cache_mb: usize) -> Self

cache_mb bounds the frame cache.

Source

pub fn engine(&mut self) -> &mut E

The wrapped engine.

Source

pub fn frame(&self) -> u32

Current frame.

Source

pub fn is_playing(&self) -> bool

Whether playback is running.

Source

pub fn render_size(&self) -> (u32, u32)

Size of preview frames: the viewport, fitted to the project aspect and never larger than the project.

Source

pub fn handle(&mut self, cmd: Command, now: f64) -> Vec<Output>

Handles one command. now is a monotonic clock in seconds, used to pace playback.

Source

pub fn tick(&mut self, now: f64) -> Vec<Output>

Advances playback to wall-clock now; returns the new frame’s outputs, or nothing if the frame did not change.

Source

pub fn next_tick_in(&self, now: f64) -> Option<f64>

Seconds until the next playback frame is due, if playing.

Auto Trait Implementations§

§

impl<E> !RefUnwindSafe for Session<E>

§

impl<E> !Send for Session<E>

§

impl<E> !Sync for Session<E>

§

impl<E> !UnwindSafe for Session<E>

§

impl<E> Freeze for Session<E>
where E: Freeze,

§

impl<E> Unpin for Session<E>
where E: Unpin,

§

impl<E> UnsafeUnpin for Session<E>
where E: UnsafeUnpin,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V