ID2D1EffectImpl

カスタムエフェクトのインターフェイスと動作を、エフェクトの作成者が指定できるようにします。

このインターフェイスは、ID2D1Factory::RegisterEffect メソッドを通じて登録された静的ファクトリから、エフェクトの作成者によって作成されます。

エフェクトは、このメソッドを使用して一度限りの初期化タスクを実行できます。

Type: HRESULT

メソッドが成功した場合は S_OK を返します。失敗した場合は HRESULT エラーコードを返します。

これにより、リソース作成のコストがレンダリング中ではなく CreateEffect 呼び出しに移されます。

実装がこの呼び出しに失敗した場合、対応する ID2D1DeviceContext::CreateEffect 呼び出しも失敗します。

次の例は、初期化メソッドを実装するエフェクトを示しています。

例

ここでの例は、初期化メソッドを実装するエフェクトを示しています。

class CEffectImplementation : public ID2D1EffectImpl
{
public:

    virtual ~CEffectImplementation()
    {
        if (_pContextInternal != NULL)
        {
            _pContextInternal->Release();
        }
    }

    IFACEMETHODIMP Initialize(__in ID2D1DeviceContextInternal *pContextInternal, __in ID2D1TransformGraph *pTransformGraph)
    {
        HRESULT hr = S_OK;

        _pContextInternal = pContextInternal;
        _pContextInternal->AddRef();

                                _pTransformGraph = pTransformGraph;
        _pTransformGraph>AddRef();

                                // Populate the transform graph.					    

        return S_OK;
    }

private:

    ID2D1EffectContext *_pContextInternal;
    ID2D1TransformGraph *_pTransformGraph;
};

レンダリング処理に向けてエフェクトを準備します。

Type: HRESULT

メソッドが成功した場合は S_OK を返します。失敗した場合は HRESULT エラーコードを返します。

このメソッドは、描画対象のエフェクトグラフ内にエフェクトが含まれるときに、レンダラーによって呼び出されます。

このメソッドは次の場合に呼び出されます。

• エフェクトが初期化されているが、まだ描画されていない場合。
• 前回の描画呼び出し以降にエフェクトのプロパティが設定された場合。
• エフェクトが前回描画されて以降にコンテキストの状態が変化した場合。

ほとんどのエフェクトは、この呼び出しが行われるまでリソースの作成やトポロジの指定を遅延させます。エフェクトはプロパティを保持し、最初に描画される際に、それらを具体的なレンダリング手法の集合にマッピングします。

例

エフェクトは通常、レンダリングされるまで待ってから現在の状態をスナップショットし、内包している各トランスフォームに適用します。

class CMyTransform : public ID2D1DrawTransform
{
public:

    // Transform methods omitted.
    
    HRESULT PrepareForRender(FLOAT radius);
};

class CEffectImplementation : public ID2D1EffectImpl
{
public:

    void SetRadius(FLOAT radius) { _radius = radius; }

    IFACEMETHODIMP PrepareForRender(D2D1_CHANGE_TYPE /*type*/)
    {
        // Send the radius to the transform and ask it to render.
        return _pMyTransform->PrepareForRender(_radius);
    }

private:

    CMyTransform *_pMyTransform;
    FLOAT _radius;
};

レンダラーはこのメソッドを呼び出し、エフェクトの実装に対して、そのトランスフォームグラフおよびトランスフォームグラフの変更を指定する手段を提供します。

Type: HRESULT

CreateEffect 呼び出しの一部として呼び出された場合に、エフェクトの初期化を妨げるエラーです。後続の SetGraph 呼び出しでエフェクトが失敗した場合は次のとおりです。

• このエラーは、エフェクトへの入力数を変化させる原因となったプロパティメソッドから返されます。
• エフェクトオブジェクトはエラー状態になります。以降レンダリングに使用されると、コンテキストは一時的なエラー状態になり、その特定のエフェクトはレンダリングに失敗し、次の EndDraw または Flush 呼び出しでその失敗が返されます。