Struct ClipFlipbook 

pub struct ClipFlipbook { /* private fields */ }

CPU-side decoded animated voxel clip: every frame’s SpriteDense is cached at construction, so per-frame playback is a grid select — not the per-frame voxel-volume decode draw_sprite_dda pays each call. The CPU counterpart to the GPU flipbook (VCL.2). Build once from a DecodedClip, then draw_frame the active frame each render.

Implementations

impl ClipFlipbook

pub fn empty() -> Self

An empty flipbook (no frames) — a tombstone for a removed clip; draw_frame always draws nothing.

pub fn from_decoded(clip: &DecodedClip) -> Self

Decode + cache every frame of clip (one SpriteDense each).

pub fn from_decoded_with_materials( clip: &DecodedClip, material_map: &[(u32, u8)], ) -> Self

Like from_decoded but classifies every frame’s voxels into per-voxel material ids by colour (TV.3 mixed models) via material_map — the clip analogue of SpriteDense::from_kv6_with_materials. An empty map yields the same all-opaque result as from_decoded.

pub fn frame_count(&self) -> usize

pub fn frame(&self, frame: usize) -> Option<&SpriteDense>

Borrow frame frame’s cached dense grid, if in range.

pub fn set_frame(&mut self, frame: usize, dense: SpriteDense) -> bool

Replace one frame’s cached dense grid in place — the CPU side of an editor’s single-frame edit (no re-decode of the other frames). Returns false if frame is out of range.

pub fn draw_frame( &self, fb: &mut [u32], zb: &mut [f32], pitch_pixels: usize, width: u32, height: u32, cam: &CameraState, settings: &OpticastSettings, frame: usize, pos: [f32; 3], s: [f32; 3], h: [f32; 3], f: [f32; 3], flags: u32, ) -> u32

Draw frame frame at a world pose via draw_sprite_dense — pos is the world pivot, s/h/f the model→world basis columns. Returns pixels written (0 if frame is out of range).

pub fn draw_frame_shaded( &self, fb: &mut [u32], zb: &mut [f32], pitch_pixels: usize, width: u32, height: u32, cam: &CameraState, settings: &OpticastSettings, frame: usize, pos: [f32; 3], s: [f32; 3], h: [f32; 3], f: [f32; 3], flags: u32, shade_ctx: Option<SpriteShade<'_>>, ) -> u32

Draw frame frame, optionally with a translucent material (TV stage) — the draw_sprite_dense_shaded counterpart of draw_frame. shade_ctx == None (or an opaque effective material) renders the frame opaque, unchanged.