Struct ServerDropShadow 

pub struct ServerDropShadow { /* private fields */ }

The server-side counterpart of a DropShadow.

The shadow of the rectangle of a visual is the box shadow of the drawing context. The shadow of an alpha (a Mask brush, or the content of the visual with the InheritFromVisualContent source policy) is drawn by render_shadow_of the same way on every backend that has effects: the source, coloured by the shadow, offset and blurred.

Implementations

impl ServerDropShadow

pub fn new(compositor: &Rc<ServerCompositor>) -> Rc<ServerDropShadow>

Creates the shadow, active: the UI-thread shadow activates its server object when it is created.

pub fn props(&self) -> &ServerDropShadowProps

The properties of the shadow.

pub fn is_disposed(&self) -> bool

pub fn effective_color(&self) -> Color

The colour of the shadow with its opacity in the alpha.

pub fn plane_offset(&self, visual: Option<&ServerCompositionVisual>) -> Vector

The offset of the shadow in the plane of visual: the X and Y of Offset, and its Z as the renderers project that depth for the visual (ServerCompositionVisual::depth_offset); without a visual the X and Y alone.

pub fn box_shadow_in( &self, visual: Option<&ServerCompositionVisual>, ) -> BoxShadow

The shadow of the rectangle of visual as a box shadow: offset, blur radius, and the colour with the opacity of the shadow in its alpha.

pub fn box_shadow(&self) -> BoxShadow

box_shadow_in without a visual.

pub fn box_shadows_in( &self, visual: Option<&ServerCompositionVisual>, ) -> BoxShadows

The box shadows the shadow draws under a rectangle of visual: empty when the shadow is invisible.

pub fn box_shadows(&self) -> BoxShadows

box_shadows_in without a visual.

pub fn bounds_in( &self, visual: Option<&ServerCompositionVisual>, rect: Rect, ) -> Rect

The area the shadow of rect of visual covers, together with rect: the rectangle moved by the offset and grown by the blur radius. The shadow of an alpha inside rect stays inside it too.

pub fn bounds(&self, rect: Rect) -> Rect

bounds_in without a visual.

pub fn is_visible(&self) -> bool

Whether the shadow is drawn at all: its colour and opacity leave some alpha.

pub fn inherits_from_visual_content(&self) -> bool

Whether the shadow takes the alpha of the content of its visual (SourcePolicy InheritFromVisualContent), which wins over the mask.

pub fn effective_mask(&self) -> Option<Rc<dyn IServerObject>>

The mask that shapes the shadow: the Mask brush, unless the shadow takes the alpha of the content of its visual.

pub fn render_under_rect( &self, canvas: &mut dyn IDrawingContextImpl, rect: Rect, )

Draws the shadow of a sprite or layer visual whose area is rect, outside the plane of any visual: render_under_rect_in without a visual.

pub fn render_with_content( &self, canvas: &mut dyn IDrawingContextImpl, rect: Rect, paint: impl FnOnce(&mut dyn IDrawingContextImpl), ) -> bool

Draws the content of a visual whose area is rect (paint) with the shadow of the alpha of that content under it, through a drop shadow effect of the drawing context: the InheritFromVisualContent source policy. Returns false, drawing nothing, when the drawing context has no effects; the caller then draws the shadow with render_under_rect and the content itself.

pub fn render_under_rect_in( &self, canvas: &mut dyn IDrawingContextImpl, visual: Option<&ServerCompositionVisual>, rect: Rect, )

Draws the shadow of a sprite or layer visual whose area is rect, without the content of the visual: the shadow of the alpha of the mask when there is one (render_shadow_of), otherwise the box shadow of the rectangle. Nothing for an invisible shadow or an empty rectangle.

Deviation (winui-composition.md): without effects in the drawing context, the shadow of a mask is the box shadow of the rectangle.

pub fn render_shadow_of( &self, canvas: &mut dyn IDrawingContextImpl, visual: Option<&ServerCompositionVisual>, rect: Rect, paint: impl FnOnce(&mut dyn IDrawingContextImpl), ) -> bool

Draws the shadow of the alpha of what paint draws inside rect (a mask brush, the brush of a sprite visual, the image of a mask): that alpha in the colour of the shadow, moved by its offset and blurred by its blur radius, and nothing of the source itself. Returns false, drawing nothing, when the drawing context has no effects or there is no render interface for the bitmap of the colour; the caller then draws the box shadow of the rectangle.

Inside a blur effect, the source is painted into a layer at the offset of the shadow and a bitmap of the colour of the shadow is drawn over it with source-in blending, which keeps the colour where the source has alpha, in the proportion of that alpha: the operations every drawing context with effects has, so Skia and Vello draw the same shadow.

Trait Implementations

impl IAnimatedServerObject for ServerDropShadow

fn server_object(&self) -> &ServerObject

