Struct three_d::renderer::light::AmbientLight

pub struct AmbientLight {
    pub intensity: f32,
    pub color: Color,
    pub environment: Option<Environment>,
}

A light which shines on all surfaces. Can be uniform (a light that shines equally on any surface) or calculated from an environment map using the Environment struct.

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.

environment: Option<Environment>

The light shining from the environment. This is calculated based on an environment map.

Implementations

impl AmbientLight

pub fn new(
    _context: &Context,
    intensity: f32,
    color: Color
) -> ThreeDResult<Self>

Constructs an ambient light that shines equally on all surfaces.

pub fn new_with_environment(
    context: &Context,
    intensity: f32,
    color: Color,
    environment_map: &TextureCubeMap
) -> ThreeDResult<Self>

Constructs an ambient light that shines based on the given environment map.

Trait Implementations

impl Default for AmbientLight

fn default() -> Self

Returns the “default value” for a type.

impl Light for AmbientLight

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.