Struct CompositionVisual 

pub struct CompositionVisual { /* private fields */ }

A node of the composition visual tree.

Implementations

impl CompositionVisual

pub fn rotation_angle_in_degrees(&self) -> f32

The rotation about the rotation axis in degrees: a view of rotation_angle.

Deviation (winui-composition.md): not an animation target of its own; animate RotationAngle.

pub fn set_rotation_angle_in_degrees(&self, value: f32)

pub fn rotation_axis(&self) -> Vector3D

The axis rotation_angle rotates about (default (0, 0, 1); animatable as RotationAxis).

Deviation (winui-composition.md): an axis along Z (or a zero axis) rotates in the plane; any other axis rotates in 3D, of which the 2D renderers show the projection, as for Orientation.

pub fn set_rotation_axis(&self, value: Vector3D)

pub fn relative_offset_adjustment(&self) -> Vector3D

The part of the size of the parent added to the offset: the offset of the visual is Offset + RelativeOffsetAdjustment * parent size (animatable as RelativeOffsetAdjustment; Z is not adjusted, the parent has no depth).

pub fn set_relative_offset_adjustment(&self, value: Vector3D)

pub fn relative_size_adjustment(&self) -> Vector

The part of the size of the parent added to the size: the size of the visual is Size + RelativeSizeAdjustment * parent size (animatable as RelativeSizeAdjustment). (1, 1) with a zero Size makes the visual as large as its parent.

pub fn set_relative_size_adjustment(&self, value: Vector)

pub fn effective_size(&self) -> Vector

The size of the visual with its relative size adjustment applied: what is rendered and hit tested. size is the Size property alone.

pub fn is_hit_test_visible(&self) -> bool

Whether the visual and its subtree take part in hit testing (default true).

pub fn set_is_hit_test_visible(&self, value: bool)

pub fn is_pixel_snapping_enabled(&self) -> bool

Whether the offset of the visual is snapped to device pixels.

Deviation (winui-composition.md): the translation of the transform of the visual relative to its parent is rounded to device pixels of its target, not its position in the window.

pub fn set_is_pixel_snapping_enabled(&self, value: bool)

pub fn border_mode(&self) -> CompositionBorderMode

How the edges of the visual are antialiased. Stored only.

pub fn set_border_mode(&self, value: CompositionBorderMode)

pub fn backface_visibility(&self) -> CompositionBackfaceVisibility

Whether the back of the visual is shown when it is turned in 3D. Stored only.

pub fn set_backface_visibility(&self, value: CompositionBackfaceVisibility)

pub fn composite_mode(&self) -> CompositionCompositeMode

How the visual is blended with what is behind it. Stored only.

pub fn set_composite_mode(&self, value: CompositionCompositeMode)

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

The visual whose coordinate space the transform of this visual is relative to, instead of its parent: the visual is drawn where its parent is, in the place its offset and transform give it inside parent_for_transform.

Deviation (winui-composition.md): the two visuals must be in one tree (otherwise the transform is relative to the parent); clips and opacity still come from the parent chain.

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

impl CompositionVisual

pub fn visible(&self) -> bool

pub fn set_visible(&self, value: bool)

pub fn opacity(&self) -> f32

pub fn set_opacity(&self, value: f32)

pub fn clip(&self) -> Option<Arc<dyn IGeometryImpl>>

The geometry the visual is clipped with.

pub fn set_clip(&self, value: Option<Arc<dyn IGeometryImpl>>)

pub fn clip_to_bounds(&self) -> bool

pub fn set_clip_to_bounds(&self, value: bool)

pub fn offset(&self) -> Vector3D

pub fn set_offset(&self, value: Vector3D)

pub fn translation(&self) -> Vector3D

pub fn set_translation(&self, value: Vector3D)

pub fn size(&self) -> Vector

pub fn set_size(&self, value: Vector)

pub fn anchor_point(&self) -> Vector

pub fn set_anchor_point(&self, value: Vector)

pub fn center_point(&self) -> Vector3D

pub fn set_center_point(&self, value: Vector3D)

pub fn rotation_angle(&self) -> f32

pub fn set_rotation_angle(&self, value: f32)

