CompositionGradientBrush CompositionGradientBrush CompositionGradientBrush CompositionGradientBrush Class

Definition

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

public : class CompositionGradientBrush : CompositionBrush
struct winrt::Windows::UI::Composition::CompositionGradientBrush : CompositionBrush
public class CompositionGradientBrush : CompositionBrush
Public Class CompositionGradientBrush Inherits CompositionBrush
Inheritance
CompositionGradientBrushCompositionGradientBrushCompositionGradientBrushCompositionGradientBrush
Attributes

Windows 10 requirements

Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Remarks

Version history

Windows version SDK version Value added
1809 17763 MappingMode

Properties

AnchorPoint AnchorPoint AnchorPoint AnchorPoint

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

CenterPoint CenterPoint CenterPoint CenterPoint

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

ColorStops ColorStops ColorStops ColorStops

Gets the brush's gradient stops.

Comment Comment Comment Comment

A string to associate with the CompositionObject.

(Inherited from CompositionObject)
Compositor Compositor Compositor Compositor

The Compositor used to create this CompositionObject.

(Inherited from CompositionObject)
Dispatcher Dispatcher Dispatcher Dispatcher

The dispatcher for the CompositionObject.

(Inherited from CompositionObject)
DispatcherQueue DispatcherQueue DispatcherQueue DispatcherQueue

Gets the DispatcherQueue for the CompostionObject.

(Inherited from CompositionObject)
ExtendMode ExtendMode ExtendMode ExtendMode

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

ImplicitAnimations ImplicitAnimations ImplicitAnimations ImplicitAnimations

The collection of implicit animations attached to this object.

(Inherited from CompositionObject)
InterpolationSpace InterpolationSpace InterpolationSpace InterpolationSpace

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

MappingMode MappingMode MappingMode 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 Offset Offset Offset

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

Properties Properties Properties Properties

The collection of properties associated with the CompositionObject.

(Inherited from CompositionObject)
RotationAngle RotationAngle RotationAngle RotationAngle

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

RotationAngleInDegrees RotationAngleInDegrees RotationAngleInDegrees RotationAngleInDegrees

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

Scale Scale Scale Scale

Gets or sets the scale to apply to the brush.

TransformMatrix TransformMatrix TransformMatrix TransformMatrix

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

Methods

Close Close Close Close

Closes the CompositionObject and releases system resources.

(Inherited from CompositionObject)
PopulatePropertyInfo(String,AnimationPropertyInfo) PopulatePropertyInfo(String,AnimationPropertyInfo) PopulatePropertyInfo(String,AnimationPropertyInfo) PopulatePropertyInfo(String,AnimationPropertyInfo)

Defines a property that can be animated.

(Inherited from CompositionObject)
StartAnimation(String,CompositionAnimation) StartAnimation(String,CompositionAnimation) StartAnimation(String,CompositionAnimation) StartAnimation(String,CompositionAnimation)

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

(Inherited from CompositionObject)
StartAnimationGroup(ICompositionAnimationBase) StartAnimationGroup(ICompositionAnimationBase) StartAnimationGroup(ICompositionAnimationBase) 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)
StartAnimationGroupWithIAnimationObject(IAnimationObject,ICompositionAnimationBase) StartAnimationGroupWithIAnimationObject(IAnimationObject,ICompositionAnimationBase) StartAnimationGroupWithIAnimationObject(IAnimationObject,ICompositionAnimationBase) StartAnimationGroupWithIAnimationObject(IAnimationObject,ICompositionAnimationBase)

Starts an animation group on the specified target.

(Inherited from CompositionObject)
StartAnimationWithIAnimationObject(IAnimationObject,String,CompositionAnimation) StartAnimationWithIAnimationObject(IAnimationObject,String,CompositionAnimation) StartAnimationWithIAnimationObject(IAnimationObject,String,CompositionAnimation) StartAnimationWithIAnimationObject(IAnimationObject,String,CompositionAnimation)

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

(Inherited from CompositionObject)
StopAnimation(String) StopAnimation(String) StopAnimation(String) StopAnimation(String)

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

(Inherited from CompositionObject)
StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase)

Stops an animation group.

(Inherited from CompositionObject)
TryGetAnimationController(String) TryGetAnimationController(String) TryGetAnimationController(String) TryGetAnimationController(String)

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

(Inherited from CompositionObject)