Edit

D3DXQuaternionRotationYawPitchRoll function (D3dx9math.h)

  • Article

Note

The D3DX utility library is deprecated. We recommend that you use DirectXMath instead.

Builds a quaternion with the given yaw, pitch, and roll.

Syntax

D3DXQUATERNION* D3DXQuaternionRotationYawPitchRoll(
  _Inout_ D3DXQUATERNION *pOut,
  _In_    FLOAT          Yaw,
  _In_    FLOAT          Pitch,
  _In_    FLOAT          Roll
);

Parameters

pOut [in, out]

Type: D3DXQUATERNION*

Pointer to the D3DXQUATERNION structure that is the result of the operation.

Yaw [in]

Type: FLOAT

Yaw around the y-axis, in radians.

Pitch [in]

Type: FLOAT

Pitch around the x-axis, in radians.

Roll [in]

Type: FLOAT

Roll around the z-axis, in radians.

Return value

Type: D3DXQUATERNION*

Pointer to a D3DXQUATERNION structure with the specified yaw, pitch, and roll.

Remarks

The return value for this function is the same value returned in the pOut parameter. In this way, the D3DXQuaternionRotationYawPitchRoll function can be used as a parameter for another function.

Use D3DXQuaternionNormalize for any quaternion input that is not already normalized.

Requirements

Requirement Value
Header
D3dx9math.h
Library
D3dx9.lib

See also

Math Functions

D3DXQuaternionRotationAxis

D3DXQuaternionRotationMatrix