Struct Sprite 

pub struct Sprite {
    pub kv6: Kv6,
    pub p: [f32; 3],
    pub s: [f32; 3],
    pub h: [f32; 3],
    pub f: [f32; 3],
    pub flags: u32,
    pub material: u8,
    pub alpha_mul: u8,
    pub material_map: Vec<(u32, u8)>,
}

A KV6 voxel sprite positioned in world space.

Mirror of voxlap’s vx5sprite for the kv6 case (flags & SPRITE_FLAG_KFA == 0; see SPRITE_FLAG_KFA). Owns its Kv6 by value. p / s / h / f are voxlap’s per-axis world-space basis: s is the kv6.xsiz direction, h the ysiz direction, f the zsiz direction. For an axis-aligned sprite, s = [1,0,0], h = [0,1,0], f = [0,0,1].

Fields

kv6: Kv6

Voxel data + bounding-box pivots. Loaded from a .kv6 file via crate::kv6::parse or built procedurally.

p: [f32; 3]

World-space position of the sprite’s pivot (xpiv, ypiv, zpiv inside the kv6 maps to this point).

s: [f32; 3]

World-space basis vector for the kv6’s local +x. Length scales the sprite along that axis (typically 1.0 for unit-scale).

h: [f32; 3]

World-space basis vector for the kv6’s local +y.

f: [f32; 3]

World-space basis vector for the kv6’s local +z.

flags: u32

Voxlap-style flags bitfield. See SPRITE_FLAG_NO_SHADING, SPRITE_FLAG_KFA, SPRITE_FLAG_INVISIBLE, SPRITE_FLAG_NO_Z.

material: u8

Voxel-material id (TV stage) applied uniformly to this sprite’s voxels — indexes the renderer’s global MaterialTable for opacity + blend mode. 0 (the default) is opaque, so an un-set sprite renders exactly as before. See PORTING-TRANSPARENCY.md.

alpha_mul: u8

Per-instance opacity multiplier (TV stage), 0..=255 (255 = unscaled, the default). Scales the material’s alpha so an effect can fade out by cheap per-frame updates without re-uploading its volume.

material_map: Vec<(u32, u8)>

Per-voxel material colour map (TV.3): (rgb, material_id) pairs that classify this model’s voxels into materials by colour — a mixed model (opaque frame + glass, bottle + potion). Empty (the default) means the whole sprite uses material uniformly (the TV.1 path). See crate::material::material_for_color.

Implementations

impl Sprite

pub fn axis_aligned(kv6: Kv6, pos: [f32; 3]) -> Sprite

Convenience constructor for an axis-aligned sprite at world position pos. Basis is identity, flags = 0 (kv6 + normal shading + visible + z-tested).

Examples

use roxlap_formats::kv6::Kv6;
use roxlap_formats::sprite::Sprite;

// ... after `let kv6 = kv6::parse(&bytes)?;` or similar:
let sprite = Sprite::axis_aligned(kv6, [1024.0, 1024.0, 100.0]);
assert_eq!(sprite.flags, 0);
assert_eq!(sprite.s, [1.0, 0.0, 0.0]);

pub fn casts_shadow(&self) -> bool

XS.4 — whether this sprite casts a hard shadow (the dynamic-lighting stage decides it darkens terrain / other sprites). true unless SPRITE_FLAG_NO_SHADOW_CAST is set.

pub fn receives_shadow(&self) -> bool

XS.4 — whether this sprite receives hard shadows (is darkened by occluders). true unless SPRITE_FLAG_NO_SHADOW_RECEIVE is set.

pub fn with_casts_shadow(self, casts: bool) -> Sprite

XS.4 — set whether this sprite casts a hard shadow (clears/sets SPRITE_FLAG_NO_SHADOW_CAST). Returns self for chaining.

pub fn with_receives_shadow(self, receives: bool) -> Sprite

XS.4 — set whether this sprite receives hard shadows (clears/sets SPRITE_FLAG_NO_SHADOW_RECEIVE). Returns self for chaining.

pub fn carve_sphere_with_colfunc<S, C>( &mut self, centre: [i32; 3], radius: u32, solid: S, colfunc: C, )

where S: Fn(i32, i32, i32) -> bool, C: Fn(i32, i32, i32) -> u32,

Carve a sphere out of this sprite’s voxel model, controlling the colour of the interior the cut exposes. Thin delegate to Kv6::carve_sphere_with_colfunc — centre / radius, solid, and colfunc are all in kv6-local voxel coordinates (the sprite pose p/s/h/f is untouched). See that method for why the solid occupancy predicate is required.

Trait Implementations

impl Clone for Sprite

fn clone(&self) -> Sprite

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sprite

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

Formats the value using the given formatter.