XMVector4ClampLengthV function (directxmath.h)

Article
02/22/2024

Clamps the length of a 4D vector to a given range.

Syntax

XMVECTOR XM_CALLCONV XMVector4ClampLengthV(
  [in] FXMVECTOR V,
  [in] FXMVECTOR LengthMin,
  [in] FXMVECTOR LengthMax
) noexcept;

Parameters

[in] V

4D vector to clamp.

[in] LengthMin

4D vector, all of whose components are equal to the minimum clamp length. The components must be greater-than-or-equal to zero.

[in] LengthMax

4D vector, all of whose components are equal to the maximum clamp length. The components must be greater-than-or-equal to zero.

Return value

Returns a 4D vector whose length is clamped to the specified minimum and maximum.

Remarks

This function is identical to XMVector4ClampLength except that LengthMin and LengthMax are supplied using 4D vectors instead of float values.

Platform Requirements

Microsoft Visual Studio 2010 or Microsoft Visual Studio 2012 with the Windows SDK for Windows 8. Supported for Win32 desktop apps, Windows Store apps, and Windows Phone 8 apps.

Requirements

Requirement	Value
Target Platform	Windows
Header	directxmath.h (include DirectXMath.h)