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

Changes the value of the OffsetX property of a 3D translation transform effect. 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 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

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header dcomp.h
Library Dcomp.lib
DLL Dcomp.dll

See also

IDCompositionTranslateTransform3D

IDCompositionTranslateTransform3D::SetOffsetY

IDCompositionTranslateTransform3D::SetOffsetZ