IDCompositionAnimation::End メソッド (dcompanimation.h)

アニメーション関数の終了をマークする終了セグメントを追加します。

構文

HRESULT End(
  [in] double endOffset,
  [in] float  endValue
);

パラメーター

[in] endOffset

型: double

アニメーション関数の先頭から関数が終了した時点までのオフセット (秒単位)。

[in] endValue

型: float

アニメーションの最終的な値。

戻り値

型: HRESULT

関数が成功した場合は、S_OK を返します。 そうでない場合は、HRESULT エラー コードを返します。 エラー コードの一覧については、「 DirectComposition エラー コード 」を参照してください。

解説

指定したオフセットに達すると、このアニメーションの影響を受けるプロパティが、指定した最終値に設定され、アニメーションが停止します。 終了セグメントが追加されていない場合、アニメーション関数の最後のセグメントは無期限に実行されます。 このメソッドの呼び出しは、アニメーション関数の最後のセグメントを 3 次多項式にするのと意味的に同じです。3 次係数、2 次係数、線形係数はすべて 0 で、定数係数は目的の最終値です。

アニメーション セグメントは順に追加する必要があるため、 endOffset パラメーターが前のセグメントの beginOffset パラメーター以下の場合、このメソッドは失敗します。 このメソッドは、これがアニメーション関数に追加される最初のセグメントである場合にも失敗します。

このメソッドが呼び出されると、 IDCompositionAnimation::Reset メソッドを除き、このアニメーション オブジェクトのすべてのメソッドは失敗します。

要件

関連項目

IDCompositionAnimation