Struct SpriteVisual 

pub struct SpriteVisual(/* private fields */);

A visual that paints its size with a composition brush and casts a shadow (WinUI Microsoft.UI.Composition.SpriteVisual): the shadow of its rectangle, then the brush over (0, 0, size), then its children.

The brush is any CompositionBrush: the colour and gradient brushes fill the rectangle, a CompositionSurfaceBrush lays out its surface in it. A change of the brush or of the shadow, an animation included, redraws the visual.

Unlike the other visuals of the compositor, a sprite visual does not clip to its bounds when it is created (clip_to_bounds is false), as a WinUI visual: its shadow and its children may extend beyond its size.

Implementations

impl SpriteVisual

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

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

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

The visual as a composition visual.

pub fn brush(&self) -> Option<Rc<CompositionBrush>>

The brush the visual paints its size with.

pub fn set_brush(&self, value: Option<Rc<CompositionBrush>>)

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

The shadow of the visual.

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

Trait Implementations

impl Clone for SpriteVisual

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Deref for SpriteVisual

type Target = Rc<CompositionVisual>

The resulting type after dereferencing.

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

Dereferences the value.