Struct ServerLayerVisual 

pub struct ServerLayerVisual { /* private fields */ }

Server-side counterpart of a LayerVisual: its children are composed into an offscreen layer (push_layer over the bounds of the subtree), which the opacity of the visual applies to as a whole.

With a shadow, the children are composed through a drop shadow effect when the drawing context has effects, so the shadow follows the alpha of the composed content; otherwise the box shadow of the rectangle of the visual is drawn under the layer. A shadow with a Mask (and the Default source policy) is the shadow of the alpha of the mask over the rectangle of the visual, drawn under the layer (ServerDropShadow::render_under_rect).

With an effect (an effect brush), the composed children are the first source parameter of its graph: what the graph draws under the layer and what wraps it are drawn and pushed before the children, inside the layer (or the shadow), and popped and drawn after them.

Deviation (winui-composition.md): without effect support in the drawing context the shadow is the box shadow of the rectangle of the visual, as for a sprite visual.

Implementations

impl ServerLayerVisual

pub fn new() -> Self

pub fn props(&self) -> &ServerLayerVisualProps

The properties of the visual.

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

The shadow.

pub fn effect_brush(&self) -> Option<Rc<ServerCompositionEffectBrush>>

The effect brush applied to the composed children (the WinUI Effect).

Trait Implementations

impl Default for ServerLayerVisual

fn default() -> Self

Returns the “default value” for a type.

impl IServerVisualContent for ServerLayerVisual

fn compute_own_content_bounds( &self, visual: &ServerCompositionVisual, ) -> Option<LtrbRect>

The area of the box shadow of the rectangle, when there is a shadow (what the fallback draws); a layer visual has no content of its own.

fn sub_tree_bounds_padding( &self, visual: &ServerCompositionVisual, ) -> Option<Thickness>

The shadow of the composed children extends the subtree as the drop shadow effect does, and the blurs of the effect around the layer as the blur effect does.

fn has_effect(&self, visual: &ServerCompositionVisual) -> bool

A shadow or an effect depends on every change of the subtree, as an effect does.

fn dependency_queued_invalidate(&self, visual: &ServerCompositionVisual)

The shadow or the effect changed.

fn deserialize_changes_core( &self, visual: &ServerCompositionVisual, reader: &mut BatchStreamReader<'_>, committed_at: Duration, )

DeserializeChangesCore of the class; the default is the one of the container visual.

fn size_changed(&self, visual: &ServerCompositionVisual)

fn render_core( &self, visual: &ServerCompositionVisual, context: &mut ServerVisualRenderContext<'_>, _current_transformed_clip: LtrbRect, )

fn render_after_children( &self, visual: &ServerCompositionVisual, context: &mut ServerVisualRenderContext<'_>, )

Called by the render walk after the children of the visual were rendered, before the opacity mask, effect, clips and transform of the visual are popped: what render_core pushed for the children is popped here (not from upstream; the layer of a layer visual).

fn dispose(&self, visual: &ServerCompositionVisual)

The visual has been disposed on the UI thread.

fn find_props(&self, type_id: TypeId) -> Option<&dyn Any>

The generated property block of the given type, if the class has one of its own.

fn get_composition_property( &self, name: &str, ) -> Option<&'static CompositionProperty>

fn as_any(&self) -> &dyn Any

fn on_attached_to_root( &self, _visual: &ServerCompositionVisual, _target: &Rc<ServerCompositionTarget>, )

fn on_detached_from_root( &self, _visual: &ServerCompositionVisual, _target: &Rc<ServerCompositionTarget>, )

fn push_clip_to_bounds( &self, visual: &ServerCompositionVisual, canvas: &mut dyn IDrawingContextImpl, )

fn has_update_pass_content_bounds(&self) -> bool

Whether the bounds of the own content depend on other visuals and are computed again when the update pass of the target reaches the visual (not from upstream; a redirect visual covers the bounds of its source as that pass leaves them).