CompositionSpriteShape Class

Definition

A CompositionShape that draws Stroked and Filled CompositionGeometry.

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

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

Windows 10 requirements

Device family
Windows 10, version 1803 (introduced in 10.0.17134.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v6.0)

Properties

CenterPoint

The point about which the shape is rotated and scaled.

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

(Inherited from CompositionShape)
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)
FillBrush

Gets or sets the brush that paints the interior area of the shape.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionSpriteShape.FillBrush.

Geometry

Gets or sets the geometry that defines this shape.

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

ImplicitAnimations

The collection of implicit animations attached to this object.

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

(Inherited from CompositionObject)
IsStrokeNonScaling

Gets or sets a value that specifies whether the shape's outline scales.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionSpriteShape.IsStrokeNonScaling.

Offset

Gets or sets the offset of the shape relative to its ShapeVisual.

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

(Inherited from CompositionShape)
Properties

The collection of properties associated with the CompositionObject.

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

(Inherited from CompositionObject)
RotationAngle

Gets or sets the rotation angle of the shape in radians.

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

(Inherited from CompositionShape)
RotationAngleInDegrees

Gets or sets the rotation angle of the shape in degrees.

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

(Inherited from CompositionShape)
Scale

Gets or sets the scale to apply to the shape.

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

(Inherited from CompositionShape)
StrokeBrush

Gets or sets the brush that paints the outline of the shape.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionSpriteShape.StrokeBrush.

StrokeDashArray

Gets the collection of values that indicates the pattern of dashes and gaps used to outline shapes.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionSpriteShape.StrokeDashArray.

StrokeDashCap

Gets or sets a CompositionStrokeCap enumeration value that specifies how the ends of a dash are drawn.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionSpriteShape.StrokeDashCap.

StrokeDashOffset

Gets or sets a value that specifies the distance within the dash pattern where a dash begins.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionSpriteShape.StrokeDashOffset.

StrokeEndCap

Gets or sets a CompositionStrokeCap enumeration value that specifies how the end of a line is drawn.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionSpriteShape.StrokeEndCap.

StrokeLineJoin

Gets or sets a CompositionStrokeLineJoin enumeration value that specifies the type of join used at the vertices of a shape.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionSpriteShape.StrokeLineJoin.

StrokeMiterLimit

Gets or sets a limit on the ratio of the miter length to half the StrokeThickness of a shape element.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionSpriteShape.StrokeMiterLimit.

StrokeStartCap

Gets or sets a CompositionStrokeCap enumeration value that specifies how the start of a line is drawn.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionSpriteShape.StrokeStartCap.

StrokeThickness

Gets or sets the width of the shape outline.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionSpriteShape.StrokeThickness.

TransformMatrix

Gets or sets the transform matrix to apply to the shape.

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

(Inherited from CompositionShape)

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