IDCompositionRotateTransform3D::SetAxisZ(float) method (dcomp.h)

Article
10/13/2021

Changes the value of the AxisZ property of a 3D rotation transform. The AxisZ property specifies the z-coordinate for the axis vector of rotation. The default value is 1.0.

Syntax

HRESULT SetAxisZ(
  [in] float axisZ
);

Parameters

[in] axisZ

Type: float

The new z-coordinate for the axis vector of rotation.

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

When setting the axis to a non-default value, you should always set all three axis properties (AxisX, AxisY, and AxisZ).

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

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