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

ID2D1Factory

COM
IID06152247-6f50-465a-9245-118bfd3b6007継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

Direct2D リソースを作成します。(ID2D1Factory)

解説(Remarks)

ID2D1Factory インターフェイスは、Direct2D を使用するための出発点です。図形の描画や記述に使用するその他の Direct2D リソースを作成するために使用します。

ファクトリは、次の描画リソースを生成できる一連の CreateResource メソッドを定義します。

ID2D1Factory を作成するには、CreateFactory メソッドのいずれかを使用します。Direct2D リソースを使用している間は、ID2D1Factory インスタンスを保持しておく必要があります。通常、アプリケーションの実行中にこれを再作成する必要はありません。Direct2D リソースの詳細については、Resources Overview を参照してください。

シングルスレッド ファクトリとマルチスレッド ファクトリ

ファクトリを作成するときに、それをマルチスレッドにするかシングルスレッドにするかを指定できます。シングルスレッド ファクトリは、Direct2D 内の他のシングルスレッド インスタンスに対して一切のシリアル化を行わないため、この仕組みは CPU 上で非常に高いスケーラビリティを実現します。

マルチスレッド ファクトリ インスタンスを作成することもできます。この場合、ファクトリとそこから派生したすべてのオブジェクトを任意のスレッドから使用でき、各レンダー ターゲットに対して独立してレンダリングできます。Direct2D はこれらのオブジェクトへの呼び出しをシリアル化するため、単一のマルチスレッド Direct2D インスタンスは、多数のシングルスレッド インスタンスほどには CPU 上でスケールしません。ただし、マルチスレッド インスタンス内ではリソースを共有できます。

「On the CPU (CPU 上で)」という限定に注意してください。GPU は一般に、CPU よりもきめ細かい並列性を活用します。たとえば、CPU からのマルチスレッド呼び出しは、GPU に送られる際には結局シリアル化される場合がありますが、レンダリングを実行するために多数のピクセル シェーダーおよび頂点シェーダーが並列で動作します。

詳細については、Multithreaded Direct2D Apps を参照してください。

次のコード フラグメントは、ファクトリ ポインターを宣言し、シングルスレッド ファクトリ インスタンスを作成し、そのファクトリを使用してレンダー ターゲットを作成します。

ID2D1Factory* m_pDirect2dFactory;
    // Create a Direct2D factory.
    hr = D2D1CreateFactory(D2D1_FACTORY_TYPE_SINGLE_THREADED, &m_pDirect2dFactory);
        // Create a Direct2D render target.
        hr = m_pDirect2dFactory->CreateHwndRenderTarget(
            D2D1::RenderTargetProperties(),
            D2D1::HwndRenderTargetProperties(m_hwnd, size),
            &m_pRenderTarget
            );

メソッド 14

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

vtbl 3 HRESULT ReloadSystemMetrics()

ファクトリの作成以降に変更された可能性のあるシステム既定値を、ファクトリに強制的に再読み込みさせます。

戻り値

Type: HRESULT

このメソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

解説(Remarks)

システム DPI が最新であることを保証するには、GetDesktopDpi メソッドを呼び出す前に ID2D1Factory.ReloadSystemMetrics を呼び出す必要があります。

vtbl 4 void GetDesktopDpi(FLOAT* dpiX, FLOAT* dpiY)

現在のデスクトップの dots per inch (DPI) を取得します。この値を更新するには、ReloadSystemMetrics を呼び出します。

dpiXFLOAT*outこのメソッドが返るときに、デスクトップの水平方向の DPI が格納されます。このパラメーターには記憶域を割り当てておく必要があります。
dpiYFLOAT*outこのメソッドが返るときに、デスクトップの垂直方向の DPI が格納されます。このパラメーターには記憶域を割り当てておく必要があります。

解説(Remarks)

ウィンドウのサイズを指定する場合など、物理ピクセル値を設定する際にシステム DPI を取得するには、このメソッドを使用します。

