Struct Batch

pub struct Batch<T: VoxelTrait> { /* private fields */ }

Accumulates per-node voxel modifications, enabling efficient bulk updates for an octree.

Type parameters

• T - The voxel type implementing VoxelTrait.

Implementations

impl<T: VoxelTrait> Batch<T>

pub fn new(max_depth: MaxDepth) -> Self

Creates a new Batch for a tree of the given maximum depth. Returns a new, empty Batch ready to record set, clear, or fill operations.

Arguments

• max_depth - Maximum depth (levels) of the target octree.

Example

use voxelis::{Batch, MaxDepth};

let batch = Batch::<u8>::new(MaxDepth::new(4));

pub fn masks(&self) -> &Vec<(u8, u8)>

Returns the internal vector of (set_mask, clear_mask) pairs per node.

pub fn values(&self) -> &Vec<[T; 8]>

Returns the buffered voxel values array for each child of every node.

pub fn to_fill(&self) -> Option<T>

Returns the uniform fill value if fill was invoked; otherwise None.

pub fn size(&self) -> usize

Counts and returns the number of recorded set or clear operations.

pub fn has_patches(&self) -> bool

Indicates whether any operations have been recorded in this batch.

pub fn just_set(&mut self, position: IVec3, voxel: T) -> bool

Records a voxel set or clear operation at the specified 3D position. Returns true indicating that the state has changed.

Arguments

• position - 3D coordinates of the voxel to modify.
• voxel - The voxel value to set; T::default() clears the voxel.

Panics

Panics if position is out of bounds for the configured max_depth.

Trait Implementations

impl<T: Debug + VoxelTrait> Debug for Batch<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: VoxelTrait> VoxOpsWrite<T> for Batch<T>

fn set( &mut self, _interner: &mut VoxInterner<T>, position: IVec3, voxel: T, ) -> bool

Records a set or clear operation for the given position, delegating to just_set. Records a voxel set or clear operation at the specified 3D position. Returns true indicating that the state has changed.

Arguments

• position - 3D coordinates of the voxel to modify.
• voxel - The voxel value to set; T::default() clears the voxel.

Panics

Panics if position is out of bounds for the configured max_depth.

fn fill(&mut self, interner: &mut VoxInterner<T>, value: T)

Clears existing operations and sets a uniform fill value for the batch.

fn clear(&mut self, _interner: &mut VoxInterner<T>)

Resets all recorded operations, clearing masks, values, and fill state.