D3DXSHRotateZ 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 XMSHRotateZ.
Rotates the spherical harmonic (SH) vector in the z-axis by the given angle.
Syntax
FLOAT* D3DXSHRotateZ(
_In_ FLOAT *pOut,
_In_ UINT Order,
_In_ FLOAT Angle,
_In_ const FLOAT *pIn
);
Parameters
-
pOut [in]
-
Type: FLOAT*
Pointer to Spherical harmonic (SH) output coefficients. The evaluation generates Order² coefficients. This pointer should not alias with pIn. 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.
-
Angle [in]
-
Type: FLOAT
Rotation angle in radians. The rotation is performed around the z-axis.
-
pIn [in]
-
Type: const FLOAT*
Pointer to rotated SH coefficients.
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