D3DXSHScale function (D3DX10.h)
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 XMSHScale.
Scales a spherical harmonic (SH) vector; in other words, pOut[i] = pA[i]*Scale.
Syntax
FLOAT* D3DXSHScale(
_In_ FLOAT *pOut,
_In_ UINT Order,
_In_ const FLOAT *pIn,
_In_ const FLOAT Scale
);
Parameters
-
pOut [in]
-
Type: FLOAT*
Pointer to Spherical harmonic (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.
-
pIn [in]
-
Type: const FLOAT*
Pointer to the SH vector to scale.
-
Scale [in]
-
Type: const FLOAT
Pointer to the scale value.
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
| Requirement | Value |
|---|---|
| Header |
|
| Library |
|
See also