XMMatrixRotationRollPitchYaw arguments order

[nlguillemot]

The function is named XMMatrixRotationRollPitchYaw, but its arguments are in a different order, which is a little tricky:

inline XMMATRIX XM_CALLCONV XMMatrixRotationRollPitchYaw
(
    float Pitch, 
    float Yaw, 
    float Roll
)

Don't know if there's an easy backwards-compatible fix to this problem, but I figure it should be documented as an issue anyways.

[walbourn]

The function name indicates the order of rotation which is roll, then pitch, then yaw. The parameter order itself is x-axis, y-axis, z-axis which makes a bit more sense with XMMatrixRotationRollPitchYawFromVector.

This is also true of the XMQuaternionRotationRollPitchYaw function, as well as XMQuaternionRotationRollPitchYawFromVector.

The original D3DXMath function D3DXMatrixRotationYawPitchRoll used parameter order of 'yaw', 'pitch', 'roll' but the actual order of the rotations was roll, then pitch, then yaw based on the convention of matrix notation. So, I'd argue the DirectXMath naming convention is probably a bit more consistent.