The embedded ServerObject part.

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

The composition property with the given name, if the class has one.

fn as_server_object_dyn(&self) -> &dyn IServerObject

The object as the base contract (an explicit upcast).

fn read_property_variant( &self, property: &'static CompositionProperty, ) -> ExpressionVariant

Reads a property of the object as a variant. The default reads the field through CompositionProperty::get_variant; an object with dynamic properties (a property set) reads its own storage.

fn write_property_variant( &self, property: &'static CompositionProperty, value: ExpressionVariant, )

Writes a variant into a property of the object without notification (what an animation does with the value it evaluated). The default writes the field through CompositionProperty::set_variant; an object with dynamic properties writes its own storage.

impl IServerAnimatedPropertyHost for ServerDropShadow

fn set_animated_value( &self, property: &'static CompositionProperty, current_value: ExpressionVariant, committed_at: Duration, animation: Rc<dyn IAnimationInstance>, )

SetAnimatedValue(prop, ref field, committedAt, animation): starts animation on the property. current_value is the value of the field as a variant; the animation writes the field through CompositionProperty::set_variant.

fn remove_animation_for_property(&self, property: &'static CompositionProperty)

The tail of SetAnimatedValue(prop, out field, value): the field has been assigned directly, so the animation of the property, if any, is removed.

fn notify_animated_value_changed(&self, _property: &'static CompositionProperty)

An animation wrote a new value into the field of property.

impl IServerObject for ServerDropShadow

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

Reads the changes of the object from a batch.

fn values_invalidated(&self)

Called after a group of values of the object changed.

fn dispose(&self)

Releases the object: it has been disposed on the UI thread.

fn as_render_resource(self: Rc<Self>) -> Option<Rc<dyn IServerRenderResource>>

The object as a render resource, if it is one.

fn as_animated(self: Rc<Self>) -> Option<Rc<dyn IAnimatedServerObject>>

The object as an animatable object, if it is one.

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

The generated property block of the given type embedded in the object, if it has one. A class that embeds generated properties forwards to their find_props; composition properties locate their fields through it.

fn as_any(&self) -> &dyn Any

fn into_any_rc(self: Rc<Self>) -> Rc<dyn Any>

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

Applies the changes of the object from a batch.

fn as_brush(self: Rc<Self>) -> Option<Rc<dyn IBrush>>

The object as a brush, if it is a server-side brush.

fn as_pen(self: Rc<Self>) -> Option<Rc<dyn IPen>>

The object as a pen, if it is a server-side pen.

fn as_render_data_geometry( self: Rc<Self>, ) -> Option<Rc<dyn IRenderDataGeometry>>

The object as a geometry usable by render data, if it is a server-side geometry.

fn as_transform(self: Rc<Self>) -> Option<Rc<dyn ITransform>>

The object as a transform, if it is a server-side transform.

fn as_gradient_stop(self: Rc<Self>) -> Option<Rc<dyn IGradientStop>>

The object as a gradient stop, if it is a server-side gradient stop.

fn as_surface(self: Rc<Self>) -> Option<Rc<dyn IServerCompositionSurface>>

The object as a composition surface, if it is one.

impl IServerPropertyHost for ServerDropShadow

fn server_compositor(&self) -> Option<Rc<ServerCompositor>>

The compositor of the object, while it is alive. Used to resolve the server objects a batch refers to.

fn set_value( &self, _property: &'static CompositionProperty, change: ServerValueChange<'_>, )

SetValue(prop, ref field, value) as the class of the object defines it. A plain server object assigns; an animated object also invalidates the subscriptions of the property; a render resource goes through super::ServerRenderResourceCore::set_value.

impl IServerRenderResource for ServerDropShadow

fn add_observer(&self, observer: &Rc<dyn IServerRenderResourceObserver>)

fn remove_observer(&self, observer: &Rc<dyn IServerRenderResourceObserver>)

fn queued_invalidate(&self)

impl IServerRenderResourceHost for ServerDropShadow

fn compositor(&self) -> Option<Rc<ServerCompositor>>

The compositor of the resource, while it is alive.

fn as_render_resource_rc(&self) -> Option<Rc<dyn IServerRenderResource>>

The resource as a shared handle, for the invalidation queue.

fn resource_property_changed(&self)

Called once per group of property changes, before the queued invalidation.

impl IServerRenderResourceObserver for ServerDropShadow

fn dependency_queued_invalidate(&self, _sender: &dyn IServerRenderResource)

impl ServerDropShadowHooks for ServerDropShadow

fn deserialize_changes_extra(&self, _reader: &mut BatchStreamReader<'_>)

fn on_fields_deserialized(&self, _changed: DropShadowChangedFields)

fn on_mask_changed(&self)

fn on_mask_changing(&self)

fn on_source_policy_changed(&self)

fn on_source_policy_changing(&self)