CompositionGeometricClip Class

Definition

Clips a portion of a visual. The visible portion of the visual is a shape defined by a CompositionGeometry. The portion of the visual outside the geometry is clipped.

Equivalent WinUI class: Microsoft.UI.Composition.CompositionGeometricClip.

public ref class CompositionGeometricClip sealed : CompositionClip
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 458752)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class CompositionGeometricClip final : CompositionClip
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 458752)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class CompositionGeometricClip : CompositionClip
Public NotInheritable Class CompositionGeometricClip
Inherits CompositionClip
Inheritance
CompositionGeometricClip
Attributes

Windows 10 requirements

Device family
Windows 10, version 1809 (introduced in 10.0.17763.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v7.0)

Properties

AnchorPoint

The point on the clip to be positioned at the clip's offset. Value is normalized with respect to the size of the clip.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionClip.AnchorPoint.

(Inherited from CompositionClip)
CenterPoint

The point about which rotation or scaling occurs.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionClip.CenterPoint.

(Inherited from CompositionClip)
Comment

A string to associate with the CompositionObject.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionObject.Comment.

(Inherited from CompositionObject)
Compositor

The Compositor used to create this CompositionObject.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionObject.Compositor.

(Inherited from CompositionObject)
Dispatcher

The dispatcher for the CompositionObject.

(Inherited from CompositionObject)
DispatcherQueue

Gets the DispatcherQueue for the CompostionObject.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionObject.DispatcherQueue.

(Inherited from CompositionObject)
Geometry

Gets or sets CompositionGeometry that defines the shape of the clip.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionGeometricClip.Geometry.

ImplicitAnimations

The collection of implicit animations attached to this object.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionObject.ImplicitAnimations.

(Inherited from CompositionObject)
Offset

The offset of the clip relative to the visual on which the clip is applied.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionClip.Offset.

(Inherited from CompositionClip)
Properties

The collection of properties associated with the CompositionObject.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionObject.Properties.

(Inherited from CompositionObject)
RotationAngle

The angle of rotation applied to the clip, in radians.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionClip.RotationAngle.

(Inherited from CompositionClip)
RotationAngleInDegrees

The angle of rotation applied to the clip, in degrees.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionClip.RotationAngleInDegrees.

(Inherited from CompositionClip)
Scale

The scale to apply to the clip.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionClip.Scale.

(Inherited from CompositionClip)
TransformMatrix

The 3x2 transformation matrix to apply to the clip.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionClip.TransformMatrix.

(Inherited from CompositionClip)
ViewBox

Gets or sets a CompositionViewBox that maps the shape visual tree coordinates onto the visual.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionGeometricClip.ViewBox.

Methods

Close()

Closes the CompositionObject and releases system resources.

Equivalent WinUI method: Microsoft.UI.Composition.CompositionObject.Close.

(Inherited from CompositionObject)
ConnectAnimation(String, CompositionAnimation)

Connects and animation.

(Inherited from CompositionObject)
DisconnectAnimation(String)

Disconnects an animation.

(Inherited from CompositionObject)
Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

(Inherited from CompositionObject)
PopulatePropertyInfo(String, AnimationPropertyInfo)

Defines a property that can be animated.

Equivalent WinUI method: Microsoft.UI.Composition.CompositionObject.PopulatePropertyInfo.

(Inherited from CompositionObject)
StartAnimation(String, CompositionAnimation)

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

Equivalent WinUI method: Microsoft.UI.Composition.CompositionObject.StartAnimation.

(Inherited from CompositionObject)
StartAnimationGroup(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.

Equivalent WinUI method: Microsoft.UI.Composition.CompositionObject.StartAnimationGroup.

(Inherited from CompositionObject)
StopAnimation(String)

Disconnects an animation from the specified property and stops the animation.

Equivalent WinUI method: Microsoft.UI.Composition.CompositionObject.StopAnimation.

(Inherited from CompositionObject)
StopAnimationGroup(ICompositionAnimationBase)

Stops an animation group.

Equivalent WinUI method: Microsoft.UI.Composition.CompositionObject.StopAnimationGroup.

(Inherited from CompositionObject)
TryGetAnimationController(String)

Returns an AnimationController for the animation running on the specified property.

Equivalent WinUI method: Microsoft.UI.Composition.CompositionObject.TryGetAnimationController.

(Inherited from CompositionObject)

Applies to