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

ID2D1BitmapRenderTarget

COM
IID2cd90695-12e2-11dc-9fed-001143a055f9継承元ID2D1RenderTarget自前メソッド開始 vtbl57

公式ドキュメント

CreateCompatibleRenderTarget メソッドによって作成された中間テクスチャに描画します。

解説(Remarks)

ID2D1BitmapRenderTarget は中間テクスチャに書き込みます。ID2D1BitmapBrush で使用するパターンを作成したり、繰り返し使用する描画データをキャッシュしたりするのに便利です。

代わりに WIC ビットマップへ直接書き込むには、ID2D1Factory::CreateWicBitmapRenderTarget メソッドを使用します。このメソッドは、指定した WIC ビットマップに書き込む ID2D1RenderTarget を返します。

ID2D1BitmapRenderTarget オブジェクトの作成

ビットマップレンダーターゲットを作成するには、ID2D1RenderTarget::CreateCompatibleRenderTarget メソッドを呼び出します。

他のレンダーターゲットと同様に、ID2D1BitmapRenderTarget はデバイス依存のリソースであり、関連付けられたデバイスが利用できなくなったときには再作成する必要があります。詳細については、リソースの概要を参照してください。

次の例では、CreateCompatibleRenderTarget メソッドを使用して ID2D1BitmapRenderTarget を作成し、それを使ってグリッドパターンを描画します。このグリッドパターンは ID2D1BitmapBrush のソースとして使用されます。

HRESULT DemoApp::CreateGridPatternBrush(
    ID2D1RenderTarget *pRenderTarget,
    ID2D1BitmapBrush **ppBitmapBrush
    )
{
    // Create a compatible render target.
    ID2D1BitmapRenderTarget *pCompatibleRenderTarget = NULL;
    HRESULT hr = pRenderTarget->CreateCompatibleRenderTarget(
        D2D1::SizeF(10.0f, 10.0f),
        &pCompatibleRenderTarget
        );
    if (SUCCEEDED(hr))
    {
        // Draw a pattern.
        ID2D1SolidColorBrush *pGridBrush = NULL;
        hr = pCompatibleRenderTarget->CreateSolidColorBrush(
            D2D1::ColorF(D2D1::ColorF(0.93f, 0.94f, 0.96f, 1.0f)),
            &pGridBrush
            );
        if (SUCCEEDED(hr))
        {
            pCompatibleRenderTarget->BeginDraw();
            pCompatibleRenderTarget->FillRectangle(D2D1::RectF(0.0f, 0.0f, 10.0f, 1.0f), pGridBrush);
            pCompatibleRenderTarget->FillRectangle(D2D1::RectF(0.0f, 0.1f, 1.0f, 10.0f), pGridBrush);
            pCompatibleRenderTarget->EndDraw();

            // Retrieve the bitmap from the render target.
            ID2D1Bitmap *pGridBitmap = NULL;
            hr = pCompatibleRenderTarget->GetBitmap(&pGridBitmap);
            if (SUCCEEDED(hr))
            {
                // Choose the tiling mode for the bitmap brush.
                D2D1_BITMAP_BRUSH_PROPERTIES brushProperties =
                    D2D1::BitmapBrushProperties(D2D1_EXTEND_MODE_WRAP, D2D1_EXTEND_MODE_WRAP);

                // Create the bitmap brush.
                hr = m_pRenderTarget->CreateBitmapBrush(pGridBitmap, brushProperties, ppBitmapBrush);

                pGridBitmap->Release();
            }

            pGridBrush->Release();
        }

        pCompatibleRenderTarget->Release();
    }

    return hr;
}

次のコード例では、このブラシを使用してパターンを描画します。

// Paint a grid background.
m_pRenderTarget->FillRectangle(
    D2D1::RectF(0.0f, 0.0f, renderTargetSize.width, renderTargetSize.height),
    m_pGridPatternBitmapBrush
    );

この例ではコードの一部が省略されています。

メソッド 1

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

vtbl 57 HRESULT GetBitmap(ID2D1Bitmap** bitmap)

