Win32 API 日本語リファレンス
ホームGraphics.Direct2D › ID2D1RadialGradientBrush

ID2D1RadialGradientBrush

COM
IID2cd906ac-12e2-11dc-9fed-001143a055f9継承元ID2D1Brush自前メソッド開始 vtbl8

公式ドキュメント

領域を放射状グラデーションで塗りつぶします。

解説(Remarks)

ID2D1RadialGradientBrush は、グラデーションストップのコレクションをグラデーションにマッピングするという点で ID2D1LinearGradientBrush に似ています。ただし、線形グラデーションがグラデーションベクトルを定義するために始点と終点を持つのに対し、放射状グラデーションは楕円とグラデーションの原点を使用してグラデーションの動作を定義します。楕円の位置とサイズを定義するには、SetCenterSetRadiusXSetRadiusY の各メソッドを使用して、楕円の中心、x 半径、y 半径を指定します。グラデーションの原点は、SetGradientOriginOffset メソッドを使用してグラデーションのオフセットを指定しない限り、楕円の中心になります。

このブラシは、グラデーションストップの位置 0.0f をグラデーションの原点にマッピングし、位置 1.0f を楕円の境界にマッピングします。グラデーションの原点が楕円の内側にある場合、楕円の内容にはブラシのグラデーションストップの [0, 1] の範囲全体が含まれます。グラデーションの原点が楕円の境界の外側にある場合でもブラシは機能しますが、そのグラデーションは明確には定義されません。

始点と終点はブラシ空間で記述され、ブラシが使用されるときにレンダーターゲットにマッピングされます。始点と終点の座標は絶対的なものであり、レンダーターゲットのサイズに対する相対値ではないことに注意してください。値 (0, 0) はレンダーターゲットの左上隅にマッピングされ、値 (1, 1) は (0, 0) から対角方向に 1 ピクセルだけ離れた位置にマッピングされます。恒等変換ではないブラシ変換またはレンダーターゲット変換が存在する場合、ブラシの楕円とグラデーションの原点も変換されます。

塗りつぶされる領域を完全には満たさない楕円を指定することもできます。この場合、(ブラシの ID2D1GradientStopCollection によって指定される) D2D1_EXTEND_MODE 設定によって、残りの領域がどのように塗りつぶされるかが決まります。

ID2D1RadialGradientBrush オブジェクトの作成

放射状グラデーションブラシを作成するには、ブラシを使用するレンダーターゲットの ID2D1RenderTarget::CreateRadialGradientBrush メソッドを使用します。ブラシは、それを作成したレンダーターゲット、またはそのレンダーターゲットと互換性のあるターゲットでのみ使用できます。

放射状グラデーションブラシはデバイス依存のリソースです。アプリケーションは、ブラシを使用するレンダーターゲットを初期化した後に放射状グラデーションブラシを作成し、レンダーターゲットの再作成が必要になるたびにブラシを再作成する必要があります。(リソースの詳細については、Resources Overview を参照してください。)

放射状グラデーションブラシの作成方法の例については、How to Create a Radial Gradient Brush のトピックを参照してください。

メソッド 9

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 8 void SetCenter(D2D_POINT_2F center)

グラデーション楕円の中心を、ブラシの座標空間で指定します。

centerD2D_POINT_2Finグラデーション楕円の中心。ブラシの座標空間で表されます。
vtbl 9 void SetGradientOriginOffset(D2D_POINT_2F gradientOriginOffset)

グラデーション楕円の中心を基準とした、グラデーション原点のオフセットを指定します。

gradientOriginOffsetD2D_POINT_2Finグラデーション楕円の中心からのグラデーション原点のオフセット。
vtbl 10 void SetRadiusX(FLOAT radiusX)

グラデーション楕円の x 半径を、ブラシの座標空間で指定します。

radiusXFLOATinグラデーション楕円の x 半径。この値はブラシの座標空間で表されます。
vtbl 11 void SetRadiusY(FLOAT radiusY)

グラデーション楕円の y 半径を、ブラシの座標空間で指定します。

radiusYFLOATinグラデーション楕円の y 半径。この値はブラシの座標空間で表されます。
vtbl 12 D2D_POINT_2F GetCenter()

グラデーション楕円の中心を取得します。

戻り値

型: D2D1_POINT_2F

グラデーション楕円の中心。この値はブラシの座標空間で表されます。

vtbl 13 D2D_POINT_2F GetGradientOriginOffset()

グラデーション楕円の中心を基準とした、グラデーション原点のオフセットを取得します。

戻り値

型: D2D1_POINT_2F

グラデーション楕円の中心からのグラデーション原点のオフセット。この値はブラシの座標空間で表されます。

vtbl 14 FLOAT GetRadiusX()

グラデーション楕円の x 半径を取得します。

戻り値

型: FLOAT

グラデーション楕円の x 半径。この値はブラシの座標空間で表されます。

vtbl 15 FLOAT GetRadiusY()

グラデーション楕円の y 半径を取得します。

戻り値

型: FLOAT

グラデーション楕円の y 半径。この値はブラシの座標空間で表されます。

vtbl 16 void GetGradientStopCollection(ID2D1GradientStopCollection** gradientStopCollection)

この放射状グラデーションブラシオブジェクトに関連付けられた ID2D1GradientStopCollection を取得します。

gradientStopCollectionID2D1GradientStopCollection**outこの線形グラデーションブラシオブジェクトに関連付けられた ID2D1GradientStopCollection オブジェクト。このパラメーターは未初期化で渡されます。

解説(Remarks)

ID2D1GradientStopCollection には、D2D1_GRADIENT_STOP 構造体の配列に加えて、拡張モードや色補間モードなどの追加情報が含まれます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"

#define global IID_ID2D1RadialGradientBrush "{2CD906AC-12E2-11DC-9FED-001143A055F9}"
#usecom global ID2D1RadialGradientBrush IID_ID2D1RadialGradientBrush "{}"
#comfunc global ID2D1RadialGradientBrush_SetCenter                  8 int
#comfunc global ID2D1RadialGradientBrush_SetGradientOriginOffset    9 int
#comfunc global ID2D1RadialGradientBrush_SetRadiusX                 10 float
#comfunc global ID2D1RadialGradientBrush_SetRadiusY                 11 float
#comfunc global ID2D1RadialGradientBrush_GetCenter                  12
#comfunc global ID2D1RadialGradientBrush_GetGradientOriginOffset    13
#comfunc global ID2D1RadialGradientBrush_GetRadiusX                 14
#comfunc global ID2D1RadialGradientBrush_GetRadiusY                 15
#comfunc global ID2D1RadialGradientBrush_GetGradientStopCollection  16 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。