Struct VoxelFrame 

pub struct VoxelFrame {
    pub occupancy: Vec<u32>,
    pub colors: Vec<u32>,
    pub color_offsets: Vec<u32>,
}

One fully-reconstructed frame in the dense-column layout. Field shapes are validated against the clip’s dims by VoxelFrame::validate.

Fields

occupancy: Vec<u32>

Per-column occupancy bitmask, dims[0] * dims[1] * occ_words_per_col words. Bit z & 31 of word col * occ_words_per_col + (z >> 5) is set iff voxel (x, y, z) is solid, where col = x + y * dims[0].

colors: Vec<u32>

Voxel colours (voxlap-packed 0x80RRGGBB), ascending z within each column, columns in col order.

color_offsets: Vec<u32>

Prefix sums: color_offsets[col] is the first colour index of column col; length dims[0] * dims[1] + 1.

Implementations

impl VoxelFrame

pub fn from_kv6(kv6: &Kv6) -> VoxelFrame

Build one dense-column VoxelFrame from a .kv6 model — the authoring bridge from a voxel sprite to a clip frame. The frame’s dims are the kv6’s [xsiz, ysiz, zsiz]; the kv6’s pivot + voxel-world-size travel at the clip level (see VoxelClip::from_kv6_frames).

.kv6 already stores surface voxels per (x, y) column in ascending z — the very layout a frame wants — so this is a re-index from the kv6’s x-major column order (x · ysiz + y) to the frame’s col = x + y · xsiz, packing each column’s z’s into the occupancy bitmask. Each column is sorted by z so the colour run is ascending even if the source isn’t strictly ordered; voxels with z >= zsiz are dropped (defensive against malformed input).

pub fn to_kv6(&self, dims: [u32; 3], pivot: [f32; 3]) -> Kv6

Inverse of from_kv6: materialise this frame as a flat-lit .kv6 model (every voxel vis = 63, dir = 0 — voxel clips render full-bright, so per-face normals are unused). dims is the clip bounding box, pivot becomes the kv6 pivot. Lets a single streaming-clip frame drive add_sprite_model / refresh_sprite_model (one model re-uploaded per frame) instead of an N-frame flipbook.

pub fn dirs(&self, dims: [u32; 3]) -> Vec<u32>

Per-voxel surface-normal LUT indices (dir), parallel to colors, recomputed from the occupancy — the same dirs decode caches per frame. The GPU sprite-model upload carries these; lets an in-place frame edit build a model identical to the register path (rather than flat zeros). The frame must be valid for dims.

pub fn validate(&self, dims: [u32; 3]) -> Result<(), FrameError>

Check the field shapes + per-column occupancy/colour agreement for the given clip dims.

Errors

Returns the offending FrameError (wrong array length, broken prefix-sum bounds/monotonicity, or a column whose occupancy popcount disagrees with its colour-run length).

Trait Implementations

impl Clone for VoxelFrame

fn clone(&self) -> VoxelFrame

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VoxelFrame

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

Formats the value using the given formatter.

impl Eq for VoxelFrame

impl PartialEq for VoxelFrame

fn eq(&self, other: &VoxelFrame) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for VoxelFrame