EffectInstanceHandle is a class which stores values of parameters in an effect. More...

#include <EffectInstanceHandle.h>

Inheritance diagram for EffectInstanceHandle:

Public Member Functions
GraphicsDriverAPI	EffectInstanceHandle ()

GraphicsDriverAPI	EffectInstanceHandle (const EffectInstanceHandle &from)

GraphicsDriverAPI EffectInstanceHandle &	operator= (const EffectInstanceHandle &from)

virtual GraphicsDriverAPI	~EffectInstanceHandle ()

GraphicsDriverAPI EffectHandle	ParentEffect ()

GraphicsDriverAPI void	Apply (DrawContext &dc)

virtual GraphicsDriverAPI const MaterialRequiredStreams &	GetRequiredStreams () const
	Returns the vertex format of this effect instance. More...

GraphicsDriverAPI void	SetIntParameter (const MSTR &parameterName, int value)
	Sets int parameter. More...

GraphicsDriverAPI void	SetIntParameter (int index, int value)
	Sets int parameter. More...

GraphicsDriverAPI void	SetIntParameter (const MSTR &parameterName, IPoint2 &value)
	Sets int2 parameter. More...

GraphicsDriverAPI void	SetIntParameter (int index, IPoint2 &value)
	Sets int2 parameter. More...

GraphicsDriverAPI void	SetIntParameter (const MSTR &parameterName, IPoint3 &value)
	Sets int3 parameter. More...

GraphicsDriverAPI void	SetIntParameter (int index, IPoint3 &value)
	Sets int3 parameter. More...

GraphicsDriverAPI void	SetIntArrayParameter (const MSTR &parameterName, const int *value, unsigned int count)
	Sets int array parameter. More...

GraphicsDriverAPI void	SetIntArrayParameter (int index, const int *value, unsigned int count)
	Sets int array parameter. More...

GraphicsDriverAPI void	SetIntArrayParameter (const MSTR &parameterName, const IPoint2 *value, unsigned int count)
	Sets int2 array parameter. More...

GraphicsDriverAPI void	SetIntArrayParameter (int index, const IPoint2 *value, unsigned int count)
	Sets int2 array parameter. More...

GraphicsDriverAPI void	SetIntArrayParameter (int index, const IPoint3 *value, unsigned int count)
	Sets int3 array parameter. More...

GraphicsDriverAPI void	SetIntArrayParameter (const MSTR &parameterName, const IPoint3 *value, unsigned int count)
	Sets int3 array parameter. More...

GraphicsDriverAPI void	SetUIntParameter (const MSTR &parameterName, unsigned int value)
	Sets uint parameter. More...

GraphicsDriverAPI void	SetUIntParameter (int index, unsigned int value)
	Sets uint parameter. More...

GraphicsDriverAPI void	SetUIntArrayParameter (const MSTR &parameterName, const unsigned int *value, unsigned int count)
	Sets uint array parameter. More...

GraphicsDriverAPI void	SetUIntArrayParameter (int index, const unsigned int *value, unsigned int count)
	Sets uint array parameter. More...

GraphicsDriverAPI void	SetFloatParameter (const MSTR &parameterName, float value)
	Sets float parameter. More...

GraphicsDriverAPI void	SetFloatParameter (int index, float value)
	Sets float parameter. More...

GraphicsDriverAPI void	SetFloatParameter (const MSTR &parameterName, const Point2 &value)
	Sets float2 parameter. More...

GraphicsDriverAPI void	SetFloatParameter (int index, const Point2 &value)
	Sets float2 parameter. More...

GraphicsDriverAPI void	SetFloatParameter (const MSTR &parameterName, const Point3 &value)
	Sets float3 parameter. More...

GraphicsDriverAPI void	SetFloatParameter (int index, const Point3 &value)
	Sets float3 parameter. More...

GraphicsDriverAPI void	SetFloatParameter (const MSTR &parameterName, const Point4 &value)
	Sets float4 parameter. More...

GraphicsDriverAPI void	SetFloatParameter (int index, const Point4 &value)
	Sets float4 parameter. More...

GraphicsDriverAPI void	SetFloatArrayParameter (int index, const float *value, unsigned int count)
	Sets float array parameter. More...

