XMVectorSplatConstant function (directxmath.h)

Article
02/22/2024

Creates a vector with identical floating-point components. Each component is a constant divided by two raised to an integer exponent.

Syntax

XMVECTOR XM_CALLCONV XMVectorSplatConstant(
  [in] int32_t  IntConstant,
  [in] uint32_t DivExponent
) noexcept;

Parameters

[in] IntConstant

This value will be converted to a floating-point number and divided by two raised to the DivExponent power. The result is replicated to each component of the returned vector.

The value of IntConstant must satisfy: -16 <= IntConstant <=15.

Note This parameter must be a number (an immediate value) and not a variable.

[in] DivExponent

Describes the exponent applied to the quotient. This parameter must be a number (an immediate value) and not a variable.

Return value

Returns an XMVECTOR with identical floating-point components. Each component is a constant divided by two raised to an integer exponent.

Remarks

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