ID2D1RenderTarget::CreateGradientStopCollection methods

Creates an ID2D1GradientStopCollection from the specified array of D2D1_GRADIENT_STOP structures.

Overload list

Method	Description
CreateGradientStopCollection(D2D1_GRADIENT_STOP*,D2D1_GAMMA,D2D1_EXTEND_MODE,ID2D1GradientStopCollection**)	Creates an ID2D1GradientStopCollection from the specified gradient stops, color interpolation gamma, and extend mode.
CreateGradientStopCollection(D2D1_GRADIENT_STOP*,ID2D1GradientStopCollection**)	Creates an ID2D1GradientStopCollection from the specified gradient stops that uses the D2D1_GAMMA_2_2 color interpolation gamma and the clamp extend mode.

Examples

The following example creates an array of gradient stops, then uses them to create an ID2D1GradientStopCollection.

// Create an array of gradient stops to put in the gradient stop
// collection that will be used in the gradient brush.
ID2D1GradientStopCollection *pGradientStops = NULL;

D2D1_GRADIENT_STOP gradientStops[2];
gradientStops[0].color = D2D1::ColorF(D2D1::ColorF::Yellow, 1);
gradientStops[0].position = 0.0f;
gradientStops[1].color = D2D1::ColorF(D2D1::ColorF::ForestGreen, 1);
gradientStops[1].position = 1.0f;
// Create the ID2D1GradientStopCollection from a previously
// declared array of D2D1_GRADIENT_STOP structs.
hr = m_pRenderTarget->CreateGradientStopCollection(
    gradientStops,
    2,
    D2D1_GAMMA_2_2,
    D2D1_EXTEND_MODE_CLAMP,
    &pGradientStops
    );

The next code example uses the ID2D1GradientStopCollection to create an ID2D1LinearGradientBrush.

// The line that determines the direction of the gradient starts at
// the upper-left corner of the square and ends at the lower-right corner.

if (SUCCEEDED(hr))
{
    hr = m_pRenderTarget->CreateLinearGradientBrush(
        D2D1::LinearGradientBrushProperties(
            D2D1::Point2F(0, 0),
            D2D1::Point2F(150, 150)),
        pGradientStops,
        &m_pLinearGradientBrush
        );
}

Requirements

Requirement	Value
Header	D2d1_1.h (include D2d1.h)
Library	D2d1.lib
DLL	D2d1.dll

See also

ID2D1RenderTarget

D2D1_GRADIENT_STOP

How to Create a Linear Gradient Brush

How to Create a Radial Gradient Brush

Brushes Overview