IFixedViewportPipeline Class Reference

This class provide some facility to add some extended behavior to the fixed render pipeline. More...

#include <IFixedViewportPipeline.h>

Inheritance diagram for IFixedViewportPipeline:

Public Member Functions
virtual size_t	GetNumPostShadingFragments () const =0
	Get the count of post shading fragments added. More...
virtual FragmentPtr	GetPostShadingFragment (size_t i) const =0
	Get the post shading fragments with index 'i'. More...
virtual bool	InsertPostShadingFragment (size_t i, FragmentPtr pFragment)=0
	Insert a new post shading fragments before the post-shading fragment with index 'i'. More...
virtual bool	DeletePostShadingFragment (size_t i)=0
	Delete the post-shading fragment with index 'i'. More...
virtual bool	DeletePostShadingFragment (FragmentPtr pFragment)=0
	Delete a specified post-shading fragment. More...
virtual size_t	GetNumOverlayFragments () const =0
	Get the count of overlay fragments added. More...
virtual FragmentPtr	GetOverlayFragment (size_t i) const =0
	Get the overlay fragments with index 'i'. More...
virtual bool	InsertOverlayFragment (size_t i, FragmentPtr pFragment)=0
	Insert a new overlay fragments before the post-shading fragment with index 'i'. More...
virtual bool	DeleteOverlayFragment (size_t i)=0
	Delete the post-shading fragment with index 'i'. More...
virtual bool	DeleteOverlayFragment (FragmentPtr pFragment)=0
	Delete a specified post-shading fragment. More...
virtual FragmentPtr	GetBackgroundFragment () const =0
	Get the customized background fragment. More...
virtual bool	SetBackgroundFragment (FragmentPtr pFragment)=0
	Set a customized background fragment that will replace the default background fragment. More...
virtual void	RestoreDefaultBackgroundFragment ()=0
	Restore the default background fragment. More...
virtual FragmentPtr	GetShadingFragment () const =0
	Get the customized shading fragment. More...
virtual bool	SetShadingFragment (FragmentPtr pFragment)=0
	Set a customized shading fragment that will replace the default illuminance/shading fragment. More...
virtual void	RestoreDefaultShadingFragment ()=0
	Restore the default shading fragment. 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...
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...

Detailed Description

This class provide some facility to add some extended behavior to the fixed render pipeline.

For e.g., 3rd party developer may specify their own background fragment, shading fragment for the viewport. Also developer could add post-shading fragments and overlay fragments. Post-shading fragments(usually some screen space effects, for e.g., bloom effect or glow effect) are directly evaluated right after the evaluation of shaded fragments. Overlay fragments which are evaluated at last could be some viewport UI overlay or any other elements to be rendered topmost.

Member Function Documentation

GetNumPostShadingFragments()

virtual size_t GetNumPostShadingFragments ( ) const

pure virtual

Get the count of post shading fragments added.

GetPostShadingFragment()

virtual FragmentPtr GetPostShadingFragment ( size_t  i ) const

pure virtual

Get the post shading fragments with index 'i'.

Parameters

[in]

i

the index of the post shading fragment

Returns

the post shading fragment required.

InsertPostShadingFragment()

virtual bool InsertPostShadingFragment ( size_t  i, FragmentPtr  pFragment  )

pure virtual

Insert a new post shading fragments before the post-shading fragment with index 'i'.

Parameters

[in]	i	the index of the new post shading fragment
[in]	pFragment	the new post shading fragment

Returns

true if succeed or false otherwise.

DeletePostShadingFragment() [1/2]

virtual bool DeletePostShadingFragment ( size_t  i )

pure virtual

Delete the post-shading fragment with index 'i'.

Parameters

[in]

i

the index of the post shading fragment to be deleted

Returns

true if succeed or false otherwise.

DeletePostShadingFragment() [2/2]

virtual bool DeletePostShadingFragment ( FragmentPtr  pFragment )

pure virtual

Delete a specified post-shading fragment.

Parameters

[in]

pFragment

the post shading fragment to be deleted

Returns

true if succeed or false otherwise.

GetNumOverlayFragments()

virtual size_t GetNumOverlayFragments ( ) const

pure virtual

Get the count of overlay fragments added.

GetOverlayFragment()

virtual FragmentPtr GetOverlayFragment ( size_t  i ) const

pure virtual

Get the overlay fragments with index 'i'.

Parameters

[in]

i

the index of the overlay fragment

Returns

the overlay fragment required.

InsertOverlayFragment()

virtual bool InsertOverlayFragment ( size_t  i, FragmentPtr  pFragment  )

pure virtual

Insert a new overlay fragments before the post-shading fragment with index 'i'.

Parameters

[in]	i	the index of the new overlay fragment
[in]	pFragment	the new overlay fragment

Returns

true if succeed or false otherwise.

DeleteOverlayFragment() [1/2]

virtual bool DeleteOverlayFragment ( size_t  i )

pure virtual

Delete the post-shading fragment with index 'i'.

Parameters

[in]

i

the index of the overlay fragment to be deleted

Returns

true if succeed or false otherwise.

DeleteOverlayFragment() [2/2]

virtual bool DeleteOverlayFragment ( FragmentPtr  pFragment )

pure virtual

Delete a specified post-shading fragment.

Parameters

[in]

pFragment

the overlay fragment to be deleted

Returns

true if succeed or false otherwise.

GetBackgroundFragment()

virtual FragmentPtr GetBackgroundFragment ( ) const

pure virtual

Get the customized background fragment.

SetBackgroundFragment()

virtual bool SetBackgroundFragment ( FragmentPtr  pFragment )

pure virtual

Set a customized background fragment that will replace the default background fragment.

Parameters

[in]

pFragment

the customized background fragment

Returns

true if succeed or false otherwise.

RestoreDefaultBackgroundFragment()

virtual void RestoreDefaultBackgroundFragment ( )

pure virtual

Restore the default background fragment.

GetShadingFragment()

virtual FragmentPtr GetShadingFragment ( ) const

pure virtual

Get the customized shading fragment.

SetShadingFragment()

virtual bool SetShadingFragment ( FragmentPtr  pFragment )

pure virtual

Set a customized shading fragment that will replace the default illuminance/shading fragment.

Parameters

[in]

pFragment

the customized shading fragment

Returns

true if succeed or false otherwise.

RestoreDefaultShadingFragment()

virtual void RestoreDefaultShadingFragment ( )

pure virtual

Restore the default shading fragment.