IDCompositionTranslateTransform3D::SetOffsetZ(float) method (dcomp.h)
Changes the value of the OffsetZ property of a 3D translation transform effect. The OffsetZ property specifies the distance to translate along the z-axis.
Syntax
HRESULT SetOffsetZ(
[in] float offsetZ
);
Parameters
[in] offsetZ
Type: float
The distance to translate along the z-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 offsetZ parameter is NaN, positive infinity, or negative infinity.
If the OffsetZ property was previously animated, this method removes the animation and sets the OffsetZ 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