Struct ScanSession 

pub struct ScanSession { /* private fields */ }

The scan pass of one run.

Implementations

impl ScanSession

pub fn new(width: usize, height: usize, factor: usize) -> ScanSession

A scan over width × height native frames analysed at the integer factor.

pub fn native_size(&self) -> (usize, usize)

pub fn analysis_size(&self) -> (usize, usize)

pub fn learner(&self) -> &RegionLearner

The layer-learning state, for hosts and tests that read the accumulators back.

pub fn frame_buffer(&mut self) -> &mut [u8]

The buffer the next frame’s native RGBA (width × height × 4 bytes) goes into. Asking again before push returns the same buffer.

pub fn is_duplicate(&mut self) -> bool

Whether the frame written into frame_buffer repeats the previous frame exactly (every RGBA byte). A duplicate needs no analysis gray.

pub fn push( &mut self, meta: FrameMeta, gray: Option<&[u8]>, ) -> Result<ScanStep, ScanError>

Analyses the frame written into frame_buffer. gray is the host’s analysis gray for it (for example from WebGPU), which must equal the box-filtered luma at the session’s factor; without one the session computes it.

pub fn finish(&self, manual: &[ManualRegion]) -> ScanRegions

Builds the run’s regions (none when no frame was analysed) from the learned evidence, or from manual when the run has hand-placed regions, and the diagnostics about the resulting layout.