XMMin template

Article
03/22/2021

Compares two numeric data type instances, or two instances of an object which supports an overload of <, and returns the smaller one of the two instances. The data type of the arguments and the return value is the same.

Syntax

template<class T> T XMMin(
  [in]  T a,
  [in]  T b
);

Parameters

a: [in] Specifies the first of two objects.
b: [in] Specifies the two of two objects.

Return Value

Returns the smaller of the two input objects.

Remarks

XMMin is a template and the T type is specified when the template is instantiated.

Note

The XMMin template is new for DirectXMath and is not available for XNAMath 2.x. XMMin is available as a macro in XNAMath 2.x.

Note

Ideally use std::min instead of XMMin. To avoid conflicts with Windows headers with std::min, you need to #define NOMINMAX before you include Windows headers.

Namespace: Use DirectX

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
Header	DirectXMath.h