Struct LanePool 

pub struct LanePool { /* private fields */ }

See the module doc. Lanes and their rate models persist across runs, so a caller rendering many images of one scene (a tilt video, successive coordinator jobs) calibrates each lane once.

Implementations

impl LanePool

pub const fn new(config: PoolConfig) -> Self

An empty pool.

pub fn add_lane(&mut self, lane: Arc<dyn WorkerLane>, rate: RateModel) -> usize

Registers lane starting from rate, returning its index.

pub const fn config(&self) -> &PoolConfig

The pool’s configuration.

pub fn lane_count(&self) -> usize

How many lanes are registered (those a fed run added included).

pub fn lane_name(&self, lane: usize) -> Option<String>

Lane lane’s WorkerLane::name.

pub fn rate(&self, lane: usize) -> Option<RateModel>

Lane lane’s current rate model.

pub fn run( &self, scene: &SceneState, range: SampleRange, cancel: &CancelToken, events: &(dyn Fn(PoolEvent) + Sync), ) -> PoolOutcome

Renders range of scene with every lane and returns the merged result. Blocks until the run ends (see PoolStatus); events is called from the lane threads as things happen.

pub fn run_into( &self, scene: &SceneState, range: SampleRange, merger: &Merger, cancel: &CancelToken, events: &(dyn Fn(PoolEvent) + Sync), ) -> Result<PoolStatus, MergerMismatch>

Like Self::run, merging into a caller-owned merger so another thread can read progressive snapshots (Merger::snapshot_into) while the run is going. merger must be fresh, built with Merger::new(width * height, range.first_sample).

Errors

MergerMismatch when merger was built for another size or range; nothing is rendered then.

pub fn run_into_fed( &self, scene: &SceneState, range: SampleRange, merger: &Merger, cancel: &CancelToken, events: &(dyn Fn(PoolEvent) + Sync), feed: Option<&dyn LaneFeed>, ) -> Result<PoolStatus, MergerMismatch>

Like Self::run_into, and additionally polls feed while the run is going: every lane it returns joins the epoch at once (see LaneFeed) and ends with it. Lanes added this way are registered in the pool afterwards, so Self::rate and Self::lane_name answer for them too. Without lanes of its own the run still ends as soon as no lane is running, however long feed could still deliver.

Errors

MergerMismatch as for Self::run_into.