IXpsOMGradientStop

グラデーション内の単一の色と位置を表します。

グラデーションストップは、グラデーション領域内の特定の位置に対して定義された色です。グラデーションの色は、グラデーションストップとグラデーションストップの間で変化します。グラデーションの領域と絶対位置は、グラデーションインターフェイスによって定義されます。オフセットはグラデーション領域内の相対的な位置であり、0.0 から 1.0 の範囲で表されます。オフセット 0.0 はグラデーションの開始位置、1.0 は終了位置です。グラデーションストップは、両端を含むこの範囲内の任意のオフセットに定義できます。このインターフェイスは、グラデーション内の 1 つのストップのみを表します。

グラデーションパスは、線形グラデーションの開始点と終了点を結ぶ直線です。線形グラデーションのグラデーション領域は、開始点と終了点を含むそれらの間の領域であり、グラデーションパスに対して直角の方向に両側へ広がります。スプレッド領域は、グラデーション領域の外側の領域です。

グラデーションストップは、グラデーションパス上の特定の位置における色を定義します。色は、グラデーションストップの間でグラデーションパスに沿って補間されます。次の例では、グラデーション領域が画像全体を埋めているため、スプレッド領域はありません。

線形グラデーションブラシで使用されるグラデーションストップでは、オフセット値 0.0 がグラデーションパスの開始点に対応し、オフセット値 1.0 が終了点に対応します。この 2 点の間にあるグラデーションストップの位置は、中間のオフセット値を補間して決定されます。次の図は、オフセット 0.25 と 0.75 にある 2 つの中間グラデーションストップを示しています。

放射状グラデーションブラシで使用されるグラデーションストップでは、オフセット値 0.0 がグラデーションの原点の位置に対応し、オフセット値 1.0 がグラデーションを囲む楕円の円周に対応します。0.0 と 1.0 の間のオフセットは、グラデーションの原点と境界となる楕円の間で補間された楕円を定義します。次の図には、オフセット 0.50 に 1 つの中間グラデーションストップ (Gradient stop 1) があります。このグラデーションは、グラデーション領域の外側の空間を埋めるために XPS_SPREAD_METHOD_REFLECT スプレッドメソッドを使用しています。

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

IXpsOMGradientStop    *newInterface;
// 次の値は、この例の外部で
// 定義されています。
//  XPS_COLOR                    color;
//  IXpsOMColorProfileResource    *colorProfile;
//  FLOAT                        offset;

// このスレッドで CoInitializeEx が事前に呼び出されている
//  ことが暗黙の前提となる点に注意してください。

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

if (SUCCEEDED(hr))
{
    hr = xpsFactory->CreateGradientStop (
        &color,
        colorProfile,
        offset,
        &newInterface);

    if (SUCCEEDED(hr))
    {
        // newInterface を使用します

        newInterface->Release();
    }
    xpsFactory->Release();
}
else
{
    // hr で返された HRESULT エラーを評価します
}

グラデーションストップを含む IXpsOMGradientBrush インターフェイスへのポインターを取得します。

このメソッドは HRESULT を返します。指定できる値には次の表の値が含まれますが、これらに限定されるわけではありません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

グラデーションストップのオフセット値を取得します。

このメソッドは HRESULT を返します。指定できる値には次の表の値が含まれますが、これらに限定されるわけではありません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

offset に返される値の有効範囲は 0.0～1.0 です。0.0 はグラデーションの開始点、1.0 は終了点であり、0.0 と 1.0 の間の値は開始点と終了点の間を線形補間した位置を表します。

グラデーションストップのオフセット位置を設定します。

このメソッドは HRESULT を返します。指定できる値には次の表の値が含まれますが、これらに限定されるわけではありません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

グラデーションストップの色の値とカラープロファイルを取得します。

このメソッドは HRESULT を返します。指定できる値には次の表の値が含まれますが、これらに限定されるわけではありません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

カラープロファイルが返されるのは、color のカラータイプが XPS_COLOR_TYPE_CONTEXT の場合のみです。

グラデーションストップの色の値とカラープロファイルを設定します。

このメソッドは HRESULT を返します。指定できる値には次の表の値が含まれますが、これらに限定されるわけではありません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

カラープロファイルが必要なのは、color のカラータイプが XPS_COLOR_TYPE_CONTEXT の場合のみです。

IXpsOMGradientStop インターフェイスのディープコピーを作成します。

このメソッドは HRESULT を返します。指定できる値には次の表の値が含まれますが、これらに限定されるわけではありません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

新しいインターフェイスの所有者は NULL です。

このメソッドは、gradientStop に返される IXpsOMGradientStop インターフェイス内のリソースポインターを更新しません。