ID2D1RenderTarget::CreateLinearGradientBrush(constD2D1_LINEAR_GRADIENT_BRUSH_PROPERTIES&,ID2D1GradientStopCollection*,ID2D1LinearGradientBrush**) method (d2d1.h)

Creates an ID2D1LinearGradientBrush that contains the specified gradient stops, has no transform, and has a base opacity of 1.0.

Syntax

HRESULT CreateLinearGradientBrush(
  const D2D1_LINEAR_GRADIENT_BRUSH_PROPERTIES & linearGradientBrushProperties,
  ID2D1GradientStopCollection                   *gradientStopCollection,
  ID2D1LinearGradientBrush                      **linearGradientBrush
);

Parameters

linearGradientBrushProperties

Type: [in] const D2D1_LINEAR_GRADIENT_BRUSH_PROPERTIES &

The start and end points of the gradient.

gradientStopCollection

Type: [in] ID2D1GradientStopCollection*

A collection of D2D1_GRADIENT_STOP structures that describe the colors in the brush's gradient and their locations along the gradient line.

linearGradientBrush

Type: [out] ID2D1LinearGradientBrush**

When this method returns, contains the address of a pointer to the new brush. This parameter is passed uninitialized.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Requirement	Value
Minimum supported client	Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | UWP apps]
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | UWP apps]
Target Platform	Windows
Header	d2d1.h
Library	D2d1.lib
DLL	D2d1.dll

See also

Brushes Overview

CreateGradientStopCollection

How to Create a Linear Gradient Brush

ID2D1GradientStopCollection

ID2D1LinearGradientBrush

ID2D1RadialGradientBrush

ID2D1RenderTarget