Struct SpotLight 

pub struct SpotLight {
    pub direction: Vec3,
    pub color: LinearRgba,
    pub intensity: f32,
    pub range: f32,
    pub inner_cone_angle: f32,
    pub outer_cone_angle: f32,
    pub shadow_enabled: bool,
    pub shadow_bias: f32,
    pub shadow_normal_bias: f32,
}

A spot light source that emits light in a cone from a single point.

Spot lights are like point lights but restricted to a cone of influence. They’re useful for flashlights, stage lights, and car headlights.

Examples

use khora_core::renderer::light::SpotLight;
use khora_core::math::{Vec3, LinearRgba};

// Create a flashlight
let flashlight = SpotLight {
    direction: Vec3::new(0.0, 0.0, -1.0),
    color: LinearRgba::WHITE,
    intensity: 200.0,
    range: 20.0,
    inner_cone_angle: 15.0_f32.to_radians(),
    outer_cone_angle: 30.0_f32.to_radians(),
    shadow_enabled: false,
    shadow_bias: 0.01,
    shadow_normal_bias: 0.0,
};

Fields

direction: Vec3

The direction the spotlight is pointing (normalized).

color: LinearRgba

The color of the light in linear RGB space.

intensity: f32

The intensity of the light in lumens.

range: f32

The maximum range of the light in world units.

inner_cone_angle: f32

The angle in radians at which the light begins to fall off.

Within this angle from the center of the cone, the light is at full intensity.

outer_cone_angle: f32

The angle in radians at which the light is fully attenuated.

Beyond this angle from the center of the cone, there is no light. The region between inner and outer cone angles has smooth falloff.

shadow_enabled: bool

Whether this light casts shadows.

shadow_bias: f32

Constant bias to apply to depth values to prevent shadow acne.

shadow_normal_bias: f32

Normal-based bias to apply to prevent shadow acne on sloped surfaces.

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<(), Error>

Formats the value using the given formatter.

impl Default for SpotLight

fn default() -> SpotLight

Returns the “default value” for a type.

impl PartialEq for SpotLight

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for SpotLight

impl StructuralPartialEq for SpotLight