Struct three_d::renderer::light::SpotLight

pub struct SpotLight {
    pub intensity: f32,
    pub color: Color,
    pub position: Vec3,
    pub direction: Vec3,
    pub cutoff: Radians,
    pub attenuation: Attenuation,
    /* private fields */
}

A light which shines from the given position and in the given direction. The light will cast shadows if you generate a shadow map.

Fields

intensity: f32

The intensity of the light. This allows for higher intensity than 1 which can be used to simulate high intensity light sources like the sun.

color: Color

The base color of the light.

position: Vec3

The position of the light.

direction: Vec3

The direction the light shines.

cutoff: Radians

The cutoff angle for the light.

attenuation: Attenuation

The Attenuation of the light.

Implementations

impl SpotLight

pub fn new(
    context: &Context,
    intensity: f32,
    color: Color,
    position: &Vec3,
    direction: &Vec3,
    cutoff: impl Into<Radians>,
    attenuation: Attenuation
) -> ThreeDResult<SpotLight>

Constructs a new spot light.

pub fn set_color(&mut self, color: Color)

👎 Deprecated

pub fn color(&self) -> Color

👎 Deprecated

pub fn set_intensity(&mut self, intensity: f32)

👎 Deprecated

pub fn intensity(&self) -> f32

👎 Deprecated

pub fn set_attenuation(&mut self, attenuation: Attenuation)

👎 Deprecated

pub fn attenuation(&self) -> Attenuation

👎 Deprecated

pub fn set_position(&mut self, position: &Vec3)

👎 Deprecated

pub fn position(&self) -> Vec3

👎 Deprecated

pub fn set_cutoff(&mut self, cutoff: impl Into<Radians>)

👎 Deprecated

pub fn cutoff(&self) -> Radians

👎 Deprecated

pub fn set_direction(&mut self, direction: &Vec3)

👎 Deprecated

pub fn direction(&self) -> Vec3

👎 Deprecated

pub fn clear_shadow_map(&mut self)

Clear the shadow map, effectively disable the shadow. Only necessary if you want to disable the shadow, if you want to update the shadow, just use SpotLight::generate_shadow_map.

pub fn generate_shadow_map(
    &mut self,
    texture_size: u32,
    geometries: &[&dyn Geometry]
) -> ThreeDResult<()>

Generate a shadow map which is used to simulate shadows from the spot light onto the geometries given as input. It is recomended that the texture size is power of 2. If the shadows are too low resolution (the edges between shadow and non-shadow are pixelated) try to increase the texture size.

pub fn shadow_map(&self) -> Option<&DepthTargetTexture2D>

Returns a reference to the shadow map if it has been generated.

Trait Implementations

impl Light for SpotLight

fn shader_source(&self, i: u32) -> String

The fragment shader source for calculating this lights contribution to the color in a fragment. It should contain a function with this signature vec3 calculate_lighting{}(vec3 surface_color, vec3 position, vec3 normal, vec3 view_direction, float metallic, float roughness, float occlusion) Where {} is replaced with the number i given as input. This function should return the color contribution for this light on the surface with the given surface parameters.

fn use_uniforms(&self, program: &Program, i: u32) -> ThreeDResult<()>

Should bind the uniforms that is needed for calculating this lights contribution to the color in Light::shader_source.