IDCompositionRectangleClip::SetTop(float) メソッド (dcomp.h)

クリップ四角形の Top プロパティの値を変更します。 Top プロパティは、クリップ四角形の左上隅の y 座標を指定します。

構文

HRESULT SetTop(
  [in] float top
);

[in] top

型: float

Top プロパティの新しい値 (ピクセル単位)。このパラメーターの数値の上限は -2^21 から 2^21 です。 API は、この範囲外の数値を受け入れますが、常にこの範囲に固定されます。

型: HRESULT

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

top パラメーターが NaN、正の無限大、または負の無限大の場合、このメソッドは失敗します。

Top プロパティが以前にアニメーション化されていた場合、このメソッドはアニメーションを削除し、Top プロパティを指定された静的値に設定します。