CD2DGradientBrush Class

Article
08/03/2021

The base class of the CD2DLinearGradientBrush and the CD2DRadialGradientBrush classes.

Syntax

class CD2DGradientBrush : public CD2DBrush;

Members

Public Constructors

Name	Description
CD2DGradientBrush::CD2DGradientBrush	Constructs a CD2DGradientBrush object.
CD2DGradientBrush::~CD2DGradientBrush	The destructor. Called when a D2D gradient brush object is being destroyed.

Protected Methods

Name	Description
CD2DGradientBrush::Destroy	Destroys a CD2DGradientBrush object. (Overrides CD2DBrush::Destroy.)

Protected Data Members

Name	Description
CD2DGradientBrush::m_arGradientStops	Array of the D2D1_GRADIENT_STOP structures.
CD2DGradientBrush::m_colorInterpolationGamma	The space in which color interpolation between the gradient stops is performed.
CD2DGradientBrush::m_extendMode	The behavior of the gradient outside the [0,1] normalized range.
CD2DGradientBrush::m_pGradientStops	A pointer to an array of D2D1_GRADIENT_STOP structures.

Inheritance Hierarchy

CObject

CD2DResource

CD2DBrush

CD2DGradientBrush

Requirements

Header: afxrendertarget.h

CD2DGradientBrush::~CD2DGradientBrush

The destructor. Called when a D2D gradient brush object is being destroyed.

virtual ~CD2DGradientBrush();

CD2DGradientBrush::CD2DGradientBrush

Constructs a CD2DGradientBrush object.

CD2DGradientBrush(
    CRenderTarget* pParentTarget,
    const D2D1_GRADIENT_STOP* gradientStops,
    UINT gradientStopsCount,
    D2D1_GAMMA colorInterpolationGamma = D2D1_GAMMA_2_2,
    D2D1_EXTEND_MODE extendMode = D2D1_EXTEND_MODE_CLAMP,
    CD2DBrushProperties* pBrushProperties = NULL,
    BOOL bAutoDestroy = TRUE);

Parameters

pParentTarget
A pointer to the render target.

gradientStops
A pointer to an array of D2D1_GRADIENT_STOP structures.

gradientStopsCount
A value greater than or equal to 1 that specifies the number of gradient stops in the gradientStops array.

colorInterpolationGamma
The space in which color interpolation between the gradient stops is performed.

extendMode
The behavior of the gradient outside the [0,1] normalized range.

pBrushProperties
A pointer to the opacity and transformation of a brush.

bAutoDestroy
Indicates that the object will be destroyed by owner (pParentTarget).

CD2DGradientBrush::Destroy

Destroys a CD2DGradientBrush object.

virtual void Destroy();

CD2DGradientBrush::m_arGradientStops

Array of the D2D1_GRADIENT_STOP structures.

CArray<D2D1_GRADIENT_STOP, D2D1_GRADIENT_STOP> m_arGradientStops;

CD2DGradientBrush::m_colorInterpolationGamma

The space in which color interpolation between the gradient stops is performed.

D2D1_GAMMA m_colorInterpolationGamma;

CD2DGradientBrush::m_extendMode

The behavior of the gradient outside the [0,1] normalized range.

D2D1_EXTEND_MODE m_extendMode;

CD2DGradientBrush::m_pGradientStops

A pointer to an array of D2D1_GRADIENT_STOP structures.

ID2D1GradientStopCollection* m_pGradientStops;

Share via