Skip to content

Latest commit

 

History

History
89 lines (64 loc) · 4.28 KB

nf-d2d1_1-id2d1gradientstopcollection1-getgradientstops1.md

File metadata and controls

89 lines (64 loc) · 4.28 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:d2d1_1.ID2D1GradientStopCollection1.GetGradientStops1
ID2D1GradientStopCollection1::GetGradientStops1 (d2d1_1.h)
Copies the gradient stops from the collection into memory.
GetGradientStops1
GetGradientStops1 method [Direct2D]
GetGradientStops1 method [Direct2D]
ID2D1GradientStopCollection1 interface
ID2D1GradientStopCollection1 interface [Direct2D]
GetGradientStops1 method
ID2D1GradientStopCollection1.GetGradientStops1
ID2D1GradientStopCollection1::GetGradientStops1
d2d1_1/ID2D1GradientStopCollection1::GetGradientStops1
direct2d.id2d1gradientstopcollection1_getgradientstops1
direct2d\id2d1gradientstopcollection1_getgradientstops1.htm
Direct2D
da3987a5-b40f-49eb-9930-0162cf64d6a9
12/05/2018
GetGradientStops1, GetGradientStops1 method [Direct2D], GetGradientStops1 method [Direct2D],ID2D1GradientStopCollection1 interface, ID2D1GradientStopCollection1 interface [Direct2D],GetGradientStops1 method, ID2D1GradientStopCollection1.GetGradientStops1, ID2D1GradientStopCollection1::GetGradientStops1, d2d1_1/ID2D1GradientStopCollection1::GetGradientStops1, direct2d.id2d1gradientstopcollection1_getgradientstops1
d2d1_1.h
Windows
Windows 8 and Platform Update for Windows 7 [desktop apps \| UWP apps]
Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps \| UWP apps]
D2d1.dll
Windows
19H1
ID2D1GradientStopCollection1::GetGradientStops1
d2d1_1/ID2D1GradientStopCollection1::GetGradientStops1
c++
APIRef
kbSyntax
COM
D2d1.dll
ID2D1GradientStopCollection1.GetGradientStops1

ID2D1GradientStopCollection1::GetGradientStops1

-description

Copies the gradient stops from the collection into memory.

-parameters

-param gradientStops [out]

Type: D2D1_GRADIENT_STOP*

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

-param gradientStopsCount

Type: UINT

The number of gradient stops to copy.

-remarks

If the 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.

-see-also

ID2D1DeviceContext::CreateEffect

ID2D1DeviceContext::CreateGradientStopCollection

ID2D1GradientStopCollection1

ID2D1RenderTarget::CreateGradientStopCollection