D3DXSHAdd function (D3dx9math.h) - Win32 apps (original) (raw)

Note

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

Adds two spherical harmonic (SH) vectors; in other words, pOut[i] = pA[i] + pB[i].

Syntax

FLOAT* D3DXSHAdd(
  _Out_       FLOAT *pOut,
  _In_        UINT  Order,
  _In_  const FLOAT *pA,
  _In_  const FLOAT *pB
);

Parameters

pOut [out]

Type: FLOAT*

Pointer to SH output coefficients. The evaluation generates Order² coefficients. See Remarks.

Order [in]

Type: UINT

Order of the 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*

Pointer to 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