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

ID2D1StrokeStyle

COM
IID2cd9069d-12e2-11dc-9fed-001143a055f9継承元ID2D1Resource自前メソッド開始 vtbl4

公式ドキュメント

ストロークのキャップ、マイター制限、線の結合、破線情報を記述します。(ID2D1StrokeStyle)

解説(Remarks)

ID2D1StrokeStyle オブジェクトの作成

ストロークスタイルを作成するには、ID2D1Factory::CreateStrokeStyle メソッドを使用します。

ストロークスタイルはデバイスに依存しないリソースです。一度作成すれば、アプリケーションの存続期間を通じて保持できます。リソースの詳細については、Resources Overview を参照してください。

次の例では、カスタム破線パターンを使用するストロークを作成します。

// Dash array for dashStyle D2D1_DASH_STYLE_CUSTOM
float dashes[] = {1.0f, 2.0f, 2.0f, 3.0f, 2.0f, 2.0f};

// Stroke Style with Dash Style -- Custom
if (SUCCEEDED(hr))
{
    hr = m_pD2DFactory->CreateStrokeStyle(
        D2D1::StrokeStyleProperties(
            D2D1_CAP_STYLE_FLAT,
            D2D1_CAP_STYLE_FLAT,
            D2D1_CAP_STYLE_ROUND,
            D2D1_LINE_JOIN_MITER,
            10.0f,
            D2D1_DASH_STYLE_CUSTOM,
            0.0f),
        dashes,
        ARRAYSIZE(dashes),
        &m_pStrokeStyleCustomOffsetZero
        );
}

次の例では、線を描画する際にこのストロークスタイルを使用します。

m_pRenderTarget->DrawLine(
    D2D1::Point2F(0, 310),
    D2D1::Point2F(200, 310),
    m_pCornflowerBlueBrush,
    10.0f,
    m_pStrokeStyleCustomOffsetZero
    );

メソッド 9

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

vtbl 4 D2D1_CAP_STYLE GetStartCap()

ストロークの始点に使用される形状の種類を取得します。

戻り値

型: D2D1_CAP_STYLE

ストロークの始点に使用される形状の種類。

vtbl 5 D2D1_CAP_STYLE GetEndCap()

ストロークの終点に使用される形状の種類を取得します。

戻り値

型: D2D1_CAP_STYLE

ストロークの終点に使用される形状の種類。

vtbl 6 D2D1_CAP_STYLE GetDashCap()

各破線の端をどのように描画するかを指定する値を取得します。

戻り値

型: D2D1_CAP_STYLE

各破線の端をどのように描画するかを指定する値。

vtbl 7 FLOAT GetMiterLimit()

マイター長とストローク太さの半分との比率の上限を取得します。

戻り値

型: FLOAT

マイター長とストローク太さの半分との比率の上限を表す、1.0f 以上の正の数。

vtbl 8 D2D1_LINE_JOIN GetLineJoin()

図形のアウトラインの頂点で使用される結合の種類を取得します。

戻り値

型: D2D1_LINE_JOIN

図形のアウトラインの頂点で使用される結合の種類を指定する値。

vtbl 9 FLOAT GetDashOffset()

破線シーケンスのどの位置からストロークを開始するかを指定する値を取得します。

戻り値

型: FLOAT

破線シーケンスのどの位置からストロークを開始するかを指定する値。

vtbl 10 D2D1_DASH_STYLE GetDashStyle()

ストロークの破線パターンを表す値を取得します。

戻り値

型: D2D1_DASH_STYLE

使用される定義済みの破線パターンを表す値。カスタム破線スタイルが使用されている場合は D2D1_DASH_STYLE_CUSTOM

解説(Remarks)

カスタム破線スタイルが指定されている場合、破線パターンは dashes 配列によって記述され、この配列は GetDashes メソッドを呼び出すことで取得できます。

vtbl 11 DWORD GetDashesCount()

dashes 配列内のエントリ数を取得します。

戻り値

型: UINT32

ストロークが破線の場合は dashes 配列内のエントリ数。それ以外の場合は 0。

vtbl 12 void GetDashes(FLOAT* dashes, DWORD dashesCount)

破線パターンを指定された配列にコピーします。

dashesFLOAT*out破線パターンを受け取る配列へのポインター。この配列は、少なくとも dashesCount で指定された数の要素を格納できる必要があります。この配列のストレージは自分で割り当てる必要があります。
dashesCountDWORDinコピーする破線の数。この値がストロークスタイルの dashes 配列内の破線の数より小さい場合、返される破線は dashesCount に切り詰められます。この値がストロークスタイルの dashes 配列内の破線の数より大きい場合、余分な破線は 0.0f に設定されます。ストロークスタイルの dashes 配列内の実際の破線の数を取得するには、GetDashesCount メソッドを使用します。

解説(Remarks)

破線は、ストローク幅の倍数を単位として指定されます。配列の各メンバーは破線と破線間のギャップを順に示します。最初のエントリは塗りつぶされた破線を、2 番目はギャップを、というように交互に表します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ID2D1StrokeStyle "{2CD9069D-12E2-11DC-9FED-001143A055F9}"
#usecom global ID2D1StrokeStyle IID_ID2D1StrokeStyle "{}"
#comfunc global ID2D1StrokeStyle_GetStartCap     4
#comfunc global ID2D1StrokeStyle_GetEndCap       5
#comfunc global ID2D1StrokeStyle_GetDashCap      6
#comfunc global ID2D1StrokeStyle_GetMiterLimit   7
#comfunc global ID2D1StrokeStyle_GetLineJoin     8
#comfunc global ID2D1StrokeStyle_GetDashOffset   9
#comfunc global ID2D1StrokeStyle_GetDashStyle    10
#comfunc global ID2D1StrokeStyle_GetDashesCount  11
#comfunc global ID2D1StrokeStyle_GetDashes       12 var,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。