Struct RevealSession 

pub struct RevealSession { /* private fields */ }

One reveal run, driven by the host step by step (see the module documentation).

Implementations

impl RevealSession

pub fn new( width: usize, height: usize, noise: f64, tile_size: usize, frames: u32, layers: Vec<RevealLayer>, canvases: Vec<RevealCanvas>, ) -> Result<RevealSession, RevealError>

A reveal over frames decoded frames of width × height with the source’s decode noise, for the moving layers and canvases (in the order the host lists them), on tile_size-pixel tiles.

pub fn estimate(&self) -> f64

Core memory the stage needs before it starts: every canvas and layer, and the decoded frames it holds.

pub fn memory(&mut self, fits: bool, core_bytes: f64) -> Result<(), RevealError>

The answer to Step::NeedMemory: whether the bytes fit, and the core’s current size in bytes (reported in REVEAL_SKIPPED when they do not).

pub fn observation( &mut self, frame: u32, decisions: &[ObservedDecision], ) -> Result<(), RevealError>

One stored observation/ row (frame and decisions), after Step::NeedObservations. Decisions on a canvas or layer the stage does not cover are left out, and so is a blind decision whose placement is not a skip.

pub fn frame_buffer(&mut self) -> Result<&mut [u8], RevealError>

The buffer the next decoded frame’s RGBA (width × height × 4 bytes) goes into, during Step::Decode and only for a frame wanted marks. Asking again before RevealSession::push_frame returns the same buffer.

pub fn push_frame( &mut self, index: u32, labels: Option<&[u8]>, ) -> Result<(), RevealError>

Frame index was decoded: the frame written into RevealSession::frame_buffer since the last push, or no pixels when it was not wanted. labels is the atlas label plane. Step until Step::NextFrame afterwards.

pub fn end_pass(&mut self, labels: Option<&[u8]>) -> Result<(), RevealError>

The decode for this pass is over: runs still open vote with the last frame. Step until Step::PassDone.

pub fn step( &mut self, cache: &mut TileCache, now: f64, ) -> Result<Step, RevealError>

Runs the stage until it needs something from the host. now is the host’s clock, stamped on every tile this step writes.