OgreDepthBuffer.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4  (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2013 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 #ifndef __DepthBuffer_H__
29 #define __DepthBuffer_H__
30 
31 #include "OgrePrerequisites.h"
32 #include "OgreHeaderPrefix.h"
33 
34 namespace 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
OgreHeaderSuffix.h
Ogre::AllocatedObject
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Definition: OgreMemoryAllocatedObject.h:59
Ogre
Definition: OgreAndroidLogListener.h:35
Ogre::DepthBuffer
An abstract class that contains a depth/stencil buffer.
Definition: OgreDepthBuffer.h:83
Ogre::set
Definition: OgrePrerequisites.h:520
Ogre::DepthBuffer::PoolId
PoolId
Definition: OgreDepthBuffer.h:86
Ogre::DepthBuffer::mFsaa
uint32 mFsaa
Definition: OgreDepthBuffer.h:146
Ogre::DepthBuffer::isCompatible
virtual bool isCompatible(RenderTarget *renderTarget) const
Returns whether the specified RenderTarget is compatible with this DepthBuffer That is,...
Ogre::uint16
unsigned short uint16
Definition: OgrePlatform.h:360
Ogre::DepthBuffer::mAttachedRenderTargets
RenderTargetSet mAttachedRenderTargets
Definition: OgreDepthBuffer.h:150
Ogre::DepthBuffer::DepthBuffer
DepthBuffer(uint16 poolId, uint16 bitDepth, uint32 width, uint32 height, uint32 fsaa, const String &fsaaHint, bool manual)
Ogre::DepthBuffer::mPoolId
uint16 mPoolId
Definition: OgreDepthBuffer.h:142
Ogre::uint32
unsigned int uint32
Definition: OgrePlatform.h:359
Ogre::DepthBuffer::getFsaa
virtual uint32 getFsaa() const
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::DepthBuffer::mBitDepth
uint16 mBitDepth
Definition: OgreDepthBuffer.h:143
Ogre::DepthBuffer::~DepthBuffer
virtual ~DepthBuffer()
Ogre::DepthBuffer::isManual
bool isManual() const
Manual DepthBuffers are cleared in RenderSystem's destructor.
OgreHeaderPrefix.h
Ogre::RenderTarget
A 'canvas' which can receive the results of a rendering operation.
Definition: OgreRenderTarget.h:66
Ogre::DepthBuffer::getBitDepth
virtual uint16 getBitDepth() const
Ogre::DepthBuffer::_notifyRenderTargetAttached
virtual void _notifyRenderTargetAttached(RenderTarget *renderTarget)
Called when a RenderTarget is attaches this DepthBuffer.
OgrePrerequisites.h
Ogre::DepthBuffer::detachFromAllRenderTargets
void detachFromAllRenderTargets()
Ogre::DepthBuffer::mHeight
uint32 mHeight
Definition: OgreDepthBuffer.h:145
_OgreExport
#define _OgreExport
Definition: OgrePlatform.h:257
Ogre::DepthBuffer::getHeight
virtual uint32 getHeight() const
Ogre::DepthBuffer::_notifyRenderTargetDetached
virtual void _notifyRenderTargetDetached(RenderTarget *renderTarget)
Called when a RenderTarget is detaches from this DepthBuffer.
Ogre::DepthBuffer::_setPoolId
void _setPoolId(uint16 poolId)
Sets the pool id in which this DepthBuffer lives.
Ogre::DepthBuffer::mWidth
uint32 mWidth
Definition: OgreDepthBuffer.h:144
Ogre::DepthBuffer::getPoolId
virtual uint16 getPoolId() const
Gets the pool id in which this DepthBuffer lives.
Ogre::DepthBuffer::RenderTargetSet
set< RenderTarget * >::type RenderTargetSet
Definition: OgreDepthBuffer.h:140
Ogre::DepthBuffer::mFsaaHint
String mFsaaHint
Definition: OgreDepthBuffer.h:147
Ogre::DepthBuffer::getWidth
virtual uint32 getWidth() const
Ogre::DepthBuffer::getFsaaHint
virtual const String & getFsaaHint() const
Ogre::DepthBuffer::mManual
bool mManual
Definition: OgreDepthBuffer.h:149

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.