ID2D1GradientStopCollection::GetGradientStops method

Copies the gradient stops from the collection into an array of D2D1_GRADIENT_STOP structures.

Syntax

void GetGradientStops(
  D2D1_GRADIENT_STOP *gradientStops,
  UINT32             gradientStopsCount
);

Parameters

gradientStops

Type: D2D1_GRADIENT_STOP*

A pointer to a one-dimensional array of D2D1_GRADIENT_STOP structures. When this method returns, the array contains copies of the collection's gradient stops. You must allocate the memory for this array.

gradientStopsCount

Type: UINT

A value indicating the number of gradient stops to copy. If the value is less than the number of gradient stops in the collection, the remaining gradient stops are omitted. If the value is larger than the number of gradient stops in the collection, the extra gradient stops are set to NULL. To obtain the number of gradient stops in the collection, use the GetGradientStopCount method.

Return Value

This method does not return a value.

Remarks

Gradient stops are copied in order of position, starting with the gradient stop with the smallest position value and progressing to the gradient stop with the largest position value.

Requirements

   
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

ID2D1GradientStopCollection