D3DXSHDot function (D3dx9math.h)

Article
04/28/2022

Note

The D3DX (D3DX 9, D3DX 10, and D3DX 11) utility library is deprecated and is not supported for Windows Store apps.

Note

Instead of using this function, we recommend that you use the Spherical Harmonics Math library function XMSHDot.

Computes the dot product of two spherical harmonic (SH) vectors.

Syntax

FLOAT D3DXSHDot(
  _In_       UINT  Order,
  _In_ const FLOAT *pA,
  _In_ const FLOAT *pB
);

Parameters

Order [in]

Type: UINT

Order of the spherical harmonic (SH) evaluation. Must be in the range of D3DXSH_MINORDER to D3DXSH_MAXORDER, inclusive. The evaluation generates Order² coefficients. The degree of the evaluation is Order - 1.

pA [in]

Type: const FLOAT*

Pointer to the first SH vector.

pB [in]

Type: const FLOAT*

Pointer to the second SH vector.

Return value

Type: FLOAT

SH output coefficients.

Remarks

Each coefficient of the basis function Yₗₘ is stored at memory location l² + m + l, where:

l is the degree of the basis function.
m is the basis function index for the given l value and ranges from -l to l, inclusive.

Requirements

Requirement	Value
Header	D3dx9math.h
Library	D3dx9.lib