OGRE  1.7
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Attributes | List of all members
Ogre::HardwareOcclusionQuery Class Referenceabstract
RenderSystem

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:
+ Collaboration diagram for Ogre::HardwareOcclusionQuery:

Public Member Functions

 HardwareOcclusionQuery ()
 Object public member functions. More...
 
virtual ~HardwareOcclusionQuery ()
 Object destructor. More...
 
virtual void beginOcclusionQuery ()=0
 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();. More...
 
virtual void endOcclusionQuery ()=0
 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...
 
virtual bool isStillOutstanding (void)=0
 Lets you know when query is done, or still be processed by the Hardware. More...
 
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 More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
virtual bool pullOcclusionQuery (unsigned int *NumOfFragments)=0
 Pulls the hardware occlusion query. More...
 

Protected Attributes

bool mIsQueryResultStillOutstanding
 
unsigned int mPixelCount
 

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..nosp@m.kura.nosp@m.nes@f.nosp@m.ree..nosp@m.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 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 );

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

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

Ends the hardware occlusion test.

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

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

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::D3D9HardwareOcclusionQuery, Ogre::D3D10HardwareOcclusionQuery, and Ogre::D3D11HardwareOcclusionQuery.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 72 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

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

array operator new, with debug line info

Definition at line 85 of file OgreMemoryAllocatedObject.h.

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

Definition at line 90 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
NumOfFragmentswill get the resulting number of fragments.
Returns
True if success or false if not.

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

Member Data Documentation

bool Ogre::HardwareOcclusionQuery::mIsQueryResultStillOutstanding
protected

Definition at line 125 of file OgreHardwareOcclusionQuery.h.

unsigned int Ogre::HardwareOcclusionQuery::mPixelCount
protected

Definition at line 123 of file OgreHardwareOcclusionQuery.h.

Referenced by Ogre::D3D10HardwareOcclusionQuery::getLastQuerysPixelcount(), and Ogre::D3D11HardwareOcclusionQuery::getLastQuerysPixelcount().

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