GraphicsDriverAPI void	SetFloatArrayParameter (const MSTR &parameterName, const float *value, unsigned int count)
	Sets float array parameter. More...

GraphicsDriverAPI void	SetFloatArrayParameter (int index, const Point2 *value, unsigned int count)
	Sets float2 array parameter. More...

GraphicsDriverAPI void	SetFloatArrayParameter (const MSTR &parameterName, const Point2 *value, unsigned int count)
	Sets float2 array parameter. More...

GraphicsDriverAPI void	SetFloatArrayParameter (int index, const Point3 *value, unsigned int count)
	Sets float3 array parameter. More...

GraphicsDriverAPI void	SetFloatArrayParameter (const MSTR &parameterName, const Point3 *value, unsigned int count)
	Sets float3 array parameter. More...

GraphicsDriverAPI void	SetFloatArrayParameter (const MSTR &parameterName, const Point4 *value, unsigned int count)
	Sets float4 array parameter. More...

GraphicsDriverAPI void	SetFloatArrayParameter (int index, const Point4 *value, unsigned int count)
	Sets float4 array parameter. More...

GraphicsDriverAPI void	SetBoolParameter (const MSTR &parameterName, bool value)
	Sets bool parameter. More...

GraphicsDriverAPI void	SetBoolParameter (int index, bool value)
	Sets bool parameter. More...

GraphicsDriverAPI void	SetBoolArrayParameter (const MSTR &parameterName, const bool *value, unsigned int count)
	Sets bool array parameter. More...

GraphicsDriverAPI void	SetBoolArrayParameter (int index, const bool *value, unsigned int count)
	Sets bool array parameter. More...

GraphicsDriverAPI void	SetMatrixParameter (const MSTR &parameterName, const Matrix44 &value)
	Sets matrix parameter. More...

GraphicsDriverAPI void	SetMatrixParameter (int index, const Matrix44 &value)
	Sets matrix parameter. More...

GraphicsDriverAPI void	SetMatrixArrayParameter (const MSTR &parameterName, const Matrix44 *value, unsigned int count)
	Sets matrix array parameter. More...

GraphicsDriverAPI void	SetMatrixArrayParameter (int index, const Matrix44 *value, unsigned int count)
	Sets matrix array parameter. More...

GraphicsDriverAPI void	SetTextureParameter (const MSTR &parameterName, const TextureHandle &textureHandle)
	Sets texture parameter. More...

GraphicsDriverAPI void	SetTextureParameter (const MSTR &parameterName, const TargetHandle &textureHandle)
	Sets texture parameter. More...

GraphicsDriverAPI void	SetTextureParameter (int index, const TextureHandle &textureHandle)
	Sets texture parameter. More...

GraphicsDriverAPI void	SetTextureParameter (int index, const TargetHandle &targetHandle)
	Sets texture parameter. More...

GraphicsDriverAPI void	SetBufferParameter (const MSTR &parameterName, const SmartHandle &bufferHandle)
	Sets buffer parameter. More...

GraphicsDriverAPI void	SetBufferParameter (int index, const SmartHandle &bufferHandle)
	Sets buffer parameter. More...

Public Member Functions inherited from SmartHandle
virtual GraphicsDriverAPI	~SmartHandle ()
	destructor More...

GraphicsDriverAPI bool	IsValid () const
	Check if this handle is valid. More...

GraphicsDriverAPI void	Release ()
	Release the underlying graphics objects. More...

GraphicsDriverAPI Identifier	GetObjectID () const
	Get the underlying graphics object id. More...

GraphicsDriverAPI void	SetPointer (IRefObject *pObject)

GraphicsDriverAPI IRefObject *	GetPointer () const
	Get the underlying graphics object pointer. More...

bool	operator== (const SmartHandle &rhs) const

bool	operator!= (const SmartHandle &rhs) const

bool	operator< (const SmartHandle &rhs) const

bool	operator<= (const SmartHandle &rhs) const

bool	operator> (const SmartHandle &rhs) const

bool	operator>= (const SmartHandle &rhs) const

GraphicsDriverAPI	SmartHandle (const SmartHandle &)

GraphicsDriverAPI SmartHandle &	operator= (const SmartHandle &)

