Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

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:

Ogre::HardwareOcclusionQuery List of all members.

Public Member Functions

 GLHardwareOcclusionQuery ()
 Default object constructor.

 ~GLHardwareOcclusionQuery ()
 Object destructor.

void beginOcclusionQuery ()
 Starts the hardware occlusion query Simple usage: Create one or more OcclusionQuery object one per outstanding query or one per tested object OcclusionQuery* m_pOcclusionQuery; createOcclusionQuery( &m_pOcclusionQuery ); In the rendering loop: Draw all occluders m_pOcclusionQuery->startOcclusionQuery(); Draw the polygons to be tested m_pOcclusionQuery->endOcclusionQuery();.

void endOcclusionQuery ()
 Ends the hardware occlusion test.

bool pullOcclusionQuery (unsigned int *NumOfFragments)
 Pulls the hardware occlusion query too see if there is a result.

bool isStillOutstanding (void)
unsigned int getLastQuerysPixelcount () const
 Let's you get the last pixel count with out doing the hardware occlusion test.

virtual bool HardwareOcclusionQuery::isStillOutstanding (void)=0
 Lets you know when query is done, or still be processed by the Hardware.


Protected Attributes

unsigned int mPixelCount
bool mIsQueryResultStillOutstanding

Private Attributes

GLuint mQueryID

Detailed Description

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

Author:
Lee Sandberg email: lee@abcmedia.se Updated on 13/9/2005 by Tuan Kuranes email: tuan.kuranes@free.fr

Definition at line 69 of file OgreGLHardwareOcclusionQuery.h.


Constructor & Destructor Documentation

Ogre::GLHardwareOcclusionQuery::GLHardwareOcclusionQuery  ) 
 

Default object constructor.

Ogre::GLHardwareOcclusionQuery::~GLHardwareOcclusionQuery  ) 
 

Object destructor.


Member Function Documentation

void Ogre::GLHardwareOcclusionQuery::beginOcclusionQuery  )  [virtual]
 

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

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

Implements Ogre::HardwareOcclusionQuery.

void Ogre::GLHardwareOcclusionQuery::endOcclusionQuery  )  [virtual]
 

Ends the hardware occlusion test.

Implements Ogre::HardwareOcclusionQuery.

unsigned int Ogre::HardwareOcclusionQuery::getLastQuerysPixelcount  )  const [inherited]
 

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 98 of file OgreHardwareOcclusionQuery.h.

virtual bool Ogre::HardwareOcclusionQuery::HardwareOcclusionQuery::isStillOutstanding void   )  [pure virtual, inherited]
 

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

Returns:
true if query isn't finished.

bool Ogre::GLHardwareOcclusionQuery::isStillOutstanding void   ) 
 

bool Ogre::GLHardwareOcclusionQuery::pullOcclusionQuery unsigned int *  NumOfFragments  )  [virtual]
 

Pulls the hardware occlusion query too see if there is a result.

Return values:
NumOfFragments will get the resulting number of fragments.
Returns:
True if success or false if not.

Implements Ogre::HardwareOcclusionQuery.


Member Data Documentation

bool Ogre::HardwareOcclusionQuery::mIsQueryResultStillOutstanding [protected, inherited]
 

Definition at line 114 of file OgreHardwareOcclusionQuery.h.

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

Definition at line 112 of file OgreHardwareOcclusionQuery.h.

GLuint Ogre::GLHardwareOcclusionQuery::mQueryID [private]
 

Definition at line 99 of file OgreGLHardwareOcclusionQuery.h.


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

Copyright © 2000-2005 by The OGRE Team
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Mar 12 14:52:40 2006