Function directx_math::XMVectorShiftLeft[][src]

pub fn XMVectorShiftLeft(
    V1: FXMVECTOR,
    V2: FXMVECTOR,
    Elements: u32
) -> XMVECTOR

Shifts a vector left by a given number of 32-bit elements, filling the vacated elements with elements from a second vector.

Parameters

V1 Vector to shift left.

V2 Vector used to fill in the vacated components of V1 after it is shifted left.

Elements Number of 32-bit elements by which to shift V left. This parameter must be 0, 1, 2, or 3.

Return value

Returns the shifted and filled in XMVECTOR.

Remarks

The following code demonstrates how this function might be used.

XMVECTOR v1 = XMVectorSet( 10.0f, 20.0f, 30.0f, 40.0f );
XMVECTOR v2 = XMVectorSet( 50.0f, 60.0f, 70.0f, 80.0f );
XMVECTOR result = XMVectorShiftLeft( v1, v2, 1 );

The shifted vector (result) will be <20.0, 30.0, 40.0, 50.0>.

In the case of a constant shift value, it is more efficent to use the template form of XMVectorShiftLeft:

Reference

https://docs.microsoft.com/en-us/windows/win32/api/directxmath/nf-directxmath-XMVectorShiftLeft