Ogre::GLHardwareOcclusionQuery Class Reference

This is a class that is the base class of the query class for hardware occlusion. More...

#include <OgreGLHardwareOcclusionQuery.h>

Inheritance diagram for Ogre::GLHardwareOcclusionQuery:

Public Member Functions
	GLHardwareOcclusionQuery ()
	Default object constructor. More...
	~GLHardwareOcclusionQuery ()
	Object destructor. More...
void	beginOcclusionQuery ()
	Starts the hardware occlusion query. More...
void	endOcclusionQuery ()
	Ends the hardware occlusion test. More...
unsigned int	getLastQuerysPixelcount () const
	Let's you get the last pixel count with out doing the hardware occlusion test. More...
bool	isStillOutstanding (void)
	Lets you know when query is done, or still be processed by the Hardware. More...
bool	pullOcclusionQuery (unsigned int *NumOfFragments)
	Pulls the hardware occlusion query. More...

Detailed Description

This is a class that is the base class of the query class for hardware occlusion.

Author

Lee Sandberg email: lee@a.nosp@m.bcme.nosp@m.dia.s.nosp@m.e Updated on 13/9/2005 by Tuan Kuranes email: tuan..nosp@m.kura.nosp@m.nes@f.nosp@m.ree..nosp@m.fr

Constructor & Destructor Documentation

GLHardwareOcclusionQuery()

Ogre::GLHardwareOcclusionQuery::GLHardwareOcclusionQuery

(

)

Default object constructor.

~GLHardwareOcclusionQuery()

Ogre::GLHardwareOcclusionQuery::~GLHardwareOcclusionQuery

(

)

Object destructor.

Member Function Documentation

beginOcclusionQuery()

void Ogre::GLHardwareOcclusionQuery::beginOcclusionQuery ( )

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 );

Implements Ogre::HardwareOcclusionQuery.

endOcclusionQuery()

void Ogre::GLHardwareOcclusionQuery::endOcclusionQuery ( )

virtual

Ends the hardware occlusion test.

Implements Ogre::HardwareOcclusionQuery.

pullOcclusionQuery()

bool Ogre::GLHardwareOcclusionQuery::pullOcclusionQuery ( unsigned int *  NumOfFragments )

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.

Implements Ogre::HardwareOcclusionQuery.

isStillOutstanding()

bool Ogre::GLHardwareOcclusionQuery::isStillOutstanding ( void  )

virtual

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

Returns

true if query isn't finished.

Implements Ogre::HardwareOcclusionQuery.

getLastQuerysPixelcount()

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

inlineinherited

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.

---

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

• OgreGLHardwareOcclusionQuery.h