OgreDepthBuffer.h
Go to the documentation of this file.

    00001 /*
    00002 -----------------------------------------------------------------------------
    00003 This source file is part of OGRE
    00004     (Object-oriented Graphics Rendering Engine)
    00005 For the latest info, see http://www.ogre3d.org/
    00006
    00007 Copyright (c) 2000-2012 Torus Knot Software Ltd
    00008
    00009 Permission is hereby granted, free of charge, to any person obtaining a copy
    00010 of this software and associated documentation files (the "Software"), to deal
    00011 in the Software without restriction, including without limitation the rights
    00012 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    00013 copies of the Software, and to permit persons to whom the Software is
    00014 furnished to do so, subject to the following conditions:
    00015
    00016 The above copyright notice and this permission notice shall be included in
    00017 all copies or substantial portions of the Software.
    00018
    00019 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    00020 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    00021 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    00022 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    00023 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    00024 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    00025 THE SOFTWARE.
    00026 -----------------------------------------------------------------------------
    00027 */
    00028 #ifndef __DepthBuffer_H__
    00029 #define __DepthBuffer_H__
    00030
    00031 #include "OgrePrerequisites.h"
    00032
    00033 namespace Ogre
    00034 {
    00081     class _OgreExport DepthBuffer : public RenderSysAlloc
    00082     {
    00083     public:
    00084         enum PoolId
    00085         {
    00086             POOL_NO_DEPTH       = 0,
    00087             POOL_MANUAL_USAGE   = 0,
    00088             POOL_DEFAULT        = 1
    00089         };
    00090
    00091         DepthBuffer( uint16 poolId, uint16 bitDepth, uint32 width, uint32 height,
    00092                      uint32 fsaa, const String &fsaaHint, bool manual );
    00093         virtual ~DepthBuffer();
    00094
    00095         //Sets the pool id in which this DepthBuffer lives
    00096         //Note this will detach any render target from this depth buffer
    00097         void _setPoolId( uint16 poolId );
    00098
    00099         //Gets the pool id in which this DepthBuffer lives
    00100         virtual uint16 getPoolId() const;
    00101         virtual uint16 getBitDepth() const;
    00102         virtual uint32 getWidth() const;
    00103         virtual uint32 getHeight() const;
    00104         virtual uint32 getFsaa() const;
    00105         virtual const String& getFsaaHint() const;
    00106
    00107         //Manual DepthBuffers are cleared in RenderSystem's destructor. Non-manual ones are released
    00108         //with it's render target (aka, a backbuffer or similar)
    00109         bool isManual() const;
    00110
    00120         virtual bool isCompatible( RenderTarget *renderTarget ) const;
    00121
    00129         virtual void _notifyRenderTargetAttached( RenderTarget *renderTarget );
    00130
    00136         virtual void _notifyRenderTargetDetached( RenderTarget *renderTarget );
    00137
    00138     protected:
    00139         typedef set<RenderTarget*>::type RenderTargetSet;
    00140
    00141         uint16                      mPoolId;
    00142         uint16                      mBitDepth;
    00143         uint32                      mWidth;
    00144         uint32                      mHeight;
    00145         uint32                      mFsaa;
    00146         String                      mFsaaHint;
    00147
    00148         bool                        mManual; //We don't Release manual surfaces on destruction
    00149         RenderTargetSet             mAttachedRenderTargets;
    00150
    00151         void detachFromAllRenderTargets();
    00152     };
    00153 }
    00154
    00155 #endif

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Sun Sep 2 2012 07:27:21