このレンダーターゲットのビットマップを取得します。返されたビットマップは描画操作に使用できます。

bitmapID2D1Bitmap**outこのメソッドが返るとき、このレンダーターゲットのビットマップへのポインターのアドレスが格納されます。このビットマップは描画操作に使用できます。

戻り値

型: HRESULT

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

解説(Remarks)

GetBitmap から取得される ID2D1Bitmap の DPI は、レンダーターゲットが作成されたときの ID2D1BitmapRenderTarget の DPI になります。SetDpi を呼び出して ID2D1BitmapRenderTarget の DPI を変更しても、ビットマップの DPI には影響しません。これは GetBitmap の前に SetDpi を呼び出した場合でも同様です。SetDpi を使用して ID2D1BitmapRenderTarget の DPI を変更すると、コンテンツがビットマップにどのようにレンダリングされるかには影響しますが、GetBitmap で取得されるビットマップの DPI には影響しません。

次の例では、CreateCompatibleRenderTarget メソッドを使用して ID2D1BitmapRenderTarget を作成し、それを使ってグリッドパターンを描画します。このグリッドパターンは ID2D1BitmapBrush のソースとして使用されます。

HRESULT DemoApp::CreateGridPatternBrush(
    ID2D1RenderTarget *pRenderTarget,
    ID2D1BitmapBrush **ppBitmapBrush
    )
{
    // Create a compatible render target.
    ID2D1BitmapRenderTarget *pCompatibleRenderTarget = NULL;
    HRESULT hr = pRenderTarget->CreateCompatibleRenderTarget(
        D2D1::SizeF(10.0f, 10.0f),
        &pCompatibleRenderTarget
        );
    if (SUCCEEDED(hr))
    {
        // Draw a pattern.
        ID2D1SolidColorBrush *pGridBrush = NULL;
        hr = pCompatibleRenderTarget->CreateSolidColorBrush(
            D2D1::ColorF(D2D1::ColorF(0.93f, 0.94f, 0.96f, 1.0f)),
            &pGridBrush
            );
        if (SUCCEEDED(hr))
        {
            pCompatibleRenderTarget->BeginDraw();
            pCompatibleRenderTarget->FillRectangle(D2D1::RectF(0.0f, 0.0f, 10.0f, 1.0f), pGridBrush);
            pCompatibleRenderTarget->FillRectangle(D2D1::RectF(0.0f, 0.1f, 1.0f, 10.0f), pGridBrush);
            pCompatibleRenderTarget->EndDraw();

            // Retrieve the bitmap from the render target.
            ID2D1Bitmap *pGridBitmap = NULL;
            hr = pCompatibleRenderTarget->GetBitmap(&pGridBitmap);
            if (SUCCEEDED(hr))
            {
                // Choose the tiling mode for the bitmap brush.
                D2D1_BITMAP_BRUSH_PROPERTIES brushProperties =
                    D2D1::BitmapBrushProperties(D2D1_EXTEND_MODE_WRAP, D2D1_EXTEND_MODE_WRAP);

                // Create the bitmap brush.
                hr = m_pRenderTarget->CreateBitmapBrush(pGridBitmap, brushProperties, ppBitmapBrush);

                pGridBitmap->Release();
            }

            pGridBrush->Release();
        }

        pCompatibleRenderTarget->Release();
    }

    return hr;
}

次のコード例では、このブラシを使用してパターンを描画します。

// Paint a grid background.
m_pRenderTarget->FillRectangle(
    D2D1::RectF(0.0f, 0.0f, renderTargetSize.width, renderTargetSize.height),
    m_pGridPatternBitmapBrush
    );

この例ではコードの一部が省略されています。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ID2D1BitmapRenderTarget "{2CD90695-12E2-11DC-9FED-001143A055F9}"
#usecom global ID2D1BitmapRenderTarget IID_ID2D1BitmapRenderTarget "{}"
#comfunc global ID2D1BitmapRenderTarget_GetBitmap  57 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。