CompositionGradientBrush Class

Definition

Represents a brush that describes a gradient, composed of gradient stops.

CompositionGradientBrush is supported only with Rgb and RgbLinear CompositionColorSpace.

public ref class CompositionGradientBrush : CompositionBrush
class CompositionGradientBrush : CompositionBrush
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Composition.ICompositionGradientBrushFactory), Windows.Foundation.Metadata.CompositionType.Protected, 327680, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 327680)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
public class CompositionGradientBrush : CompositionBrush
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 327680)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Composition.ICompositionGradientBrushFactory), Windows.Foundation.Metadata.CompositionType.Public, 327680, "Windows.Foundation.UniversalApiContract")]
public class CompositionGradientBrush : CompositionBrush
Public Class CompositionGradientBrush
Inherits CompositionBrush
Inheritance
CompositionGradientBrush
Derived
Attributes

Windows 10 requirements

Device family
Windows 10 Fall Creators Update (introduced in 10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v5.0)

Remarks

Version history

Windows version SDK version Value added
1809 17763 MappingMode

Properties

AnchorPoint

Gets or sets the point on the brush to be positioned at the brush's offset.

CenterPoint

Gets or sets the point about which the brush is rotated and scaled.

ColorStops

Gets the brush's gradient stops.

Comment

A string to associate with the CompositionObject.

(Inherited from CompositionObject)
Compositor

The Compositor used to create this CompositionObject.

(Inherited from CompositionObject)
Dispatcher

The dispatcher for the CompositionObject.

(Inherited from CompositionObject)
DispatcherQueue

Gets the DispatcherQueue for the CompostionObject.

(Inherited from CompositionObject)
ExtendMode

Gets or sets a value that specifies how to draw the gradient outside the brush's gradient vector or space.

ImplicitAnimations

The collection of implicit animations attached to this object.

(Inherited from CompositionObject)
InterpolationSpace

Gets or sets a value that specifies how the gradient's colors are interpolated.

MappingMode

Gets or sets a value that indicates whether the gradient brush's positioning coordinates (StartPoint, EndPoint) are absolute or relative to the output area.

Offset

Gets or sets the offset of the brush relative to the object being painted.

Properties

The collection of properties associated with the CompositionObject.

(Inherited from CompositionObject)
RotationAngle

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

RotationAngleInDegrees

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

Scale

Gets or sets the scale to apply to the brush.

TransformMatrix

Gets or sets the matrix of transforms to apply to the brush.

Methods

Close()

Closes the CompositionObject and releases system resources.

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

(Inherited from CompositionObject)
StartAnimation(String, CompositionAnimation)

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

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

(Inherited from CompositionObject)
StopAnimation(String)

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

(Inherited from CompositionObject)
StopAnimationGroup(ICompositionAnimationBase)

Stops an animation group.

(Inherited from CompositionObject)
TryGetAnimationController(String)

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

(Inherited from CompositionObject)

Applies to