Struct SHLight

#[repr(C)]
pub struct SHLight {
    pub dir_to: Vec3,
    pub color: Color128,
}

A light source used for creating SphericalHarmonics data. https://stereokit.net/Pages/StereoKit/SHLight.html

see SphericalHarmonics see also crate::tex::SHCubemap

Examples

use stereokit_rust::{maths::Vec3, tex::SHCubemap, util::{SHLight, named_colors, Color128}};

let light0 = SHLight::new([1.0, 0.2, 0.3], named_colors::RED);
let light1 = SHLight::new(Vec3::new(1.0, 0.2, 0.3), Color128::new(1.0, 0.0, 0.0, 1.0));
let light2 = SHLight{ dir_to: Vec3::new(1.0, 0.2, 0.3), color: named_colors::RED.into()};

assert_eq!(light0, light1);
assert_eq!(light1, light2);

Fields

dir_to: Vec3

Direction to the light source.

color: Color128

Color of the light in linear space! Values here can exceed 1.

Implementations

impl SHLight

pub fn new(dir_to: impl Into<Vec3>, color: impl Into<Color128>) -> Self

A basic constructor for SHLight. https://stereokit.net/Pages/StereoKit/SHLight.html

• dir_to - Direction to the light source.
• color - Color of the light in linear space! Values here can exceed 1.

Trait Implementations

impl Clone for SHLight

fn clone(&self) -> SHLight

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SHLight

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

Formats the value using the given formatter.

impl PartialEq for SHLight

fn eq(&self, other: &SHLight) -> 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 SHLight

impl StructuralPartialEq for SHLight