IGameFXPass Class Reference

#include <IGameFX.h>

Class Description

Interface that holds per pass information. Each technique will be made up of one or more passes.

A pass will contain pipe state information and also vertex or pixel shader programs

Deprecated:

From 3ds Max 2015 IGameFXPass is deprecated. It no longer supports the newer Shader models or Nitrous. Please use the regular Microsoft DirectX SDK and supporting APIs to extract shader data.

Inheritance diagram for IGameFXPass:

Public Member Functions
MAX_DEPRECATED	~IGameFXPass ()
	Destructor. More...
MAX_DEPRECATED const MCHAR *	GetPassName ()
	The name of the pass. More...
MAX_DEPRECATED int	GetNumberOfFXAnnotations ()
	The number of annotations associated with the pass. More...
MAX_DEPRECATED bool	GetFXAnnotation (int index, MSTR *languageType, MSTR *key, MSTR *value)
	Access the key/value pair for the annotation. More...
MAX_DEPRECATED int	GetNumberofFXPipeStates ()
	the number of render pipe states More...
MAX_DEPRECATED bool	GetPipeStates (int index, MSTR *key, MSTR *value)
	Acces the specific key/value pair for the state. This would typically be render state information. More...
MAX_DEPRECATED bool	GetVertexShader (MSTR *entry, MSTR *code)
	Access the vertex shader for the current pass. More...
MAX_DEPRECATED bool	GetPixelShader (MSTR *entry, MSTR *code)
	Access the pixel shader for the current pass. More...
MAX_DEPRECATED IGameFX::IGameFXProfile	GetTargetProfile ()
	Access the profile used for the current pass. More...

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...

Constructor & Destructor Documentation

MAX_DEPRECATED ~IGameFXPass

(

)

Destructor.

Member Function Documentation

MAX_DEPRECATED const MCHAR* GetPassName

(

)

The name of the pass.

MAX_DEPRECATED int GetNumberOfFXAnnotations

(

)

The number of annotations associated with the pass.

MAX_DEPRECATED bool GetFXAnnotation	(	int	index,
		MSTR *	languageType,
		MSTR *	key,
		MSTR *	value
	)

Access the key/value pair for the annotation.

MAX_DEPRECATED int GetNumberofFXPipeStates

(

)

the number of render pipe states

MAX_DEPRECATED bool GetPipeStates	(	int	index,
		MSTR *	key,
		MSTR *	value
	)

Acces the specific key/value pair for the state. This would typically be render state information.

MAX_DEPRECATED bool GetVertexShader	(	MSTR *	entry,
		MSTR *	code
	)

Access the vertex shader for the current pass.

Parameters

entry	A buffer to receive the entry name for the function
code	A buffer to receive the actual code fragment

Returns

True if successful, or false if no code was found

MAX_DEPRECATED bool GetPixelShader	(	MSTR *	entry,
		MSTR *	code
	)

Access the pixel shader for the current pass.

Parameters

entry	A buffer to receive the entry name for the function
code	A buffer to receive the actual code fragment

Returns

True if successful, or false if no code was found

MAX_DEPRECATED IGameFX::IGameFXProfile GetTargetProfile

(

)

Access the profile used for the current pass.