OGRE  1.9.0
OgreHardwareOcclusionQuery.h
Go to the documentation of this file.
1/*
2-----------------------------------------------------------------------------
3This source file is part of OGRE
4 (Object-oriented Graphics Rendering Engine)
5For the latest info, see http://www.ogre3d.org
6
7Copyright (c) 2000-2014 Torus Knot Software Ltd
8
9Permission is hereby granted, free of charge, to any person obtaining a copy
10of this software and associated documentation files (the "Software"), to deal
11in the Software without restriction, including without limitation the rights
12to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13copies of the Software, and to permit persons to whom the Software is
14furnished to do so, subject to the following conditions:
15
16The above copyright notice and this permission notice shall be included in
17all copies or substantial portions of the Software.
18
19THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25THE SOFTWARE.
26-----------------------------------------------------------------------------
27*/
28#ifndef _HardwareOcclusionQuery__
29#define _HardwareOcclusionQuery__
30
31// Precompiler options
32#include "OgrePrerequisites.h"
33
34namespace Ogre {
35
36
37
52{
53//----------------------------------------------------------------------
54// Public methods
55//--
56public:
66
71
88 virtual void beginOcclusionQuery() = 0;
89
93 virtual void endOcclusionQuery() = 0;
94
102 virtual bool pullOcclusionQuery(unsigned int* NumOfFragments) = 0;
103
109 unsigned int getLastQuerysPixelcount() const { return mPixelCount; }
110
115 virtual bool isStillOutstanding(void) = 0;
116
117
118 //----------------------------------------------------------------------
119 // protected members
120 //--
121 protected :
123 unsigned int mPixelCount;
126};
127
130}
131#endif
132
#define _OgreExport
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
This is a abstract class that that provides the interface for the query class for hardware occlusion.
bool mIsQueryResultStillOutstanding
Has the query returned a result yet?
virtual void beginOcclusionQuery()=0
Starts the hardware occlusion query.
HardwareOcclusionQuery()
Object public member functions.
virtual ~HardwareOcclusionQuery()
Object destructor.
virtual void endOcclusionQuery()=0
Ends the hardware occlusion test.
virtual bool isStillOutstanding(void)=0
Lets you know when query is done, or still be processed by the Hardware.
unsigned int getLastQuerysPixelcount() const
Let's you get the last pixel count with out doing the hardware occlusion test.
unsigned int mPixelCount
Number of visible pixels determined by last query.
virtual bool pullOcclusionQuery(unsigned int *NumOfFragments)=0
Pulls the hardware occlusion query.