Edit

Share via

IDWritePaintReader::GetGradientStops method (dwrite_3.h)

  • Article

Retrieves the gradient stops of the current paint element.

Syntax

HRESULT GetGradientStops(
  UINT32             firstGradientStopIndex,
  UINT32             gradientStopCount,
  D2D1_GRADIENT_STOP *gradientStops
);

Parameters

firstGradientStopIndex

Type: UINT32

Index of the first gradient stop to retrieve.

gradientStopCount

Type: UINT32

Number of gradient stops to retrieve.

gradientStops

Type: _Out_writes_(gradientStopCount) D2D1_GRADIENT_STOP *

Receives the gradient stops.

Return value

A standard HRESULT error code.

Remarks

Gradient stops are guaranteed to be in ascending order by position.

Requirements

Requirement Value
Minimum supported client Windows 10, version 1809 (with Windows App SDK 1.2 or later)
Header dwrite_3.h