vtbl 5 HRESULT CreateRectangleGeometry(D2D_RECT_F* rectangle, ID2D1RectangleGeometry** rectangleGeometry)
rectangleD2D_RECT_F*inジオメトリ化する矩形の座標へのポインタ。
rectangleGeometryID2D1RectangleGeometry**out作成された矩形ジオメトリを受け取る出力ポインタ。
vtbl 6 HRESULT CreateRoundedRectangleGeometry(D2D1_ROUNDED_RECT* roundedRectangle, ID2D1RoundedRectangleGeometry** roundedRectangleGeometry)
roundedRectangleD2D1_ROUNDED_RECT*inジオメトリ化する角丸矩形の定義へのポインタ。
roundedRectangleGeometryID2D1RoundedRectangleGeometry**out作成された角丸矩形ジオメトリを受け取る出力ポインタ。
vtbl 7 HRESULT CreateEllipseGeometry(D2D1_ELLIPSE* ellipse, ID2D1EllipseGeometry** ellipseGeometry)
ellipseD2D1_ELLIPSE*inジオメトリ化する楕円の定義へのポインタ。
ellipseGeometryID2D1EllipseGeometry**out作成された楕円ジオメトリを受け取る出力ポインタ。
vtbl 8 HRESULT CreateGeometryGroup(D2D1_FILL_MODE fillMode, ID2D1Geometry** geometries, DWORD geometriesCount, ID2D1GeometryGroup** geometryGroup)

他のジオメトリを保持するオブジェクトである ID2D1GeometryGroup を作成します。

fillModeD2D1_FILL_MODEin複合形状が、指定した点をジオメトリの一部と見なすかどうかを判定するために使用する規則を指定する値です。
geometriesID2D1Geometry**inジオメトリ グループに追加するジオメトリ オブジェクトを格納した配列です。この配列の要素数は geometriesCount パラメーターで示されます。
geometriesCountDWORDingeometries の要素数です。
geometryGroupID2D1GeometryGroup**outこのメソッドが返るときに、このメソッドが作成したジオメトリ グループへのポインターのアドレスが格納されます。

戻り値

Type: HRESULT

このメソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

解説(Remarks)

ジオメトリ グループは、複数のジオメトリを同時にグループ化し、複数の異なるジオメトリのすべての図形を 1 つに連結する便利な方法です。ID2D1GeometryGroup オブジェクトを作成するには、ID2D1Factory オブジェクトの CreateGeometryGroup メソッドを呼び出し、D2D1_FILL_MODE_ALTERNATE (alternate) または D2D1_FILL_MODE_WINDING を取り得る値とする fillMode、ジオメトリ グループに追加するジオメトリ オブジェクトの配列、およびこの配列の要素数を渡します。

次のコード例では、まずジオメトリ オブジェクトの配列を宣言します。これらのオブジェクトは、半径 25、50、75、100 の 4 つの同心円です。次に、ID2D1Factory オブジェクトの CreateGeometryGroup を呼び出し、D2D1_FILL_MODE_ALTERNATE、ジオメトリ グループに追加するジオメトリ オブジェクトの配列、およびこの配列の要素数を渡します。

ID2D1Geometry *ppGeometries[] =
{
    m_pEllipseGeometry1,
    m_pEllipseGeometry2,
    m_pEllipseGeometry3,
    m_pEllipseGeometry4
};

hr = m_pD2DFactory->CreateGeometryGroup(
    D2D1_FILL_MODE_ALTERNATE,
    ppGeometries,
    ARRAYSIZE(ppGeometries),
    &m_pGeoGroup_AlternateFill
    );

if (SUCCEEDED(hr))
{
    hr = m_pD2DFactory->CreateGeometryGroup(
        D2D1_FILL_MODE_WINDING,
        ppGeometries,
        ARRAYSIZE(ppGeometries),
        &m_pGeoGroup_WindingFill
        );
}

次の図は、この例の 2 つのグループ ジオメトリをレンダリングした結果を示しています。

4 つの同心円が 2 組ある図。一方は 2 番目と 4 番目のリングが塗りつぶされ、もう一方はすべてのリングが塗りつぶされている
vtbl 9 HRESULT CreateTransformedGeometry(ID2D1Geometry* sourceGeometry, D2D_MATRIX_3X2_F* transform, ID2D1TransformedGeometry** transformedGeometry)
sourceGeometryID2D1Geometry*in変換を適用する元ジオメトリへのポインタ。
transformD2D_MATRIX_3X2_F*in元ジオメトリに適用する変換行列へのポインタ。
transformedGeometryID2D1TransformedGeometry**out作成された変換済みジオメトリを受け取る出力ポインタ。
vtbl 10 HRESULT CreatePathGeometry(ID2D1PathGeometry** pathGeometry)