pub fn orientation(&self) -> Quaternion

pub fn set_orientation(&self, value: Quaternion)

pub fn scale(&self) -> Vector3D

pub fn set_scale(&self, value: Vector3D)

pub fn transform_matrix(&self) -> Matrix

pub fn set_transform_matrix(&self, value: Matrix)

pub fn adorner_is_clipped(&self) -> bool

Whether the adorner is clipped by the clips of the adorned visual and its ancestors.

pub fn set_adorner_is_clipped(&self, value: bool)

pub fn effect(&self) -> Option<Arc<dyn IImmutableEffect>>

pub fn set_effect(&self, value: Option<Arc<dyn IImmutableEffect>>)

pub fn render_options(&self) -> RenderOptions

pub fn set_render_options(&self, value: RenderOptions)

pub fn text_options(&self) -> TextOptions

pub fn set_text_options(&self, value: TextOptions)

impl CompositionVisual

pub fn visual_props(&self) -> &CompositionVisualProps

The generated properties of the visual class.

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

pub fn object(&self) -> &CompositionObject

The embedded CompositionObject.

pub fn implicit_animations(&self) -> Option<Rc<ImplicitAnimationCollection>>

The collection of implicit animations attached to this object.

pub fn set_implicit_animations( &self, value: Option<Rc<ImplicitAnimationCollection>>, )

pub fn server(&self) -> ServerObjectId

The id of the server-side visual.

pub fn is_disposed(&self) -> bool

pub fn dispose(&self)

pub fn children(&self) -> &Rc<CompositionVisualCollection>

The children of the visual.

pub fn root(&self) -> Option<Rc<CompositionTarget>>

The composition target the visual is attached to.

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

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

The visual this visual is an adorner of: its transform follows that visual.

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

pub fn cache_mode(&self) -> Option<Rc<CompositionBitmapCache>>

pub fn set_cache_mode(&self, value: Option<Rc<CompositionBitmapCache>>)

pub fn composition_clip(&self) -> Option<Rc<CompositionClip>>

The WinUI clip of the visual (Visual.Clip): an InsetClip or a RectangleClip, applied in the coordinates of the visual, after its transform, to its content and children.

Deviation (winui-composition.md): WinUI names it Clip; here clip is the geometry clip of the upstream compositor, so the WinUI member is composition_clip. Both may be set; the visible area is their intersection.

pub fn set_composition_clip(&self, value: Option<Rc<CompositionClip>>)

pub fn disable_sub_tree_bounds_hit_test_optimization(&self) -> bool

pub fn opacity_mask(&self) -> Option<Rc<dyn IBrush>>

pub fn set_opacity_mask(&self, value: Option<Rc<dyn IBrush>>)

pub fn try_get_valid_readback(&self) -> Option<ReadbackData>

The data the server wrote back for this visual, if it is valid for the current read revision.

pub fn tag(&self) -> Option<Rc<dyn Any>>

pub fn set_tag(&self, value: Option<Rc<dyn Any>>)

pub fn hit_test(&self, point: Point) -> bool

Whether the content of the visual is hit at a point in its own coordinates.

pub fn hit_test_geometry(&self, geometry: &Ref<Geometry>) -> IntersectionResult

How the content of the visual intersects a geometry in its own coordinates.

Trait Implementations

impl AsCompositionObject for CompositionVisual

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 CompositionContainerVisualHooks for CompositionVisual

fn initialize_defaults_extra(&self)

impl CompositionExperimentalAcrylicVisualHooks for CompositionVisual

