Struct LightMap 

pub struct LightMap { /* private fields */ }

The lights that reach a visual, each with the transform from the space of the visual to the space of the light.

Implementations

impl LightMap

pub fn new() -> LightMap

A map without lights.

pub fn add(&mut self, source: LightSource, to_light_space: Matrix)

Adds a light; to_light_space maps the coordinates of the lit visual to those of the coordinate space of the light.

pub fn is_empty(&self) -> bool

Whether the map has no lights.

pub fn lit_at(&self, point: Point, material: &LightingMaterial) -> LightColor

The sum of the lights at point of the lit visual reflected by material, not clamped.

pub fn light_at(&self, point: Point) -> LightColor

The sum of the lights at point of the lit visual, clamped to 0..1.

pub fn size_for(rect: Rect) -> PixelSize

The size of the light map of rect on the grid of 0.4: a cell per LIGHT_MAP_CELL units, at least 2 and at most LIGHT_MAP_MAX_CELLS. The render walk uses size_for_scale.

pub fn size_for_scale(rect: Rect, device_scale: f64) -> PixelSize

The number of samples of the light map of rect along each side, for a visual drawn device_scale device pixels per unit: a sample every LIGHT_MAP_SAMPLE_SPACING device pixels, at least 2 and at most LIGHT_MAP_MAX_SAMPLES.

pub fn factors( &self, rect: Rect, size: PixelSize, material: &LightingMaterial, ) -> Option<MultiplyLayerFactors>

The factors of the multiply layer that lights the content of rect: the light at each sample (reflected by material), over a scale of the brightest channel (at least 1, at most LIGHT_MAP_MAX_SCALE). None when the light is exactly full everywhere, so the layer would change nothing.

pub fn pixels(&self, rect: Rect, size: PixelSize) -> Option<Vec<u8>>

The RGBA pixels (premultiplied, row by row from the top) of the source-atop light map of rect at size (for a drawing context without layer effects): each pixel the LightColor::atop_pixel of the light at the centre of its sample. None when the light is full everywhere, so the map would change nothing.

impl LightMap

pub fn scene_pixels( &self, rect: Rect, size: PixelSize, material: &LightingMaterial, ) -> Vec<u8>

The opaque RGBA pixels (row by row from the top) of the lighting of a scene lighting effect over rect at size: the lights reflected by material, clamped to 1, at the centre of each sample.

Trait Implementations

impl Clone for LightMap

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LightMap

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

Formats the value using the given formatter.

impl Default for LightMap

fn default() -> Self

Returns the “default value” for a type.