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

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

構文

HRESULT SetOffsetX(
  [in] float offsetX
);

パラメーター

[in] offsetX

型: float

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

戻り値

種類: HRESULT

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

解説

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

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

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

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

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

例

例については、「 How to Build a Simple Visual Tree」を参照してください。

要件

関連項目

IDCompositionVisual

IDCompositionVisual::SetOffsetY

IDCompositionVisual::SetTransform