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

Article
02/22/2024

Changes the value of the OffsetY property of a 3D translation transform effect. The OffsetY property specifies the distance to translate along the y-axis.

Syntax

HRESULT SetOffsetY(
  [in] float offsetY
);

Parameters

[in] offsetY

Type: float

The distance to translate along the y-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 offsetY parameter is NaN, positive infinity, or negative infinity.

If the OffsetY property was previously animated, this method removes the animation and sets the OffsetY 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