D3DXQuaternionIdentity function
Note
The D3DX utility library is deprecated. We recommend that you use DirectXMath instead.
Returns the identity quaternion.
Syntax
D3DXQUATERNION* D3DXQuaternionIdentity(
_Inout_ D3DXQUATERNION *pOut
);
Parameters
-
pOut [in, out]
-
Type: D3DXQUATERNION*
Pointer to the D3DXQUATERNION structure that is the result of the operation.
Return value
Type: D3DXQUATERNION*
Pointer to the D3DXQUATERNION structure that is the identity quaternion.
Remarks
Given a quaternion (x, y, z, w), the D3DXQuaternionIdentity function will return the quaternion (0, 0, 0, 1).
The return value for this function is the same value returned in the pOut parameter. In this way, the D3DXQuaternionIdentity 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 |
|
| Library |
|
See also