OgreDepthBuffer.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
    (Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2012 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef __DepthBuffer_H__
#define __DepthBuffer_H__

#include "OgrePrerequisites.h"

namespace Ogre
{
    class _OgreExport DepthBuffer : public RenderSysAlloc
    {
    public:
        enum PoolId
        {
            POOL_NO_DEPTH       = 0,
            POOL_MANUAL_USAGE   = 0,
            POOL_DEFAULT        = 1
        };

        DepthBuffer( uint16 poolId, uint16 bitDepth, uint32 width, uint32 height,
                     uint32 fsaa, const String &fsaaHint, bool manual );
        virtual ~DepthBuffer();

        //Sets the pool id in which this DepthBuffer lives
        //Note this will detach any render target from this depth buffer
        void _setPoolId( uint16 poolId );

        //Gets the pool id in which this DepthBuffer lives
        virtual uint16 getPoolId() const;
        virtual uint16 getBitDepth() const;
        virtual uint32 getWidth() const;
        virtual uint32 getHeight() const;
        virtual uint32 getFsaa() const;
        virtual const String& getFsaaHint() const;

        //Manual DepthBuffers are cleared in RenderSystem's destructor. Non-manual ones are released
        //with it's render target (aka, a backbuffer or similar)
        bool isManual() const;

        virtual bool isCompatible( RenderTarget *renderTarget ) const;

        virtual void _notifyRenderTargetAttached( RenderTarget *renderTarget );

        virtual void _notifyRenderTargetDetached( RenderTarget *renderTarget );

    protected:
        typedef set<RenderTarget*>::type RenderTargetSet;

        uint16                      mPoolId;
        uint16                      mBitDepth;
        uint32                      mWidth;
        uint32                      mHeight;
        uint32                      mFsaa;
        String                      mFsaaHint;

        bool                        mManual; //We don't Release manual surfaces on destruction
        RenderTargetSet             mAttachedRenderTargets;

        void detachFromAllRenderTargets();
    };
}

#endif