ID2D1RenderTarget::CreateRadialGradientBrush method
Creates an ID2D1RadialGradientBrush that contains the specified gradient stops and has the specified transform and base opacity.
Syntax
HRESULT CreateRadialGradientBrush( [ref] const D2D1_RADIAL_GRADIENT_BRUSH_PROPERTIES &radialGradientBrushProperties, [ref] const D2D1_BRUSH_PROPERTIES &brushProperties, [in] ID2D1GradientStopCollection *gradientStopCollection, [out] ID2D1RadialGradientBrush **radialGradientBrush );
Parameters
- radialGradientBrushProperties [ref]
-
Type: const D2D1_RADIAL_GRADIENT_BRUSH_PROPERTIES
The center, gradient origin offset, and x-radius and y-radius of the brush's gradient.
- brushProperties [ref]
-
Type: const D2D1_BRUSH_PROPERTIES
The transform and base opacity of the new brush.
- 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.
Examples
For an example, see How to Create a Radial Gradient Brush.
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 |
|
|
Library |
|
|
DLL |
|
See also