SphericalHarmonics.Dot Method

Language:

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

Definition

Visual Basic Public Shared Function Dot( _
    ByVal order As Integer, _
    ByVal vectorA() As Single, _
    ByVal vectorB() As Single _
) As Single

C# public static float Dot(
    int order,
    float[] vectorA,
    float[] vectorB
);

C++ public:
static float Dot(
    int order,
    array<float>^ vectorA,
    array<float>^ vectorB
);

JScript public static function Dot(
    order : int,
    vectorA : float[],
    vectorB : float[]
) : float;

Visual Basic	Public Shared Function Dot( _ ByVal order As Integer, _ ByVal vectorA() As Single, _ ByVal vectorB() As Single _ ) As Single
C#	public static float Dot( int order, float[] vectorA, float[] vectorB );
C++	public: static float Dot( int order, array<float>^ vectorA, array<float>^ vectorB );
JScript	public static function Dot( order : int, vectorA : float[], vectorB : float[] ) : float;

Parameters

order System.Int32
Order of the SH evaluation. Must be in the range of SphericalHarmonics.MinimumOrder to SphericalHarmonics.MaximumOrder, inclusive. The evaluation generates order² coefficients. The degree of the evaluation is order - 1.

vectorA System.Single[]
An array of floating point values that represent the first SH vector.

vectorB System.Single[]
An array of floating point values that represent the second SH vector.

Return Value

System.Single
A floating point value that represents the dot product of the two vectors.

Remarks

Each coefficient of the basis function Y_lm is stored at 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.

Feedback? Please provide us with your comments on this topic.
For more help, visit the DirectX Developer Center

order	System.Int32 Order of the SH evaluation. Must be in the range of SphericalHarmonics.MinimumOrder to SphericalHarmonics.MaximumOrder, inclusive. The evaluation generates order² coefficients. The degree of the evaluation is order - 1.
vectorA	System.Single[] An array of floating point values that represent the first SH vector.
vectorB	System.Single[] An array of floating point values that represent the second SH vector.