空の ID2D1PathGeometry を作成します。

pathGeometryID2D1PathGeometry**outこのメソッドが返るときに、このメソッドが作成したパス ジオメトリへのポインターのアドレスが格納されます。

戻り値

Type: HRESULT

このメソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

vtbl 11 HRESULT CreateStrokeStyle(D2D1_STROKE_STYLE_PROPERTIES* strokeStyleProperties, FLOAT* dashes, DWORD dashesCount, ID2D1StrokeStyle** strokeStyle)
strokeStylePropertiesD2D1_STROKE_STYLE_PROPERTIES*in線端・継ぎ目・破線などのストローク属性へのポインタ。
dashesFLOAT*inoptional破線パターンの各長さを指定するFLOAT配列。NULL可。
dashesCountDWORDindashes配列の要素数。0で実線となる。
strokeStyleID2D1StrokeStyle**out作成されたストロークスタイルを受け取る出力ポインタ。
vtbl 12 HRESULT CreateDrawingStateBlock(D2D1_DRAWING_STATE_DESCRIPTION* drawingStateDescription, IDWriteRenderingParams* textRenderingParams, ID2D1DrawingStateBlock** drawingStateBlock)
drawingStateDescriptionD2D1_DRAWING_STATE_DESCRIPTION*inoptional初期描画状態を指定する記述子へのポインタ。NULL可で既定値。
textRenderingParamsIDWriteRenderingParams*inoptional初期テキストレンダリングパラメータ。NULL可。
drawingStateBlockID2D1DrawingStateBlock**out作成された描画状態ブロックを受け取る出力ポインタ。
vtbl 13 HRESULT CreateWicBitmapRenderTarget(IWICBitmap* target, D2D1_RENDER_TARGET_PROPERTIES* renderTargetProperties, ID2D1RenderTarget** renderTarget)
targetIWICBitmap*in描画先となるWICビットマップへのポインタ。
renderTargetPropertiesD2D1_RENDER_TARGET_PROPERTIES*inピクセル形式やDPIなどのレンダーターゲット属性へのポインタ。
renderTargetID2D1RenderTarget**out作成されたレンダーターゲットを受け取る出力ポインタ。
vtbl 14 HRESULT CreateHwndRenderTarget(D2D1_RENDER_TARGET_PROPERTIES* renderTargetProperties, D2D1_HWND_RENDER_TARGET_PROPERTIES* hwndRenderTargetProperties, ID2D1HwndRenderTarget** hwndRenderTarget)
renderTargetPropertiesD2D1_RENDER_TARGET_PROPERTIES*inピクセル形式やDPIなどの共通レンダーターゲット属性へのポインタ。
hwndRenderTargetPropertiesD2D1_HWND_RENDER_TARGET_PROPERTIES*in対象ウィンドウハンドルやサイズなどHWND固有属性へのポインタ。
hwndRenderTargetID2D1HwndRenderTarget**out作成されたHWNDレンダーターゲットを受け取る出力ポインタ。
vtbl 15 HRESULT CreateDxgiSurfaceRenderTarget(IDXGISurface* dxgiSurface, D2D1_RENDER_TARGET_PROPERTIES* renderTargetProperties, ID2D1RenderTarget** renderTarget)
dxgiSurfaceIDXGISurface*in描画先となるDXGIサーフェスへのポインタ。
renderTargetPropertiesD2D1_RENDER_TARGET_PROPERTIES*inピクセル形式やDPIなどのレンダーターゲット属性へのポインタ。
renderTargetID2D1RenderTarget**out作成されたレンダーターゲットを受け取る出力ポインタ。
vtbl 16 HRESULT CreateDCRenderTarget(D2D1_RENDER_TARGET_PROPERTIES* renderTargetProperties, ID2D1DCRenderTarget** dcRenderTarget)

Windows Graphics Device Interface (GDI) デバイス コンテキストに描画するレンダー ターゲットを作成します。

