Skip to main content

LayerVisual

Struct LayerVisual 

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

A container visual whose children are composed into one offscreen layer, which is then drawn with the opacity of the visual and its shadow (WinUI Microsoft.UI.Composition.LayerVisual).

The shadow of a layer visual follows the alpha of the composed children where the drawing context can draw a drop shadow of a layer (the Skia and Vello backends); elsewhere it is the box shadow of the rectangle of the visual, as the shadow of a sprite visual.

The effect (an effect brush) is applied to the composed children: they are the first source parameter of its graph, and the rest of the graph is drawn around them (a blur pushes the blur effect of the drawing context around the layer, a composite draws its other sources under and over it).

Like a sprite visual, a layer visual does not clip to its bounds when it is created (clip_to_bounds is false).

Implementations§

Source§

impl LayerVisual

Source

pub fn from_visual(visual: &Rc<CompositionVisual>) -> Option<LayerVisual>

The handle of visual as a layer visual, if it is one.

Source

pub fn visual(&self) -> &Rc<CompositionVisual>

The visual as a composition visual.

Source

pub fn shadow(&self) -> Option<Rc<DropShadow>>

The shadow of the composed layer.

Source

pub fn set_shadow(&self, value: Option<Rc<DropShadow>>)

Source

pub fn effect(&self) -> Option<CompositionEffectBrush>

Effect: the effect brush applied to the composed children, which are the first source parameter of its graph. (The upstream effect of every visual, an image effect, is visual().effect().)

Source

pub fn set_effect(&self, value: Option<CompositionEffectBrush>)

Trait Implementations§

Source§

impl Clone for LayerVisual

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 LayerVisual

Source§

type Target = Rc<CompositionVisual>

The resulting type after dereferencing.
Source§

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

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.