DefaultAmbientComponent< ParameterType, ShaderHelper > Class Template Reference
[Ambient Passes]

#include <adskComponent.h>

List of all members.

---

Detailed Description

template<typename ParameterType, typename ShaderHelper>
class DefaultAmbientComponent< ParameterType, ShaderHelper >

Default ambient component.

The ambient component computes the contribution of the ambient material color given the amount of ambient irradiance.

Template Parameters:

	ParameterType	The structure used in the shader declaration to represent the shader parameters.
	ShaderHelper	The class used in the shader declaration to represent the shader helper. See ShaderHelper for details on the required methods.

Public Member Functions
	DefaultAmbientComponent (miState *pState, ParameterType *pParameters)
	Component constructor.
	~DefaultAmbientComponent ()
	Component destructor.
miColor	operator() (miState *pState, ParameterType *pParameters, ShaderHelper &pHelper, const miColor &pColor)
	Function object operator.

---

Constructor & Destructor Documentation

template<typename ParameterType, typename ShaderHelper>

DefaultAmbientComponent< ParameterType, ShaderHelper >::DefaultAmbientComponent	(	miState *	pState,
		ParameterType *	pParameters
	)			[inline]

Component constructor.

Parameters:

[in,out]	pState	The mental ray rendering state.
[in]	pParameters	The shader parameters.

---

Member Function Documentation

template<typename ParameterType, typename ShaderHelper>

miColor DefaultAmbientComponent< ParameterType, ShaderHelper >::operator()	(	miState *	pState,
		ParameterType *	pParameters,
		ShaderHelper &	pHelper,
		const miColor &	pColor
	)			[inline]

Function object operator.

Parameters:

[in,out]	pState	The mental ray rendering state.
[in,out]	pParameters	The shader parameters.
[in,out]	pHelper	The shader helper for this shader.
[in]	pColor	The material color

Returns:

The color corresponding to this component.