Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ID2D1GradientStopCollection1::GetGradientStops1 method

Copies the gradient stops from the collection into memory.

Syntax


void GetGradientStops1(
  [out] D2D1_GRADIENT_STOP *gradientStops,
        UINT               gradientStopsCount
);

Parameters

gradientStops [out]

Type: D2D1_GRADIENT_STOP*

When this method returns, contains a pointer to a one-dimensional array of D2D1_GRADIENT_STOP structures.

gradientStopsCount

Type: UINT

The number of gradient stops to copy.

Return value

This method does not return a value.

Remarks

If the ID2D1GradientStopCollection1 object was created using ID2D1DeviceContext::CreateGradientStopCollection, this method returns the same values specified in the creation method. If the ID2D1GradientStopCollection1 object was created using ID2D1RenderTarget::CreateGradientStopCollection, the stops returned here will first be transformed into the gamma space specified by the colorInterpolationGamma parameter. See the ID2D1DeviceContext::CreateGradientStopCollection method for more info about color space and gamma space.

If gradientStopsCount is less than the number of gradient stops in the collection, the remaining gradient stops are omitted. If gradientStopsCount 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.

Requirements

Minimum supported client

Windows 8 and Platform Update for Windows 7 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps | Windows Store apps]

Minimum supported phone

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

Header

D2d1_1.h

DLL

D2d1.dll

See also

ID2D1GradientStopCollection1
ID2D1DeviceContext::CreateEffect
ID2D1DeviceContext::CreateGradientStopCollection
ID2D1RenderTarget::CreateGradientStopCollection

 

 

Show:
© 2016 Microsoft