Skip to main content

PointLight

Struct PointLight 

Source
pub struct PointLight(/* private fields */);
Expand description

A light from a point (WinUI Microsoft.UI.Composition.PointLight): a point of a visual is lit by the cosine of the angle of the light to the visual, weakened by the attenuation of the distance 1 / (constant + linear * d + quadratic * d^2) between the minimum and the maximum cutoff. Every member but CoordinateSpace is animatable.

Implementations§

Source§

impl PointLight

Source

pub fn from_light(light: &Rc<CompositionLight>) -> Option<PointLight>

The handle of light as this class, if it is one.

Source

pub fn props(&self) -> &PointLightProps

The generated properties of the class.

Source§

impl PointLight

Source

pub fn color(&self) -> Color

The colour of the light (default white).

Source

pub fn set_color(&self, value: Color)

Source

pub fn constant_attenuation(&self) -> f32

The constant term of the attenuation (default 1).

Source

pub fn set_constant_attenuation(&self, value: f32)

Source

pub fn linear_attenuation(&self) -> f32

The term of the attenuation proportional to the distance (default 0).

Source

pub fn set_linear_attenuation(&self, value: f32)

Source

pub fn quadratic_attenuation(&self) -> f32

The term of the attenuation proportional to the square of the distance (default 0).

Source

pub fn set_quadratic_attenuation(&self, value: f32)

Source

pub fn coordinate_space(&self) -> Option<Rc<CompositionVisual>>

The visual whose coordinates Offset is in; None for the targeted visual.

Source

pub fn set_coordinate_space(&self, value: Option<Rc<CompositionVisual>>)

Source

pub fn offset(&self) -> Vector3D

The position of the light in its coordinate space; Z is the height above the visuals.

Source

pub fn set_offset(&self, value: Vector3D)

Source

pub fn intensity(&self) -> f32

The intensity of the light (default 1).

Source

pub fn set_intensity(&self, value: f32)

Source

pub fn min_attenuation_cutoff(&self) -> f32

The distance up to which the light is not attenuated (default 0).

Source

pub fn set_min_attenuation_cutoff(&self, value: f32)

Source

pub fn max_attenuation_cutoff(&self) -> f32

The distance beyond which the light lights nothing (default f32::MAX).

Source

pub fn set_max_attenuation_cutoff(&self, value: f32)

Trait Implementations§

Source§

impl Clone for PointLight

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Deref for PointLight

Source§

type Target = Rc<CompositionLight>

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Rc<CompositionLight>

Dereferences the value.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ClassDefaults for T
where T: ?Sized,

Source§

fn static_constructor()

The static constructor of a type: work done once per thread, after the properties of the type are registered and before its first instance exists (class handlers, affects_render, metadata overrides). Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.