OGRE  1.9.0
OgreDepthBuffer.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 __DepthBuffer_H__
29#define __DepthBuffer_H__
30
31#include "OgrePrerequisites.h"
32#include "OgreHeaderPrefix.h"
33
34namespace Ogre
35{
83 {
84 public:
85 enum PoolId
86 {
87 POOL_NO_DEPTH = 0,
88 POOL_MANUAL_USAGE = 0,
89 POOL_DEFAULT = 1
90 };
91
92 DepthBuffer( uint16 poolId, uint16 bitDepth, uint32 width, uint32 height,
93 uint32 fsaa, const String &fsaaHint, bool manual );
94 virtual ~DepthBuffer();
95
98 void _setPoolId( uint16 poolId );
99
101 virtual uint16 getPoolId() const;
102 virtual uint16 getBitDepth() const;
103 virtual uint32 getWidth() const;
104 virtual uint32 getHeight() const;
105 virtual uint32 getFsaa() const;
106 virtual const String& getFsaaHint() const;
107
110 bool isManual() const;
111
121 virtual bool isCompatible( RenderTarget *renderTarget ) const;
122
130 virtual void _notifyRenderTargetAttached( RenderTarget *renderTarget );
131
137 virtual void _notifyRenderTargetDetached( RenderTarget *renderTarget );
138
139 protected:
141
148
149 bool mManual; //We don't Release manual surfaces on destruction
151
153 };
154}
155
156#include "OgreHeaderSuffix.h"
157
158#endif
#define _OgreExport
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
An abstract class that contains a depth/stencil buffer.
A 'canvas' which can receive the results of a rendering operation.
virtual uint16 getBitDepth() const
virtual const String & getFsaaHint() const
virtual void _notifyRenderTargetDetached(RenderTarget *renderTarget)
Called when a RenderTarget is detaches from this DepthBuffer.
virtual ~DepthBuffer()
virtual void _notifyRenderTargetAttached(RenderTarget *renderTarget)
Called when a RenderTarget is attaches this DepthBuffer.
RenderTargetSet mAttachedRenderTargets
bool isManual() const
Manual DepthBuffers are cleared in RenderSystem's destructor.
void _setPoolId(uint16 poolId)
Sets the pool id in which this DepthBuffer lives.
virtual uint16 getPoolId() const
Gets the pool id in which this DepthBuffer lives.
set< RenderTarget * >::type RenderTargetSet
DepthBuffer(uint16 poolId, uint16 bitDepth, uint32 width, uint32 height, uint32 fsaa, const String &fsaaHint, bool manual)
void detachFromAllRenderTargets()
virtual uint32 getWidth() const
virtual bool isCompatible(RenderTarget *renderTarget) const
Returns whether the specified RenderTarget is compatible with this DepthBuffer That is,...
virtual uint32 getHeight() const
virtual uint32 getFsaa() const
unsigned short uint16
unsigned int uint32
_StringBase String
std::set< T, P, A > type