Struct voxelize::Pipeline

pub struct Pipeline {
    pub chunks: HashSet<Vec2<i32>>,
    pub leftovers: HashMap<Vec2<i32>, Vec<BlockChange>>,
    /* private fields */
}

A pipeline where chunks are initialized and generated.

Fields

chunks: HashSet<Vec2<i32>>

A HashSet that keeps track of what chunks are in the pipeline.

leftovers: HashMap<Vec2<i32>, Vec<BlockChange>>

Leftover changes to chunks.

Implementations

impl Pipeline

pub fn new() -> Self

Create a new chunk pipeline.

pub fn has(&self, coords: &Vec2<i32>) -> bool

Check to see if a chunk is in this pipeline. Chunks are added into the pipeline by calling pipeline.push.

pub fn len(&self) -> usize

Get the length of this pipeline, in other words how many stages there are.

pub fn push(&mut self, coords: &Vec2<i32>, index: usize)

Push a chunk job into the pipeline’s queue. Does nothing if chunk is in the pipeline already. Chunks that are pushed into the pipeline will only be freed from the pipeline if they reach the end of the pipeline.

pub fn pop(&mut self) -> Option<(Vec2<i32>, usize)>

Pop a chunk job from the queue. This does not remove the chunk from the pipeline. Calling pipeline.has will still return true as chunk hasn’t reached the last stage.

pub fn postpone(&mut self, coords: &Vec2<i32>, index: usize)

Postpone the chunk process to wait for its neighbors. Similar to pipeline.push, but checks if chunk is already waiting in queue. Panics if true.

pub fn add_stage<T>(&mut self, stage: T) where
    T: 'static + ChunkStage + Send + Sync, 

Add a stage to the chunking pipeline.

pub fn get_stage(&mut self, index: usize) -> &Arc<dyn ChunkStage + Send + Sync>

Get the stage instance at index.

pub fn process(
    &mut self,
    processes: Vec<(Chunk, Option<Space>, usize)>,
    registry: &Registry,
    config: &WorldConfig,
    noise: &SeededNoise,
    terrain: &SeededTerrain
)

Process a list of chunk processes, generated from the ECS system PipeliningSystem .

pub fn results(&self) -> Result<(Vec<Chunk>, Vec<BlockChange>), TryRecvError>

Attempt to retrieve the results from pipeline.process

pub fn advance(&mut self, chunk: &mut Chunk)

Advance a chunk to the next chunk stage. If chunk has reached the end of the pipeline, chunk.stage is set to None.

pub fn remove(&mut self, coords: &Vec2<i32>)

Remove a chunk from the pipeline.

pub fn is_empty(&self) -> bool

Is this pipeline vacant?

pub fn get_stage_name(&self, index: Option<usize>) -> Option<String>

Get the stage name from index.