Protected Member Functions
GraphicsDriverAPI	EffectInstanceHandle (EffectHandle &parent)

Protected Member Functions inherited from SmartHandle
GraphicsDriverAPI	SmartHandle ()

Friends
class	EffectHandle

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete (void ptr, const char filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void ptr, int block_type, const char filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void ptr, const std::nothrow_t &e, const char filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void ptr, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void ptr, int block_type, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void ptr, const std::nothrow_t &e, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...

static UtilExport void	operator delete (void ptr, void placement_ptr)
	Placement delete operator. More...

static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...

static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...

static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Protected Attributes inherited from SmartHandle
IRefObject *	mpObject

Detailed Description

EffectInstanceHandle is a class which stores values of parameters in an effect.

Typically, EffectHandle is a singleton which represent a single ".fx" file. And each render item contains an EffectInstanceHandle to store their own values. Use EffectInstanceHandle::Apply() to apply values to the device. This class is used for viewport display and Quicksilver. How to use:

//Initialize the effect
EffectHandle hEffect;
EffectInstanceHandle hEffectInstance;
MSTR errorInfo;
hEffect.InitializeWithFile(shaderFileName, &errorInfo);
hEffectInstance = hEffect.CreateEffectInstance();
hEffectInstance.SetFloatParameter(_M("myFloatShaderParam"), floatValue);
...
 
//Before draw calls:
//Render with the effect
hEffect.Activate(dc); //Activate the effect first
hEffectInstance0.Apply(dc);  //Apply values to the effect
for (int i = 0; i < hEffect.GetPassCount(dc); ++i)
{
    hEffect.ActivatePass(dc, i); //Apply each pass
    pVirtualDevice.Draw(...);
}
hEffect.PassesFinished(dc); Finish this effect instance
 
hEffectInstance1.Apply(dc); //Apply next instance, which parent effect is same as above.
for (int i = 0; i < hEffect.GetPassCount(dc); ++i)
{
    hEffect.ActivatePass(dc, i); //Apply and draw this instance
    pVirtualDevice.Draw(...);
}
hEffect.PassesFinished(dc);
 
hEffect.Terminate(); //End of the effect usage.

Constructor & Destructor Documentation

◆ EffectInstanceHandle() [1/3]

GraphicsDriverAPI EffectInstanceHandle ( EffectHandle & parent )

protected

◆ EffectInstanceHandle() [2/3]

GraphicsDriverAPI EffectInstanceHandle ( )

◆ EffectInstanceHandle() [3/3]

GraphicsDriverAPI EffectInstanceHandle ( const EffectInstanceHandle & from )

◆ ~EffectInstanceHandle()

virtual GraphicsDriverAPI ~EffectInstanceHandle ( )

virtual

Member Function Documentation

◆ operator=()

GraphicsDriverAPI EffectInstanceHandle& operator= ( const EffectInstanceHandle & from )

◆ ParentEffect()

GraphicsDriverAPI EffectHandle ParentEffect ( )

◆ Apply()

GraphicsDriverAPI void Apply ( DrawContext & dc )

◆ GetRequiredStreams()

virtual GraphicsDriverAPI const MaterialRequiredStreams& GetRequiredStreams ( ) const

virtual

Returns the vertex format of this effect instance.

Returns: the material required streams.

◆ SetIntParameter() [1/6]

GraphicsDriverAPI void SetIntParameter	(	const MSTR &	parameterName,
		int	value
	)

Sets int parameter.

Parameters

[in]	parameterName	The unique parameter name of the parameter.
[in]	value	The int parameter value.

◆ SetIntParameter() [2/6]

GraphicsDriverAPI void SetIntParameter	(	int	index,
		int	value
	)

Sets int parameter.

Parameters

[in]	index	The parameter index of the parameter.
[in]	value	The int parameter value.

◆ SetIntParameter() [3/6]

GraphicsDriverAPI void SetIntParameter	(	const MSTR &	parameterName,
		IPoint2 &	value
	)

Sets int2 parameter.

Parameters

[in]	parameterName	The unique parameter name of the parameter.
[in]	value	The int parameter value.

◆ SetIntParameter() [4/6]

GraphicsDriverAPI void SetIntParameter	(	int	index,
		IPoint2 &	value
	)

Sets int2 parameter.

Parameters

[in]	index	The parameter index of the parameter.
[in]	value	The int parameter value.

◆ SetIntParameter() [5/6]

GraphicsDriverAPI void SetIntParameter	(	const MSTR &	parameterName,
		IPoint3 &	value
	)

Sets int3 parameter.

Parameters

[in]	parameterName	The unique parameter name of the parameter.
[in]	value	The int parameter value.

◆ SetIntParameter() [6/6]

GraphicsDriverAPI void SetIntParameter	(	int	index,
		IPoint3 &	value
	)

Sets int3 parameter.

Parameters

[in]	index	The parameter index of the parameter.
[in]	value	The int parameter value.

◆ SetIntArrayParameter() [1/6]

GraphicsDriverAPI void SetIntArrayParameter	(	const MSTR &	parameterName,
		const int *	value,
		unsigned int	count
	)

Sets int array parameter.

Parameters

[in]	parameterName	The unique parameter name of the parameter.
[in]	value	The pointer of int array parameter value.
[in]	count	The count of int array.

◆ SetIntArrayParameter() [2/6]

GraphicsDriverAPI void SetIntArrayParameter	(	int	index,
		const int *	value,
		unsigned int	count
	)

Sets int array parameter.

Parameters

[in]	index	The parameter index of the parameter.
[in]	value	The pointer of int array parameter value.
[in]	count	The count of int array.

◆ SetIntArrayParameter() [3/6]

GraphicsDriverAPI void SetIntArrayParameter	(	const MSTR &	parameterName,
		const IPoint2 *	value,
		unsigned int	count
	)

Sets int2 array parameter.

Parameters

[in]	parameterName	The unique parameter name of the parameter.
[in]	value	The pointer of int array parameter value.
[in]	count	The count of int array.

◆ SetIntArrayParameter() [4/6]

GraphicsDriverAPI void SetIntArrayParameter	(	int	index,
		const IPoint2 *	value,
		unsigned int	count
	)

Sets int2 array parameter.

Parameters

[in]	index	The parameter index of the parameter.
[in]	value	The pointer of int array parameter value.
[in]	count	The count of int array.

◆ SetIntArrayParameter() [5/6]

GraphicsDriverAPI void SetIntArrayParameter	(	int	index,
		const IPoint3 *	value,
		unsigned int	count
	)

Sets int3 array parameter.

Parameters

[in]	index	The parameter index of the parameter.
[in]	value	The pointer of int array parameter value.
[in]	count	The count of int array.

◆ SetIntArrayParameter() [6/6]

GraphicsDriverAPI void SetIntArrayParameter	(	const MSTR &	parameterName,
		const IPoint3 *	value,
		unsigned int	count
	)

Sets int3 array parameter.

Parameters

[in]	parameterName	The unique parameter name of the parameter.
[in]	value	The pointer of int array parameter value.
[in]	count	The count of int array.

◆ SetUIntParameter() [1/2]

GraphicsDriverAPI void SetUIntParameter	(	const MSTR &	parameterName,
		unsigned int	value
	)

Sets uint parameter.

Parameters

[in]	parameterName	The unique parameter name of the parameter.
[in]	value	The int parameter value.

◆ SetUIntParameter() [2/2]

GraphicsDriverAPI void SetUIntParameter	(	int	index,
		unsigned int	value
	)

Sets uint parameter.

Parameters

[in]	index	The parameter index of the parameter.
[in]	value	The int parameter value.

◆ SetUIntArrayParameter() [1/2]

GraphicsDriverAPI void SetUIntArrayParameter	(	const MSTR &	parameterName,
		const unsigned int *	value,
		unsigned int	count
	)

Sets uint array parameter.

Parameters

[in]	parameterName	The unique parameter name of the parameter.
[in]	value	The pointer of int array parameter value.
[in]	count	The count of int array.

◆ SetUIntArrayParameter() [2/2]

GraphicsDriverAPI void SetUIntArrayParameter	(	int	index,
		const unsigned int *	value,
		unsigned int	count
	)

Sets uint array parameter.

Parameters

[in]	index	The parameter index of the parameter.
[in]	value	The pointer of int array parameter value.
[in]	count	The count of int array.

◆ SetFloatParameter() [1/8]

GraphicsDriverAPI void SetFloatParameter	(	const MSTR &	parameterName,
		float	value
	)

Sets float parameter.

Parameters

[in]	parameterName	The unique parameter name of the parameter.
[in]	value	The parameter value.

◆ SetFloatParameter() [2/8]

GraphicsDriverAPI void SetFloatParameter	(	int	index,
		float	value
	)

Sets float parameter.

Parameters

[in]	index	The parameter index of the parameter.
[in]	value	The parameter value.

◆ SetFloatParameter() [3/8]

GraphicsDriverAPI void SetFloatParameter	(	const MSTR &	parameterName,
		const Point2 &	value
	)

Sets float2 parameter.

Parameters

[in]	parameterName	The unique parameter name of the parameter.
[in]	value	The parameter value.

◆ SetFloatParameter() [4/8]

GraphicsDriverAPI void SetFloatParameter	(	int	index,
		const Point2 &	value
	)

Sets float2 parameter.

Parameters

[in]	index	The parameter index of the parameter.
[in]	value	The parameter value.

◆ SetFloatParameter() [5/8]

GraphicsDriverAPI void SetFloatParameter	(	const MSTR &	parameterName,
		const Point3 &	value
	)

Sets float3 parameter.

Parameters

[in]	parameterName	The unique parameter name of the parameter.
[in]	value	The parameter value.

◆ SetFloatParameter() [6/8]

GraphicsDriverAPI void SetFloatParameter	(	int	index,
		const Point3 &	value
	)

Sets float3 parameter.

Parameters

[in]	index	The parameter index of the parameter.
[in]	value	The parameter value.

◆ SetFloatParameter() [7/8]

GraphicsDriverAPI void SetFloatParameter	(	const MSTR &	parameterName,
		const Point4 &	value
	)

Sets float4 parameter.

Parameters

[in]	parameterName	The unique parameter name of the parameter.
[in]	value	The parameter value.

◆ SetFloatParameter() [8/8]

GraphicsDriverAPI void SetFloatParameter	(	int	index,
		const Point4 &	value
	)

Sets float4 parameter.

Parameters

[in]	index	The parameter index of the parameter.
[in]	value	The parameter value.

◆ SetFloatArrayParameter() [1/8]

GraphicsDriverAPI void SetFloatArrayParameter	(	int	index,
		const float *	value,
		unsigned int	count
	)

Sets float array parameter.

Parameters

[in]	index	The parameter index of the parameter.
[in]	value	The pointer of float array parameter value.
[in]	count	The count of float array.

◆ SetFloatArrayParameter() [2/8]

GraphicsDriverAPI void SetFloatArrayParameter	(	const MSTR &	parameterName,
		const float *	value,
		unsigned int	count
	)

Sets float array parameter.

Parameters

[in]	parameterName	The unique parameter name of the parameter.
[in]	value	The pointer of float array parameter value.
[in]	count	The count of float array.

◆ SetFloatArrayParameter() [3/8]

GraphicsDriverAPI void SetFloatArrayParameter	(	int	index,
		const Point2 *	value,
		unsigned int	count
	)

Sets float2 array parameter.

Parameters

[in]	index	The parameter index of the parameter.
[in]	value	The pointer of float array parameter value.
[in]	count	The count of float array.

◆ SetFloatArrayParameter() [4/8]

GraphicsDriverAPI void SetFloatArrayParameter	(	const MSTR &	parameterName,
		const Point2 *	value,
		unsigned int	count
	)

Sets float2 array parameter.

Parameters

[in]	parameterName	The unique parameter name of the parameter.
[in]	value	The pointer of float array parameter value.
[in]	count	The count of float array.

◆ SetFloatArrayParameter() [5/8]

GraphicsDriverAPI void SetFloatArrayParameter	(	int	index,
		const Point3 *	value,
		unsigned int	count
	)

Sets float3 array parameter.

Parameters

[in]	index	The parameter index of the parameter.
[in]	value	The pointer of float3 array parameter value.
[in]	count	The count of float3 array.

◆ SetFloatArrayParameter() [6/8]

GraphicsDriverAPI void SetFloatArrayParameter	(	const MSTR &	parameterName,
		const Point3 *	value,
		unsigned int	count
	)

Sets float3 array parameter.

Parameters

[in]	parameterName	The unique parameter name of the parameter.
[in]	value	The pointer of float3 array parameter value.
[in]	count	The count of float3 array.

◆ SetFloatArrayParameter() [7/8]

GraphicsDriverAPI void SetFloatArrayParameter	(	const MSTR &	parameterName,
		const Point4 *	value,
		unsigned int	count
	)

Sets float4 array parameter.

Parameters

[in]	parameterName	The unique parameter name of the parameter.
[in]	value	The pointer of float4 array parameter value.
[in]	count	The count of float4 array.

◆ SetFloatArrayParameter() [8/8]

GraphicsDriverAPI void SetFloatArrayParameter	(	int	index,
		const Point4 *	value,
		unsigned int	count
	)

Sets float4 array parameter.

Parameters

[in]	index	The parameter index of the parameter.
[in]	value	The pointer of float4 array parameter value.
[in]	count	The count of float4 array.

◆ SetBoolParameter() [1/2]

GraphicsDriverAPI void SetBoolParameter	(	const MSTR &	parameterName,
		bool	value
	)

Sets bool parameter.

Parameters

[in]	parameterName	The unique parameter name of the parameter.
[in]	value	The parameter value.

◆ SetBoolParameter() [2/2]

GraphicsDriverAPI void SetBoolParameter	(	int	index,
		bool	value
	)

Sets bool parameter.

Parameters

[in]	index	The parameter index of the parameter.
[in]	value	The parameter value.

◆ SetBoolArrayParameter() [1/2]

GraphicsDriverAPI void SetBoolArrayParameter	(	const MSTR &	parameterName,
		const bool *	value,
		unsigned int	count
	)

Sets bool array parameter.

Parameters

[in]	parameterName	The unique parameter name of the parameter.
[in]	value	The pointer of bool array parameter value.
[in]	count	The count of bool array.

◆ SetBoolArrayParameter() [2/2]

GraphicsDriverAPI void SetBoolArrayParameter	(	int	index,
		const bool *	value,
		unsigned int	count
	)

Sets bool array parameter.

Parameters

[in]	index	The parameter index of the parameter.
[in]	value	The pointer of bool array parameter value.
[in]	count	The count of bool array.

◆ SetMatrixParameter() [1/2]

GraphicsDriverAPI void SetMatrixParameter	(	const MSTR &	parameterName,
		const Matrix44 &	value
	)

Sets matrix parameter.

Parameters

[in]	parameterName	The unique parameter name of the parameter.
[in]	value	The parameter value.

◆ SetMatrixParameter() [2/2]

GraphicsDriverAPI void SetMatrixParameter	(	int	index,
		const Matrix44 &	value
	)

Sets matrix parameter.

Parameters

[in]	index	The parameter index of the parameter.
[in]	value	The parameter value.

◆ SetMatrixArrayParameter() [1/2]

GraphicsDriverAPI void SetMatrixArrayParameter	(	const MSTR &	parameterName,
		const Matrix44 *	value,
		unsigned int	count
	)

Sets matrix array parameter.

Parameters

[in]	parameterName	The unique parameter name of the parameter.
[in]	value	The pointer of matrix array parameter value.
[in]	count	The count of matrix array.

◆ SetMatrixArrayParameter() [2/2]

GraphicsDriverAPI void SetMatrixArrayParameter	(	int	index,
		const Matrix44 *	value,
		unsigned int	count
	)

Sets matrix array parameter.

Parameters

[in]	index	The parameter index of the parameter.
[in]	value	The pointer of matrix array parameter value.
[in]	count	The count of matrix array.

◆ SetTextureParameter() [1/4]

GraphicsDriverAPI void SetTextureParameter	(	const MSTR &	parameterName,
		const TextureHandle &	textureHandle
	)

Sets texture parameter.

Parameters

[in]	parameterName	The unique parameter name of the parameter.
[in]	textureHandle	The parameter texture handle value.

◆ SetTextureParameter() [2/4]

GraphicsDriverAPI void SetTextureParameter	(	const MSTR &	parameterName,
		const TargetHandle &	textureHandle
	)

Sets texture parameter.

Parameters

[in]	parameterName	The unique parameter name of the parameter.
[in]	textureHandle	The parameter texture handle value.

◆ SetTextureParameter() [3/4]

GraphicsDriverAPI void SetTextureParameter	(	int	index,
		const TextureHandle &	textureHandle
	)

Sets texture parameter.

Parameters

[in]	index	The parameter index of the parameter.
[in]	textureHandle	The parameter texture handle value.

◆ SetTextureParameter() [4/4]

GraphicsDriverAPI void SetTextureParameter	(	int	index,
		const TargetHandle &	targetHandle
	)

Sets texture parameter.

Parameters

[in]	index	The parameter index of the parameter.
[in]	targetHandle	The parameter target handle value.

◆ SetBufferParameter() [1/2]

GraphicsDriverAPI void SetBufferParameter	(	const MSTR &	parameterName,
		const SmartHandle &	bufferHandle
	)

Sets buffer parameter.

Parameters

[in]	parameterName	The unique parameter name of the parameter.
[in]	bufferHandle	The parameter VertexBufferHandle or IndexBufferHandle value. Note this buffer should be created with BufferUsageStatic \| BufferUsageTarget usage flag

◆ SetBufferParameter() [2/2]

GraphicsDriverAPI void SetBufferParameter	(	int	index,
		const SmartHandle &	bufferHandle
	)

Sets buffer parameter.

Parameters

[in]	index	The parameter index of the parameter.
[in]	bufferHandle	The parameter VertexBufferHandle or IndexBufferHandle value. Note this buffer should be created with BufferUsageStatic \| BufferUsageTarget usage flag

Friends And Related Function Documentation

◆ EffectHandle

friend class EffectHandle

friend

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EffectInstanceHandle() [1/3]

◆ EffectInstanceHandle() [2/3]

◆ EffectInstanceHandle() [3/3]

◆ ~EffectInstanceHandle()

Member Function Documentation

◆ operator=()

◆ ParentEffect()

◆ Apply()

◆ GetRequiredStreams()

◆ SetIntParameter() [1/6]

◆ SetIntParameter() [2/6]

◆ SetIntParameter() [3/6]

◆ SetIntParameter() [4/6]

◆ SetIntParameter() [5/6]

◆ SetIntParameter() [6/6]

◆ SetIntArrayParameter() [1/6]

◆ SetIntArrayParameter() [2/6]

◆ SetIntArrayParameter() [3/6]

◆ SetIntArrayParameter() [4/6]

◆ SetIntArrayParameter() [5/6]

◆ SetIntArrayParameter() [6/6]

◆ SetUIntParameter() [1/2]

◆ SetUIntParameter() [2/2]

◆ SetUIntArrayParameter() [1/2]

◆ SetUIntArrayParameter() [2/2]

◆ SetFloatParameter() [1/8]

◆ SetFloatParameter() [2/8]

◆ SetFloatParameter() [3/8]

◆ SetFloatParameter() [4/8]

◆ SetFloatParameter() [5/8]

◆ SetFloatParameter() [6/8]

◆ SetFloatParameter() [7/8]

◆ SetFloatParameter() [8/8]

◆ SetFloatArrayParameter() [1/8]

◆ SetFloatArrayParameter() [2/8]

◆ SetFloatArrayParameter() [3/8]

◆ SetFloatArrayParameter() [4/8]

◆ SetFloatArrayParameter() [5/8]

◆ SetFloatArrayParameter() [6/8]

◆ SetFloatArrayParameter() [7/8]

◆ SetFloatArrayParameter() [8/8]

◆ SetBoolParameter() [1/2]

◆ SetBoolParameter() [2/2]

◆ SetBoolArrayParameter() [1/2]

◆ SetBoolArrayParameter() [2/2]

◆ SetMatrixParameter() [1/2]

◆ SetMatrixParameter() [2/2]

◆ SetMatrixArrayParameter() [1/2]

◆ SetMatrixArrayParameter() [2/2]

◆ SetTextureParameter() [1/4]

◆ SetTextureParameter() [2/4]

◆ SetTextureParameter() [3/4]

◆ SetTextureParameter() [4/4]

◆ SetBufferParameter() [1/2]

◆ SetBufferParameter() [2/2]

Friends And Related Function Documentation

◆ EffectHandle