renderTargetPropertiesD2D1_RENDER_TARGET_PROPERTIES*inレンダリング モード、ピクセル フォーマット、リモート処理オプション、DPI 情報、およびハードウェア レンダリングに必要な最小限の DirectX サポートです。デバイス コンテキスト (DC) レンダー ターゲットを GDI と連携させるには、DXGI フォーマットを DXGI_FORMAT_B8G8R8A8_UNORM に、アルファ モードを D2D1_ALPHA_MODE_PREMULTIPLIED または D2D1_ALPHA_MODE_IGNORE に設定します。ピクセル フォーマットの詳細については、Supported Pixel Formats and Alpha Modes を参照してください。
dcRenderTargetID2D1DCRenderTarget**outこのメソッドが返るときに、dcRenderTarget にはメソッドが作成した ID2D1DCRenderTarget へのポインターのアドレスが格納されます。

戻り値

Type: HRESULT

このメソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

解説(Remarks)

DC レンダー ターゲットでレンダリングする前に、レンダー ターゲットの BindDC メソッドを使用して、それを GDI DC に関連付ける必要があります。異なる DC ごとに、また描画対象領域のサイズが変わるたびに、この操作を行います。

DC レンダー ターゲットを GDI と連携させるには、レンダー ターゲットの DXGI フォーマットを DXGI_FORMAT_B8G8R8A8_UNORM に、アルファ モードを D2D1_ALPHA_MODE_PREMULTIPLIED または D2D1_ALPHA_MODE_IGNORE に設定します。

アプリケーションはレンダー ターゲットを一度だけ作成し、アプリケーションの存続期間中、またはレンダー ターゲットの EndDraw メソッドが D2DERR_RECREATE_TARGET エラーを返すまで保持し続ける必要があります。このエラーを受け取ったら、レンダー ターゲット (およびそれが作成したすべてのリソース) を再作成します。

次のコードは DC レンダー ターゲットを作成します。

// Create a DC render target.
D2D1_RENDER_TARGET_PROPERTIES props = D2D1::RenderTargetProperties(
    D2D1_RENDER_TARGET_TYPE_DEFAULT,
    D2D1::PixelFormat(
        DXGI_FORMAT_B8G8R8A8_UNORM,
        D2D1_ALPHA_MODE_IGNORE),
    0,
    0,
    D2D1_RENDER_TARGET_USAGE_NONE,
    D2D1_FEATURE_LEVEL_DEFAULT
    );

hr = m_pD2DFactory->CreateDCRenderTarget(&props, &m_pDCRT);

上記のコードでは、m_pD2DFactoryID2D1Factory へのポインターであり、m_pDCRTID2D1DCRenderTarget へのポインターです。

次のコード例は、DC を ID2D1DCRenderTarget にバインドします。

HRESULT DemoApp::OnRender(const PAINTSTRUCT &ps)
{
// Get the dimensions of the client drawing area.
GetClientRect(m_hwnd, &rc);
// Bind the DC to the DC render target.
hr = m_pDCRT->BindDC(ps.hdc, &rc);
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ID2D1Factory "{06152247-6F50-465A-9245-118BFD3B6007}"
#usecom global ID2D1Factory IID_ID2D1Factory "{}"
#comfunc global ID2D1Factory_ReloadSystemMetrics             3
#comfunc global ID2D1Factory_GetDesktopDpi                   4 var,var
#comfunc global ID2D1Factory_CreateRectangleGeometry         5 var,sptr
#comfunc global ID2D1Factory_CreateRoundedRectangleGeometry  6 var,sptr
#comfunc global ID2D1Factory_CreateEllipseGeometry           7 var,sptr
#comfunc global ID2D1Factory_CreateGeometryGroup             8 int,sptr,int,sptr
#comfunc global ID2D1Factory_CreateTransformedGeometry       9 sptr,var,sptr
#comfunc global ID2D1Factory_CreatePathGeometry              10 sptr
#comfunc global ID2D1Factory_CreateStrokeStyle               11 var,var,int,sptr
#comfunc global ID2D1Factory_CreateDrawingStateBlock         12 var,sptr,sptr
#comfunc global ID2D1Factory_CreateWicBitmapRenderTarget     13 sptr,var,sptr
#comfunc global ID2D1Factory_CreateHwndRenderTarget          14 var,var,sptr
#comfunc global ID2D1Factory_CreateDxgiSurfaceRenderTarget   15 sptr,var,sptr
#comfunc global ID2D1Factory_CreateDCRenderTarget            16 var,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。