Skip to main content

Volume

Struct Volume 

Source
pub struct Volume {
    pub thickness: f32,
    pub thickness_texture: Option<TextureRef>,
    pub attenuation_distance: Option<f32>,
    pub attenuation_color: [f32; 3],
}
Expand description

KHR_materials_volume parameters: turns the surface from an infinitely thin wall into the boundary of a homogeneous absorbing medium. Light travelling through the medium is attenuated towards attenuation_color over attenuation_distance. Requires a manifold mesh and is typically paired with a non-zero Transmission / MaterialExt::ior.

Fields§

§thickness: f32

Thickness of the volume beneath the surface in the mesh’s coordinate space (thicknessFactor). Default 0.0 — thin-walled, i.e. the extension has no effect until thickness is positive. Multiplied by the green channel of thickness_texture.

§thickness_texture: Option<TextureRef>

Thickness texture (thicknessTexture), G channel.

§attenuation_distance: Option<f32>

Average distance light travels in the medium before interacting with a particle, in world space (attenuationDistance). The spec default is +Infinity (no absorption); represented here as None so the special “infinite” case stays distinct from a finite distance. See effective_attenuation_distance.

§attenuation_color: [f32; 3]

Colour white light turns into after travelling attenuation_distance through the medium (attenuationColor), linear RGB. Default [1,1,1] (no tint).

Implementations§

Source§

impl Volume

Source

pub fn effective_attenuation_distance(&self) -> f32

The effective attenuation distance — the stored value when finite, else f32::INFINITY (the spec default).

Trait Implementations§

Source§

impl Clone for Volume

Source§

fn clone(&self) -> Volume

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 Copy for Volume

Source§

impl Debug for Volume

Source§

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

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

impl Default for Volume

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for Volume

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Volume

Auto Trait Implementations§

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> 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 = !

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.