IXpsOMObjectFactory::CreateImageBrush メソッド (xpsobjectmodel.h)

[アーティクル]
03/05/2024

構文

HRESULT CreateImageBrush(
  [in]          IXpsOMImageResource *image,
  [in]          const XPS_RECT      *viewBox,
  [in]          const XPS_RECT      *viewPort,
  [out, retval] IXpsOMImageBrush    **imageBrush
);

パラメーター

[in] image

ブラシのソースイメージとして使用するイメージを含む IXpsOMImageResource インターフェイス。

[in] viewBox

ビューボックスを定義するXPS_RECT構造体。これは、ブラシで使用されるソースイメージの領域です。

[in] viewPort

ビューポートを定義するXPS_RECT構造体。これは、出力領域の最初のタイルで覆われた領域です。

[out, retval] imageBrush

新しい IXpsOMImageBrush インターフェイスへのポインター。

戻り値

このメソッドは HRESULT を返します。使用可能な値には、次の表に含まれる値が含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、「 XPS ドキュメントエラー」を参照してください。

リターンコード	説明
S_OK	メソッドが成功しました。
E_POINTER	image、 viewBox、 viewPort、または imageBrush が NULL です。
E_INVALIDARG	viewBox または viewPort には、無効な四角形または値が含まれています。

注釈

ブラシの viewbox は、タイルイメージとして使用するソースイメージまたはビジュアルの部分を指定します。

ブラシのビューボックスの座標は、ソースコンテンツを基準にして相対的であり、(0,0) はソースコンテンツの左上隅を指定します。画像の場合、ブラシのビューボックスで指定された寸法は、1/96 の単位で表されます。ソースイメージ内の対応するピクセル座標は、次のように計算されます。

次の図では、左側の画像はソースイメージの例であり、右端はビューボックスを選択した後に発生するブラシです。

ソースイメージの解像度が 96 x 96 ドット/インチで、画像のサイズが 96 x 96 ピクセルの場合、 viewbox パラメーターのフィールドの値は次のようになります。

上記のパラメーター値は、次のようにソースイメージに対応しています。

SourceLeft = (96 × 48) / 96 = 左側から 48 ピクセル

SourceTop = (96 × 24) / 96 = 上から 24 ピクセル

SourceWidth = (96 × 24) / 96 = 24 ピクセル幅

SourceHeight = (96 × 48) / 96 = 48 ピクセルの高さ

イメージブラシは、イメージまたはその一部を受け取り、イメージを変換してタイルを作成し、結果のタイルをビューポート (出力領域のタイルの宛先ジオメトリ) に配置し、タイルモードで説明されているように出力領域を塗りつぶすタイルブラシです。

ビューポートは、出力領域の最初のタイルで覆われた領域です。ビューポートイメージは、タイルモードで説明されているように、出力領域全体で繰り返されます。

次の図は、画像ブラシを使用して出力領域を塗りつぶす方法を示しています。左から右へ、元のイメージがビューポートに塗りつぶされるように変換され、出力領域のビューポート領域に配置され、出力領域に塗りつぶされるように並べて表示されます。

次のコード例は、このメソッドを使用して新しいインターフェイスを作成する方法を示しています。


IXpsOMImageBrush            *newInterface;
// The following values are defined outside of 
// this example.
//  IXpsOMImageResource     *image;
//  XPS_RECT                viewBox;
//  XPS_RECT                viewPort;

// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

hr = CoCreateInstance(
    __uuidof(XpsOMObjectFactory),
    NULL,
    CLSCTX_INPROC_SERVER,
    _uuidof(IXpsOMObjectFactory),
    reinterpret_cast<LPVOID*>(&xpsFactory)
    );

if (SUCCEEDED(hr))
{
    hr = xpsFactory->CreateImageBrush (
        image,
        &viewBox,
        &viewPort,
        &newInterface);

    if (SUCCEEDED(hr))
    {
        // use newInterface

        newInterface->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}

要件

要件	値
サポートされている最小のクライアント	Windows 7、Windows Vista SP2 と Windows Vista 用プラットフォーム更新プログラム [デスクトップアプリ \|UWP アプリ]
サポートされている最小のサーバー	Windows Server 2008 R2、Windows Server 2008 SP2 および Windows Server 2008 用プラットフォーム更新プログラム [デスクトップアプリ \|UWP アプリ]
対象プラットフォーム	Windows
ヘッダー	xpsobjectmodel.h