ID2D1RenderTarget::CreateRadialGradientBrush method

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

Syntax

virtual HRESULT CreateRadialGradientBrush(
  [in]           const D2D1_RADIAL_GRADIENT_BRUSH_PROPERTIES *radialGradientBrushProperties,
  [in, optional] const D2D1_BRUSH_PROPERTIES                 *brushProperties,
  [in]                 ID2D1GradientStopCollection           *gradientStopCollection,
  [out]                ID2D1RadialGradientBrush              **radialGradientBrush
) = 0;

Parameters

radialGradientBrushProperties [in]

Type: const D2D1_RADIAL_GRADIENT_BRUSH_PROPERTIES*

The center, gradient origin offset, and x-radius and y-radius of the brush's 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.

radialGradientBrush [out]

Type: ID2D1RadialGradientBrush**

When this method returns, contains a pointer to 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

See also

ID2D1RenderTarget