ID2D1RenderTarget::CreateLinearGradientBrush method

Creates an ID2D1LinearGradientBrush that contains the specified gradient stops and has the specified transform and base opacity.

Syntax


virtual HRESULT CreateLinearGradientBrush(
  [in]            const D2D1_LINEAR_GRADIENT_BRUSH_PROPERTIES *linearGradientBrushProperties,
  [in, optional]  const D2D1_BRUSH_PROPERTIES *brushProperties,
  [in]            ID2D1GradientStopCollection *gradientStopCollection,
  [out]           ID2D1LinearGradientBrush **linearGradientBrush
) = 0;

Parameters

linearGradientBrushProperties [in]

Type: const D2D1_LINEAR_GRADIENT_BRUSH_PROPERTIES*

The start and end points of the gradient.

brushProperties [in, optional]

Type: const D2D1_BRUSH_PROPERTIES*

The transform and base opacity of the new brush, or NULL. If this value is NULL, the brush defaults to a base opacity of 1.0f and the identity matrix as its transformation.

gradientStopCollection [in]

Type: 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 [out]

Type: 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

Minimum supported client

Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | Windows Store apps]

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Header

D2d1.h

Library

D2d1.lib

DLL

D2d1.dll

See also

ID2D1RenderTarget
CreateGradientStopCollection
ID2D1GradientStopCollection
ID2D1LinearGradientBrush
ID2D1RadialGradientBrush
How to Create a Linear Gradient Brush
Brushes Overview

 

 

Community Additions

ADD
Show:
© 2014 Microsoft