CompositionClip CompositionClip CompositionClip CompositionClip Class

Definition

Base class for clipping objects such as InsetClip.

public : class CompositionClip : CompositionObject, ICompositionClip, ICompositionClip2public class CompositionClip : CompositionObject, ICompositionClip, ICompositionClip2Public Class CompositionClip Inherits CompositionObject Implements ICompositionClip, ICompositionClip2// This API is not available in Javascript.
Inheritance
CompositionClipCompositionClipCompositionClipCompositionClip
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Inherited Members

Inherited methods

Inherited properties

Properties

AnchorPoint AnchorPoint AnchorPoint 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.

public : Vector2 AnchorPoint { get; set; }public Vector2 AnchorPoint { get; set; }Public ReadWrite Property AnchorPoint As Vector2// This API is not available in Javascript.
Value
Vector2 Vector2 Vector2 Vector2

The point on the clip to be positioned at the clip's offset. Value is normalized with respect to the size of the clip. An AnchorPoint value of (0, 0) refers to the top-left corner of the untransformed clip and a value of (1, 1) refers to the bottom-right corner. Negative values and values greater than one are accepted but will result in an AnchorPoint that is outside the boundaries of the original, untransformed clip.

By default, the AnchorPoint value on a clip is (0, 0).

Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

CenterPoint CenterPoint CenterPoint CenterPoint

The point about which rotation or scaling occurs.

public : Vector2 CenterPoint { get; set; }public Vector2 CenterPoint { get; set; }Public ReadWrite Property CenterPoint As Vector2// This API is not available in Javascript.
Value
Vector2 Vector2 Vector2 Vector2

The point about which rotation or scaling occurs. Value is in pixels within the local coordinate space of the visual on which the clip is applied.

By default, the CenterPoint value on a clip is (0, 0).

Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Offset Offset Offset Offset

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

public : Vector2 Offset { get; set; }public Vector2 Offset { get; set; }Public ReadWrite Property Offset As Vector2// This API is not available in Javascript.
Value
Vector2 Vector2 Vector2 Vector2

The offset of the clip relative to the visual on which the clip is applied. By default, the Offset value on a clip is (0, 0).

Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

RotationAngle RotationAngle RotationAngle RotationAngle

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

public : float RotationAngle { get; set; }public float RotationAngle { get; set; }Public ReadWrite Property RotationAngle As float// This API is not available in Javascript.
Value
float float float float

The angle of rotation applied to the clip, in radians. For a CompositionClip, the axis of rotation is always about the z-axis, with positive RotationAngle values resulting in a clockwise rotation and negative values resulting in a counter-clockwise rotation. For specifying RotationAngle in degrees, use CompositionClip.RotationAngleInDegrees. If both RotationAngle and CompositionClip.RotationAngleInDegrees are set on the same CompositionClip object, whichever value is set last will override the other value.

By default, the RotationAngle value on a clip is (0, 0).

Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)
See Also

RotationAngleInDegrees RotationAngleInDegrees RotationAngleInDegrees RotationAngleInDegrees

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

public : float RotationAngleInDegrees { get; set; }public float RotationAngleInDegrees { get; set; }Public ReadWrite Property RotationAngleInDegrees As float// This API is not available in Javascript.
Value
float float float float

The angle of rotation applied to the clip, in degrees. For a CompositionClip, the axis of rotation is always about the z-axis, with positive RotationAngleInDegrees values resulting in a clockwise rotation and negative values resulting in a counter-clockwise rotation. For specifying RotationAngle in radians, use CompositionClip.RotationAngle. If both CompositionClip.RotationAngle and CompositionClip.RotationAngleInDegrees are set on the same CompositionClip object, whichever value is set last will override the other value.

By default, the RotationAngleInDegrees value on a clip is (0, 0).

Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)
See Also

Scale Scale Scale Scale

The scale to apply to the clip.

public : Vector2 Scale { get; set; }public Vector2 Scale { get; set; }Public ReadWrite Property Scale As Vector2// This API is not available in Javascript.
Value
Vector2 Vector2 Vector2 Vector2

The scale to apply to the clip. The scale value is a multiplier of the clip's size. By default, the Scale value on a clip is (1, 1).

Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

TransformMatrix TransformMatrix TransformMatrix TransformMatrix

The 3x2 transformation matrix to apply to the clip.

public : Matrix3x2 TransformMatrix { get; set; }public Matrix3x2 TransformMatrix { get; set; }Public ReadWrite Property TransformMatrix As Matrix3x2// This API is not available in Javascript.
Value
Matrix3x2 Matrix3x2 Matrix3x2 Matrix3x2

The transformation matrix to apply to the clip. By default, the TransformMatrix is set to:


[1 0
 0 1
 0 0]             
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

See Also