Struct CompositionVisualSurface 

pub struct CompositionVisualSurface { /* private fields */ }

A live image of the subtree of a visual, shown by a surface brush (WinUI Microsoft.UI.Composition.CompositionVisualSurface).

The surface shows the area (source_offset, source_size) of source_visual, in the coordinates of the source; a zero source_size is the size of the source visual. The subtree is rendered as a bitmap cache renders it: the visibility, opacity, transform and clip of the source visual itself are ignored, so a hidden source still shows (the connected animation hides its elements and shows them through visual surfaces). Changes of the subtree are followed while the source is attached to a composition target.

Implementations

impl CompositionVisualSurface

pub fn compositor(&self) -> &Rc<Compositor>

pub fn object(&self) -> &CompositionObject

The embedded CompositionObject.

pub fn server(&self) -> ServerObjectId

The id of the server-side surface.

pub fn is_disposed(&self) -> bool

pub fn dispose(&self)

pub fn props(&self) -> &CompositionVisualSurfaceProps

The generated properties of the surface.

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

The visual whose subtree the surface shows.

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

pub fn source_offset(&self) -> Vector

The top left corner of the area shown, in the coordinates of the source visual (WinUI Vector2; animatable as SourceOffset).

pub fn set_source_offset(&self, value: Vector)

pub fn source_size(&self) -> Vector

The size of the area shown; zero for the size of the source visual (WinUI Vector2; animatable as SourceSize).

pub fn set_source_size(&self, value: Vector)

pub fn freeze(&self)

Freezes the surface: the frame that applies the next batch renders the source into an offscreen layer once, and the surface shows that image from then on, whatever happens to the source.

Not a public member in WinUI, where the connected animation freezes its snapshot surface internally. Best effort: the image is rendered with the bounds of the source subtree as of the last rendered frame.

Trait Implementations

impl AsCompositionObject for CompositionVisualSurface

fn as_composition_object(&self) -> &CompositionObject

The embedded CompositionObject.

fn composition_type_name(&self) -> &'static str

The name of the class of the object, for messages.

fn as_property_set(self: Rc<Self>) -> Option<Rc<CompositionPropertySet>>

The object as a property set, if it is one (the is CompositionPropertySet test of upstream).

impl CompositionVisualSurfaceHooks for CompositionVisualSurface

InitializeDefaultsExtra activates the server object: done when the server object is created.

fn initialize_defaults_extra(&self)

fn validate_source_visual_change( &self, _old_value: &Option<Rc<dyn ICompositionObject>>, _new_value: &Option<Rc<dyn ICompositionObject>>, )

fn on_source_visual_changed(&self)

fn on_source_visual_changing(&self)

fn validate_source_offset_change(&self, _old_value: Vector, _new_value: Vector)

fn on_source_offset_changed(&self)

fn on_source_offset_changing(&self)

fn validate_source_size_change(&self, _old_value: Vector, _new_value: Vector)

fn on_source_size_changed(&self)

fn on_source_size_changing(&self)

impl ICompositionObject for CompositionVisualSurface

fn server(&self) -> ServerObjectId

The id of the server-side counterpart of the object.

fn as_any(&self) -> &dyn Any

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

impl ICompositionObjectAnimations for CompositionVisualSurface

fn try_start_animation( &self, property_name: &str, animation: &dyn ICompositionAnimation, final_value: Option<ExpressionVariant>, ) -> bool

StartAnimation(propertyName, animation, finalValue) of the class: returns false for a property the class does not know.

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

The composition property with the given name.

fn composition_object(&self) -> &CompositionObject

The embedded CompositionObject.

fn start_animation( &self, property_name: &str, animation: &dyn ICompositionAnimation, )

Connects an animation with the named property of the object and starts the animation.

fn start_animation_with_final_value( &self, property_name: &str, animation: &dyn ICompositionAnimation, final_value: Option<ExpressionVariant>, )

See start_animation. property_name may name a sub-channel of a vector property (Offset.X, Scale.XY, components X, Y, Z, W in any case): the animation then animates a value of the sub-channel’s type (a scalar for one component, a Vector2 for two, …) and leaves the other components alone. Several sub-channels of one property run together; an animation of the whole property replaces them.

fn start_animation_with_controller( &self, property_name: &str, animation: &dyn ICompositionAnimation, controller: &Rc<AnimationController>, )

StartAnimation(propertyName, animation, animationController): starts the animation under controller, which can pause, resume, scrub and speed it up. property_name may name a sub-channel, as for start_animation.

fn try_get_animation_controller( &self, property_name: &str, ) -> Option<Rc<AnimationController>>

The controller of the animation of the named property (TryGetAnimationController): the controller it was started with, or a new controller that takes the running animation over. None when no animation was started on the property through this object, or it was stopped.

fn stop_animation(&self, property_name: &str)

Disconnects an animation from the named property and stops it, applying its stop behavior. property_name may name a sub-channel (Offset.X): the animations of the sub-channels that share a component with it are stopped.

fn start_animation_group(&self, grp: &dyn ICompositionAnimationBase)

Starts an animation group. The StartAnimationGroup method on CompositionObject lets you start CompositionAnimationGroup. All the animations in the group will be started at the same time on the object.

fn start_animation_group_part( &self, animation: &dyn ICompositionAnimation, target: &str, final_value: ExpressionVariant, ) -> bool

StartAnimationGroupPart.

fn start_animation_group_for( &self, grp: &dyn ICompositionAnimationBase, target: &str, final_value: ExpressionVariant, ) -> bool

Starts an animation or an animation group triggered by the change of property target to final_value. Returns whether one of the animations targets that property.

fn stop_animation_group(&self, grp: &dyn ICompositionAnimationBase)

Stops an animation group.

impl ICompositionObjectHost for CompositionVisualSurface

fn server(&self) -> ServerObjectId

The id of the server-side counterpart of the object.

fn pending_animations(&self) -> &PendingAnimations

The animations waiting to be sent with the next batch.

fn implicit_animation( &self, property_name: &str, ) -> Option<Rc<dyn ICompositionAnimationBase>>

The implicit animation attached to a property of the object, if there is one (ImplicitAnimations?.TryGetValue(name)).

fn start_animation_group( &self, grp: &Rc<dyn ICompositionAnimationBase>, target: &str, final_value: ExpressionVariant, ) -> bool

Starts an animation or an animation group triggered by the change of property target to final_value. Returns whether one of the animations targets that property.

impl ICompositionSurface for CompositionVisualSurface

impl ICompositorSerializable for CompositionVisualSurface

fn try_get_server(&self, c: &Compositor) -> Option<ServerObjectId>

The server-side counterpart of the object on compositor c, if it has one.

fn serialize_changes(&self, c: &Compositor, writer: &mut BatchStreamWriter<'_>)

Writes the pending changes of the object for compositor c.

fn serialization_key(&self) -> *const ()

The identity of the object, by which a compositor avoids queueing it twice. The default is the address of the implementing value; an adapter around an object returns the identity of that object.

fn prepare_serialization(&self, _c: &Compositor)

Called before the changes of the object are written for compositor c.

impl IRegisterForSerialization for CompositionVisualSurface

fn register_for_serialization(&self)