Struct amethyst_rendy::light::PointLight

#[repr(C)]
pub struct PointLight {
    pub color: Srgb,
    pub intensity: f32,
    pub radius: f32,
    pub smoothness: f32,
}

A point light source. Uses the Transform set of components for positioning.

Lighting calculations are based off of the Frostbite engine's lighting, which is explained in detail here in this presentation. Below is equation 26, which we used for the lighting evaluation.

The Point properties below map like so:

• I = intensity
• lightRadius = radius
• n = smoothness

Fields

color: Srgb

Color of the light in SRGB format.

intensity: f32

Brightness of the light source, in lumens.

radius: f32

Maximum radius of the point light's affected area.

smoothness: f32

Smoothness of the light-to-dark transition from the center to the radius.

Trait Implementations

impl Default for PointLight

fn default() -> Self

Returns the "default value" for a type.

impl Clone for PointLight

fn clone(&self) -> PointLight

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<PointLight> for PointLight

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl From<PointLight> for Light

fn from(pt: PointLight) -> Self

Performs the conversion.

impl Debug for PointLight

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

Formats the value using the given formatter.

impl Serialize for PointLight

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for PointLight where
    PointLight: Default, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.