IDCompositionVisual::SetOffsetY(float) メソッド (dcomp.h)

このビジュアルの OffsetY プロパティの値を変更します。 OffsetY プロパティは、親ビジュアルを基準にして、y 軸に沿ったビジュアルの新しいオフセットを指定します。

構文

HRESULT SetOffsetY(
  [in] float offsetY
);

パラメーター

[in] offsetY

型: float

y 軸に沿ったビジュアルの新しいオフセット (ピクセル単位)。

戻り値

型: HRESULT

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

解説

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

OffsetY プロパティを変更すると、このビジュアルにルート化されたビジュアル サブツリー全体の座標系が変換されます。 このビジュアルの Clip プロパティを指定すると、クリップの四角形も変換されます。

Transform プロパティで指定された変換は、OffsetY プロパティの後に適用されます。 言い換えると、Transform プロパティと OffsetY プロパティの設定の効果は、グループの最初のメンバーが offsetY と同じ OffsetY 値を持つ IDCompositionTranslateTransform オブジェクトである変換グループ オブジェクトに対して Transform プロパティのみを設定する場合と同じです。 ただし、 IDCompositionVisual::SetOffsetY は少し高速であるため、可能な限り使用する必要があります。

OffsetX プロパティと OffsetY プロパティが 0 に設定されていて、Transform プロパティが NULL に設定されている場合、ビジュアルの座標系は親の座標系と同じです。

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

例

例については、「 単純なビジュアル ツリーを構築する方法」を参照してください。

要件

関連項目

IDCompositionVisual

IDCompositionVisual::SetOffsetX

IDCompositionVisual::SetTransform