This is a abstract class that that provides the interface for the query class for hardware occlusion. More...

#include <OgreHardwareOcclusionQuery.h>

Inheritance diagram for Ogre::HardwareOcclusionQuery:

Public Member Functions
	HardwareOcclusionQuery ()
	Object public member functions.
virtual	~HardwareOcclusionQuery ()
	Object destructor.
virtual void	beginOcclusionQuery ()=0
	Starts the hardware occlusion query.
virtual void	endOcclusionQuery ()=0
	Ends the hardware occlusion test.
unsigned int	getLastQuerysPixelcount () const
	Let's you get the last pixel count with out doing the hardware occlusion test.
virtual bool	isStillOutstanding (void)=0
	Lets you know when query is done, or still be processed by the Hardware.
void	operator delete (void *ptr)
void	operator delete (void ptr, void )
void	operator delete (void ptr, const char , int, const char *)
void	operator delete[] (void *ptr)
void	operator delete[] (void ptr, const char , int, const char *)
void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info
void *	operator new[] (size_t sz)
virtual bool	pullOcclusionQuery (unsigned int *NumOfFragments)=0
	Pulls the hardware occlusion query.
Protected Attributes
bool	mIsQueryResultStillOutstanding
	Has the query returned a result yet?
unsigned int	mPixelCount
	Number of visible pixels determined by last query.

Detailed Description

This is a abstract class that that provides the interface for the query class for hardware occlusion.

Author:: Lee Sandberg Updated on 13/8/2005 by Tuan Kuranes email: tuan.kuranes@free.fr

Definition at line 51 of file OgreHardwareOcclusionQuery.h.

Constructor & Destructor Documentation

Ogre::HardwareOcclusionQuery::HardwareOcclusionQuery ( )

Object public member functions.

Default object constructor

virtual Ogre::HardwareOcclusionQuery::~HardwareOcclusionQuery ( ) [virtual]

Object destructor.

Member Function Documentation

virtual void Ogre::HardwareOcclusionQuery::beginOcclusionQuery ( ) [pure virtual]

Starts the hardware occlusion query.

Remarks:: Simple usage: Create one or more OcclusionQuery object one per outstanding query or one per tested object OcclusionQuery* mOcclusionQuery; createOcclusionQuery( &mOcclusionQuery ); In the rendering loop: Draw all occluders mOcclusionQuery->startOcclusionQuery(); Draw the polygons to be tested mOcclusionQuery->endOcclusionQuery();

Results must be pulled using: UINT mNumberOfPixelsVisable; pullOcclusionQuery( &mNumberOfPixelsVisable );

Implemented in Ogre::GLHardwareOcclusionQuery, Ogre::GL3PlusHardwareOcclusionQuery, Ogre::D3D9HardwareOcclusionQuery, and Ogre::D3D11HardwareOcclusionQuery.

virtual void Ogre::HardwareOcclusionQuery::endOcclusionQuery ( ) [pure virtual]

Ends the hardware occlusion test.

Implemented in Ogre::GLHardwareOcclusionQuery, Ogre::GL3PlusHardwareOcclusionQuery, Ogre::D3D9HardwareOcclusionQuery, and Ogre::D3D11HardwareOcclusionQuery.

unsigned int Ogre::HardwareOcclusionQuery::getLastQuerysPixelcount ( ) const

Let's you get the last pixel count with out doing the hardware occlusion test.

Returns:: The last fragment count from the last test. Remarks This function won't give you new values, just the old value.

Definition at line 109 of file OgreHardwareOcclusionQuery.h.

virtual bool Ogre::HardwareOcclusionQuery::isStillOutstanding ( void ) [pure virtual]

Lets you know when query is done, or still be processed by the Hardware.

Returns:: true if query isn't finished.

Implemented in Ogre::GLHardwareOcclusionQuery, Ogre::GL3PlusHardwareOcclusionQuery, Ogre::D3D9HardwareOcclusionQuery, and Ogre::D3D11HardwareOcclusionQuery.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void * ptr ) [inherited]

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)		`[inherited]`

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)		`[inherited]`

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void * ptr ) [inherited]

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)		`[inherited]`

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)		`[inherited]`

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t sz ) [inherited]

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		void *	ptr
	)		`[inherited]`

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[]	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)		`[inherited]`

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t sz ) [inherited]

Definition at line 91 of file OgreMemoryAllocatedObject.h.

virtual bool Ogre::HardwareOcclusionQuery::pullOcclusionQuery ( unsigned int * NumOfFragments ) [pure virtual]

Pulls the hardware occlusion query.

Note:: Waits until the query result is available; use isStillOutstanding if just want to test if the result is available.

Return values:

NumOfFragments will get the resulting number of fragments.

Returns:: True if success or false if not.

Implemented in Ogre::GLHardwareOcclusionQuery, Ogre::GL3PlusHardwareOcclusionQuery, Ogre::D3D9HardwareOcclusionQuery, and Ogre::D3D11HardwareOcclusionQuery.

Member Data Documentation

bool Ogre::HardwareOcclusionQuery::mIsQueryResultStillOutstanding [protected]

Has the query returned a result yet?

Definition at line 125 of file OgreHardwareOcclusionQuery.h.

unsigned int Ogre::HardwareOcclusionQuery::mPixelCount [protected]

Number of visible pixels determined by last query.

Definition at line 123 of file OgreHardwareOcclusionQuery.h.

Referenced by Ogre::D3D11HardwareOcclusionQuery::getLastQuerysPixelcount().

The documentation for this class was generated from the following file:

OgreHardwareOcclusionQuery.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation