ID2D1GradientStopCollection::GetGradientStops メソッド

コレクションから D2D1_GRADIENT_STOP 構造体の配列にグラデーション境界をコピーします。

構文

virtual void GetGradientStops(
  [out]  D2D1_GRADIENT_STOP *gradientStops,
         UINT gradientStopsCount
) const = 0;

パラメーター

• gradientStops [out]
  D2D1_GRADIENT_STOP D2D1_GRADIENT_STOP 構造体の 1 次元配列へのポインター。このメソッドが返されるときに、配列にはコレクションのグラデーション境界のコピーが格納されます。この配列にメモリを割り当てる必要があります。
• gradientStopsCount
  UINT コピーするグラデーション境界の数を示す値。値がコレクション内のグラデーション境界の数より小さい場合、残りのグラデーション境界は除外されます。値がコレクション内のグラデーション境界の数より大きい場合、超過分のグラデーション境界は NULL に設定されます。コレクション内のグラデーション境界の数を取得するには、GetGradientStopCount メソッドを使用します。

戻り値

This は値を返しません。

解説

グラデーション境界は、位置の順序に従ってコピーされます。つまり、位置を示す値が最も小さいグラデーション境界から最も大きいグラデーション境界へ向かってコピーされます。

要件

参照

ID2D1GradientStopCollection