Ogre::D3D9HardwareOcclusionQuery Class Reference

This is a class that is the DirectX9 implementation of hardware occlusion testing. More...

#include <OgreD3D9HardwareOcclusionQuery.h>

Inheritance diagram for Ogre::D3D9HardwareOcclusionQuery:

Public Member Functions
	D3D9HardwareOcclusionQuery ()
	Default object constructor. More...
	~D3D9HardwareOcclusionQuery ()
	Object destructor. More...
void	beginOcclusionQuery ()
	Starts the hardware occlusion query. More...
void	endOcclusionQuery ()
	Ends the hardware occlusion test. More...
unsigned int	getLastQuerysPixelcount ()
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...
virtual void	notifyOnDeviceCreate (IDirect3DDevice9 *d3d9Device)
virtual void	notifyOnDeviceDestroy (IDirect3DDevice9 *d3d9Device)
virtual void	notifyOnDeviceLost (IDirect3DDevice9 *d3d9Device)
virtual void	notifyOnDeviceReset (IDirect3DDevice9 *d3d9Device)
bool	pullOcclusionQuery (unsigned int *NumOfFragments)
	Pulls the hardware occlusion query. More...

Static Public Member Functions
static void	lockDeviceAccess ()
static void	unlockDeviceAccess ()

Detailed Description

This is a class that is the DirectX9 implementation of hardware occlusion testing.

Author

Lee Sandberg, email lee@a.nosp@m.bcme.nosp@m.dia.s.nosp@m.e

Updated on 12/7/2004 by Chris McGuirk Updated on 4/8/2005 by Tuan Kuranes email: tuan..nosp@m.kura.nosp@m.nes@f.nosp@m.ree..nosp@m.fr

Constructor & Destructor Documentation

D3D9HardwareOcclusionQuery()

Ogre::D3D9HardwareOcclusionQuery::D3D9HardwareOcclusionQuery

(

)

Default object constructor.

~D3D9HardwareOcclusionQuery()

Ogre::D3D9HardwareOcclusionQuery::~D3D9HardwareOcclusionQuery

(

)

Object destructor.

Member Function Documentation

beginOcclusionQuery()

void Ogre::D3D9HardwareOcclusionQuery::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::D3D9HardwareOcclusionQuery::endOcclusionQuery ( )

virtual

Ends the hardware occlusion test.

Implements Ogre::HardwareOcclusionQuery.

pullOcclusionQuery()

bool Ogre::D3D9HardwareOcclusionQuery::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.

getLastQuerysPixelcount() [1/2]

unsigned int Ogre::D3D9HardwareOcclusionQuery::getLastQuerysPixelcount

(

)

isStillOutstanding()

bool Ogre::D3D9HardwareOcclusionQuery::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.

notifyOnDeviceCreate()

virtual void Ogre::D3D9HardwareOcclusionQuery::notifyOnDeviceCreate ( IDirect3DDevice9 *  d3d9Device )

virtual

Reimplemented from Ogre::D3D9Resource.

notifyOnDeviceDestroy()

virtual void Ogre::D3D9HardwareOcclusionQuery::notifyOnDeviceDestroy ( IDirect3DDevice9 *  d3d9Device )

virtual

Reimplemented from Ogre::D3D9Resource.

notifyOnDeviceLost()

virtual void Ogre::D3D9HardwareOcclusionQuery::notifyOnDeviceLost ( IDirect3DDevice9 *  d3d9Device )

virtual

Reimplemented from Ogre::D3D9Resource.

notifyOnDeviceReset()

virtual void Ogre::D3D9HardwareOcclusionQuery::notifyOnDeviceReset ( IDirect3DDevice9 *  d3d9Device )

virtual

Reimplemented from Ogre::D3D9Resource.

getLastQuerysPixelcount() [2/2]

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.

lockDeviceAccess()

static void Ogre::D3D9Resource::lockDeviceAccess ( )

staticinherited

unlockDeviceAccess()

static void Ogre::D3D9Resource::unlockDeviceAccess ( )

staticinherited

---

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

• OgreD3D9HardwareOcclusionQuery.h