Struct SpotLight

pub struct SpotLight {
    pub color: Box<[f32; 3]>,
    pub constant_attenuation: f32,
    pub linear_attenuation: f32,
    pub quadratic_attenuation: f32,
    pub falloff_angle: f32,
    pub falloff_exponent: f32,
}

Describes a spot light source.

The light’s default direction vector in local coordinates is [0,0,-1], pointing down the negative z axis. The actual direction of the light is defined by the transform of the node where the light is instantiated.

The constant_attenuation, linear_attenuation, and quadratic_attenuation are used to calculate the total attenuation of this light given a distance. The equation used is:

A = constant_attenuation + Dist * linear_attenuation + Dist^2 * quadratic_attenuation

The falloff_angle and falloff_exponent are used to specify the amount of attenuation based on the direction of the light.

Fields

color: Box<[f32; 3]>

Contains three floating-point numbers specifying the color of the light.

constant_attenuation: f32

The constant term in the attentuation equation, see SpotLight.

linear_attenuation: f32

The linear term in the attentuation equation, see SpotLight.

quadratic_attenuation: f32

The quadratic term in the attentuation equation, see SpotLight.

falloff_angle: f32

The directional attenuation of the light.

falloff_exponent: f32

A term in the directional attenuation equation of the light.

Implementations

impl SpotLight

pub fn new(color: [f32; 3]) -> Self

Create a new SpotLight with the given color.

Trait Implementations

impl Clone for SpotLight

fn clone(&self) -> SpotLight

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpotLight

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

Formats the value using the given formatter.

impl From<SpotLight> for LightKind

fn from(v: SpotLight) -> Self

Converts to this type from the input type.