XMVector3ClampLengthV function (directxmath.h)

Article
07/27/2022

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

Syntax

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

Parameters

[in] V

3D vector to clamp.

[in] LengthMin

3D vector whose x, y, and z-components are equal to the minimum clamp length. The x, y, and z-components must be greater-than-or-equal to zero.

[in] LengthMax

3D vector whose x, y, and z-components are equal to the minimum clamp length. The x, y, and z-components must be greater-than-or-equal to zero.

Return value

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

Remarks

This function is identical to XMVector3ClampLength except that LengthMin and LengthMax are supplied using 3D 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)