fn base_serialize_changes_core(&self, writer: &mut BatchStreamWriter<'_>)

base.SerializeChangesCore(writer): serializes the changes of the hand-written base class CompositionDrawListVisual.

fn initialize_defaults_extra(&self)

fn validate_material_change( &self, _old_value: ImmutableExperimentalAcrylicMaterial, _new_value: ImmutableExperimentalAcrylicMaterial, )

fn on_material_changed(&self)

fn on_material_changing(&self)

fn validate_corner_radius_change( &self, _old_value: CornerRadius, _new_value: CornerRadius, )

fn on_corner_radius_changed(&self)

fn on_corner_radius_changing(&self)

impl CompositionSolidColorVisualHooks for CompositionVisual

fn initialize_defaults_extra(&self)

fn validate_color_change(&self, _old_value: Color, _new_value: Color)

fn on_color_changed(&self)

fn on_color_changing(&self)

impl CompositionSurfaceVisualHooks for CompositionVisual

fn initialize_defaults_extra(&self)

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

fn on_surface_changed(&self)

fn on_surface_changing(&self)

impl CompositionVisualCollectionHooks<CompositionVisual> for CompositionVisualCollection

fn on_added(&self, item: &Rc<CompositionVisual>)

fn on_before_replace( &self, old_item: &Rc<CompositionVisual>, new_item: &Rc<CompositionVisual>, )

fn on_replace( &self, old_item: &Rc<CompositionVisual>, new_item: &Rc<CompositionVisual>, )

fn on_removed(&self, item: &Rc<CompositionVisual>)

fn on_before_clear(&self)

fn on_clear(&self)

fn on_before_added(&self, item: &Rc<CompositionVisual>)

fn initialize_defaults_extra(&self)

impl CompositionVisualHooks for CompositionVisual

fn on_root_changed(&self)

fn on_parent_changing(&self)

fn on_parent_changed(&self)

fn initialize_defaults_extra(&self)

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

fn on_root_changing(&self)

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

fn validate_visible_change(&self, _old_value: bool, _new_value: bool)

fn on_visible_changed(&self)

fn on_visible_changing(&self)

fn validate_opacity_change(&self, _old_value: f32, _new_value: f32)

fn on_opacity_changed(&self)

fn on_opacity_changing(&self)

fn validate_clip_change( &self, _old_value: &Option<Arc<dyn IGeometryImpl>>, _new_value: &Option<Arc<dyn IGeometryImpl>>, )

fn on_clip_changed(&self)

fn on_clip_changing(&self)

fn validate_clip_to_bounds_change(&self, _old_value: bool, _new_value: bool)

fn on_clip_to_bounds_changed(&self)

fn on_clip_to_bounds_changing(&self)

fn validate_offset_change(&self, _old_value: Vector3D, _new_value: Vector3D)

fn on_offset_changed(&self)

fn on_offset_changing(&self)

fn validate_translation_change( &self, _old_value: Vector3D, _new_value: Vector3D, )

fn on_translation_changed(&self)

fn on_translation_changing(&self)

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

fn on_size_changed(&self)

fn on_size_changing(&self)

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

fn on_anchor_point_changed(&self)

fn on_anchor_point_changing(&self)

fn validate_center_point_change( &self, _old_value: Vector3D, _new_value: Vector3D, )

fn on_center_point_changed(&self)

fn on_center_point_changing(&self)

fn validate_rotation_angle_change(&self, _old_value: f32, _new_value: f32)

fn on_rotation_angle_changed(&self)

fn on_rotation_angle_changing(&self)

fn validate_orientation_change( &self, _old_value: Quaternion, _new_value: Quaternion, )

fn on_orientation_changed(&self)

fn on_orientation_changing(&self)

fn validate_scale_change(&self, _old_value: Vector3D, _new_value: Vector3D)

fn on_scale_changed(&self)

fn on_scale_changing(&self)

fn validate_transform_matrix_change( &self, _old_value: Matrix, _new_value: Matrix, )

fn on_transform_matrix_changed(&self)

fn on_transform_matrix_changing(&self)

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

fn on_adorned_visual_changed(&self)

fn on_adorned_visual_changing(&self)

fn validate_adorner_is_clipped_change(&self, _old_value: bool, _new_value: bool)

fn on_adorner_is_clipped_changed(&self)

fn on_adorner_is_clipped_changing(&self)

fn validate_opacity_mask_brush_change( &self, _old_value: &Option<BatchResource<dyn IBrush>>, _new_value: &Option<BatchResource<dyn IBrush>>, )

fn on_opacity_mask_brush_changed(&self)

fn on_opacity_mask_brush_changing(&self)

fn validate_effect_change( &self, _old_value: &Option<Arc<dyn IImmutableEffect>>, _new_value: &Option<Arc<dyn IImmutableEffect>>, )

fn on_effect_changed(&self)

fn on_effect_changing(&self)

fn validate_render_options_change( &self, _old_value: RenderOptions, _new_value: RenderOptions, )

fn on_render_options_changed(&self)

fn on_render_options_changing(&self)

fn validate_text_options_change( &self, _old_value: TextOptions, _new_value: TextOptions, )

fn on_text_options_changed(&self)

fn on_text_options_changing(&self)

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

fn on_cache_mode_changed(&self)

fn on_cache_mode_changing(&self)

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

fn on_composition_clip_changed(&self)

fn on_composition_clip_changing(&self)

fn validate_rotation_axis_change( &self, _old_value: Vector3D, _new_value: Vector3D, )

fn on_rotation_axis_changed(&self)

fn on_rotation_axis_changing(&self)

fn validate_relative_offset_adjustment_change( &self, _old_value: Vector3D, _new_value: Vector3D, )

fn on_relative_offset_adjustment_changed(&self)

fn on_relative_offset_adjustment_changing(&self)

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

fn on_relative_size_adjustment_changed(&self)

fn on_relative_size_adjustment_changing(&self)

fn validate_is_hit_test_visible_change( &self, _old_value: bool, _new_value: bool, )

fn on_is_hit_test_visible_changed(&self)

fn on_is_hit_test_visible_changing(&self)

fn validate_is_pixel_snapping_enabled_change( &self, _old_value: bool, _new_value: bool, )

fn on_is_pixel_snapping_enabled_changed(&self)

fn on_is_pixel_snapping_enabled_changing(&self)

fn validate_border_mode_change( &self, _old_value: CompositionBorderMode, _new_value: CompositionBorderMode, )

fn on_border_mode_changed(&self)

fn on_border_mode_changing(&self)

fn validate_backface_visibility_change( &self, _old_value: CompositionBackfaceVisibility, _new_value: CompositionBackfaceVisibility, )

fn on_backface_visibility_changed(&self)

fn on_backface_visibility_changing(&self)

fn validate_composite_mode_change( &self, _old_value: CompositionCompositeMode, _new_value: CompositionCompositeMode, )

fn on_composite_mode_changed(&self)

fn on_composite_mode_changing(&self)

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

fn on_parent_for_transform_changed(&self)

fn on_parent_for_transform_changing(&self)

impl ICompositionObject for CompositionVisual

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 CompositionVisual

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 CompositionVisual

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 ICompositorSerializable for CompositionVisual

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 CompositionVisual

fn register_for_serialization(&self)

impl LayerVisualHooks for CompositionVisual

fn initialize_defaults_extra(&self)

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

fn on_shadow_changed(&self)

fn on_shadow_changing(&self)

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

fn on_effect_brush_changed(&self)

fn on_effect_brush_changing(&self)

impl RedirectVisualHooks for CompositionVisual

fn initialize_defaults_extra(&self)

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

fn on_source_changed(&self)

fn on_source_changing(&self)

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

fn on_source_surface_changed(&self)

fn on_source_surface_changing(&self)

impl ShapeVisualHooks for CompositionVisual

fn initialize_defaults_extra(&self)

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

fn on_shapes_changed(&self)

fn on_shapes_changing(&self)

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

fn on_view_box_changed(&self)

fn on_view_box_changing(&self)

impl SpriteVisualHooks for CompositionVisual

fn initialize_defaults_extra(&self)

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

fn on_brush_changed(&self)

fn on_brush_changing(&self)

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

fn on_shadow_changed(&self)

fn on_shadow_changing(&self)

impl VisualUnorderedCollectionHooks<CompositionVisual> for VisualUnorderedCollection

fn initialize_defaults_extra(&self)

fn on_before_added(&self, _item: &Rc<TItem>)

fn on_added(&self, _item: &Rc<TItem>)

fn on_removed(&self, _item: &Rc<TItem>)

fn on_before_clear(&self)

fn on_before_replace(&self, _old_item: &Rc<TItem>, _new_item: &Rc<TItem>)

fn on_replace(&self, _old_item: &Rc<TItem>, _new_item: &Rc<TItem>)

fn on_clear(&self)