Skip to main content

SpriteLighting

Struct SpriteLighting 

Source
pub struct SpriteLighting<'a> {
    pub kv6col: u32,
    pub lightmode: u32,
    pub lights: &'a [LightSrc],
}
Expand description

Sprite lighting + colour state — the subset of voxlap’s vx5 global that updatereflects reads. Built once per frame from Engine state and passed to draw_sprite.

All fields mirror voxlap names:

  • kv6colvx5.kv6col
  • lightmodevx5.lightmode
  • lightsvx5.lightsrc[0..vx5.numlights]

The vx5.fogcol/ofogdist fog plumbing is deferred — sprite fog stays off for now, matching the oracle path (vx5.fogcol < 0ofogdist == -1 in voxlap C, no fog).

Fields§

§kv6col: u32

Material colour. R==G==B triggers the cheaper nolighta path in update_reflects; arbitrary RGB takes the per-channel nolightb path; lightmode≥2 ignores the R==G==B fast path and always does per-channel modulation.

§lightmode: u32

0 / 1 → directional surface tint (lightmode<2 paths). 2 → per-light shadow-side modulation against lights.

§lights: &'a [LightSrc]

Active point lights — voxlap’s vx5.lightsrc[..vx5.numlights]. Empty for lightmode<2; populated for lightmode≥2.

Implementations§

Source§

impl<'a> SpriteLighting<'a>

Source

pub fn from_engine(engine: &'a Engine) -> Self

Snapshot the lighting + colour subset of an Engine. Use this once per frame in the host so the sprite render reflects engine setters made between frames.

Source§

impl SpriteLighting<'static>

Source

pub fn default_oracle() -> Self

Default oracle config — grey kv6col, lightmode 0, no lights. Used by roxlap-oracle so the four sprite golden hashes stay byte-stable: this is the exact state voxlap C’s oracle has when it calls drawsprite.

Trait Implementations§

Source§

impl<'a> Clone for SpriteLighting<'a>

Source§

fn clone(&self) -> SpriteLighting<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for SpriteLighting<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Copy for SpriteLighting<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for SpriteLighting<'a>

§

impl<'a> RefUnwindSafe for SpriteLighting<'a>

§

impl<'a> Send for SpriteLighting<'a>

§

impl<'a> Sync for SpriteLighting<'a>

§

impl<'a> Unpin for SpriteLighting<'a>

§

impl<'a> UnsafeUnpin for SpriteLighting<'a>

§

impl<'a> UnwindSafe for SpriteLighting<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.