IDCompositionTranslateTransform::SetOffsetX(float) method (dcomp.h)

Changes the value of the OffsetX property of a 2D translation transform. The OffsetX property specifies the distance to translate along the x-axis.

Syntax

HRESULT SetOffsetX(
  [in] float offsetX
);

Parameters

[in] offsetX

Type: float

The distance to translate along the x-axis, in pixels.

Return value

Type: HRESULT

If the function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. See DirectComposition Error Codes for a list of error codes.

Remarks

This method performs an affine transformation, which moves every point by a fixed distance in the same direction. It is similar to shifting the origin of the coordinate space.

This method fails if the offsetX parameter is NaN, positive infinity, or negative infinity.

If the OffsetX property was previously animated, this method removes the animation and sets the OffsetX property to the specified static value.

Requirements

See also

IDCompositionTranslateTransform

IDCompositionTranslateTransform::SetOffsetY