OgreHardwareBufferManager.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-2014 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 __HardwareBufferManager__
#define __HardwareBufferManager__

// Precompiler options
#include "OgrePrerequisites.h"

#include "OgreSingleton.h"
#include "OgreHardwareCounterBuffer.h"
#include "OgreHardwareIndexBuffer.h"
#include "OgreHardwareUniformBuffer.h"
#include "OgreHardwareVertexBuffer.h"
#include "OgreRenderToVertexBuffer.h"
#include "OgreHeaderPrefix.h"

namespace Ogre {
    class _OgreExport HardwareBufferLicensee
    {
    public:
        virtual ~HardwareBufferLicensee() { }
        virtual void licenseExpired(HardwareBuffer* buffer) = 0;
    };

    class _OgreExport TempBlendedBufferInfo : public HardwareBufferLicensee, public BufferAlloc
    {
    private:
        // Pre-blended 
        HardwareVertexBufferSharedPtr srcPositionBuffer;
        HardwareVertexBufferSharedPtr srcNormalBuffer;
        // Post-blended 
        HardwareVertexBufferSharedPtr destPositionBuffer;
        HardwareVertexBufferSharedPtr destNormalBuffer;
        bool posNormalShareBuffer;
        unsigned short posBindIndex;
        unsigned short normBindIndex;
        bool bindPositions;
        bool bindNormals;

    public:
        ~TempBlendedBufferInfo(void);
        void extractFrom(const VertexData* sourceData);
        void checkoutTempCopies(bool positions = true, bool normals = true);
        void bindTempCopies(VertexData* targetData, bool suppressHardwareUpload);
        void licenseExpired(HardwareBuffer* buffer);
        bool buffersCheckedOut(bool positions = true, bool normals = true) const;
    };


    class _OgreExport HardwareBufferManagerBase : public BufferAlloc
    {
        friend class HardwareVertexBufferSharedPtr;
        friend class HardwareIndexBufferSharedPtr;
    protected:
        typedef set<HardwareVertexBuffer*>::type VertexBufferList;
        typedef set<HardwareIndexBuffer*>::type IndexBufferList;
        typedef set<HardwareUniformBuffer*>::type UniformBufferList;
        typedef set<HardwareCounterBuffer*>::type CounterBufferList;
        VertexBufferList mVertexBuffers;
        IndexBufferList mIndexBuffers;
        UniformBufferList mUniformBuffers;
        CounterBufferList mCounterBuffers;


        typedef set<VertexDeclaration*>::type VertexDeclarationList;
        typedef set<VertexBufferBinding*>::type VertexBufferBindingList;
        VertexDeclarationList mVertexDeclarations;
        VertexBufferBindingList mVertexBufferBindings;

        // Mutexes
        OGRE_MUTEX(mVertexBuffersMutex);
        OGRE_MUTEX(mIndexBuffersMutex);
        OGRE_MUTEX(mUniformBuffersMutex);
        OGRE_MUTEX(mCounterBuffersMutex);
        OGRE_MUTEX(mVertexDeclarationsMutex);
        OGRE_MUTEX(mVertexBufferBindingsMutex);

        virtual void destroyAllDeclarations(void);
        virtual void destroyAllBindings(void);

        virtual VertexDeclaration* createVertexDeclarationImpl(void);
        virtual void destroyVertexDeclarationImpl(VertexDeclaration* decl);

        virtual VertexBufferBinding* createVertexBufferBindingImpl(void);
        virtual void destroyVertexBufferBindingImpl(VertexBufferBinding* binding);

    public:

        enum BufferLicenseType
        {
            BLT_MANUAL_RELEASE,
            BLT_AUTOMATIC_RELEASE
        };

    protected:
        class _OgrePrivate VertexBufferLicense
        {
        public:
            HardwareVertexBuffer* originalBufferPtr;
            BufferLicenseType licenseType;
            size_t expiredDelay;
            HardwareVertexBufferSharedPtr buffer;
            HardwareBufferLicensee* licensee;
            VertexBufferLicense(
                HardwareVertexBuffer* orig,
                BufferLicenseType ltype, 
                size_t delay,
                HardwareVertexBufferSharedPtr buf, 
                HardwareBufferLicensee* lic) 
                : originalBufferPtr(orig)
                , licenseType(ltype)
                , expiredDelay(delay)
                , buffer(buf)
                , licensee(lic)
            {}

        };

        typedef multimap<HardwareVertexBuffer*, HardwareVertexBufferSharedPtr>::type FreeTemporaryVertexBufferMap;
        FreeTemporaryVertexBufferMap mFreeTempVertexBufferMap;
        typedef map<HardwareVertexBuffer*, VertexBufferLicense>::type TemporaryVertexBufferLicenseMap;
        TemporaryVertexBufferLicenseMap mTempVertexBufferLicenses;
        size_t mUnderUsedFrameCount;
        static const size_t UNDER_USED_FRAME_THRESHOLD;
        static const size_t EXPIRED_DELAY_FRAME_THRESHOLD;
        // Mutexes
        OGRE_MUTEX(mTempBuffersMutex);


        virtual HardwareVertexBufferSharedPtr makeBufferCopy(
            const HardwareVertexBufferSharedPtr& source, 
            HardwareBuffer::Usage usage, bool useShadowBuffer);

    public:
        HardwareBufferManagerBase();
        virtual ~HardwareBufferManagerBase();
        virtual HardwareVertexBufferSharedPtr 
            createVertexBuffer(size_t vertexSize, size_t numVerts, HardwareBuffer::Usage usage, 
            bool useShadowBuffer = false) = 0;
        virtual HardwareIndexBufferSharedPtr 
            createIndexBuffer(HardwareIndexBuffer::IndexType itype, size_t numIndexes, 
            HardwareBuffer::Usage usage, bool useShadowBuffer = false) = 0;

        virtual RenderToVertexBufferSharedPtr createRenderToVertexBuffer() = 0;

        virtual HardwareUniformBufferSharedPtr createUniformBuffer(size_t sizeBytes, 
                                    HardwareBuffer::Usage usage = HardwareBuffer::HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE, 
                                    bool useShadowBuffer = false, const String& name = "") = 0;

        virtual HardwareCounterBufferSharedPtr createCounterBuffer(size_t sizeBytes,
                                                                   HardwareBuffer::Usage usage = HardwareBuffer::HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE,
                                                                   bool useShadowBuffer = false, const String& name = "") = 0;

        virtual VertexDeclaration* createVertexDeclaration(void);
        virtual void destroyVertexDeclaration(VertexDeclaration* decl);

        virtual VertexBufferBinding* createVertexBufferBinding(void);
        virtual void destroyVertexBufferBinding(VertexBufferBinding* binding);

        virtual void registerVertexBufferSourceAndCopy(
            const HardwareVertexBufferSharedPtr& sourceBuffer,
            const HardwareVertexBufferSharedPtr& copy);

        virtual HardwareVertexBufferSharedPtr allocateVertexBufferCopy(
            const HardwareVertexBufferSharedPtr& sourceBuffer, 
            BufferLicenseType licenseType,
            HardwareBufferLicensee* licensee,
            bool copyData = false);

        virtual void releaseVertexBufferCopy(
            const HardwareVertexBufferSharedPtr& bufferCopy); 

        virtual void touchVertexBufferCopy(const HardwareVertexBufferSharedPtr& bufferCopy);

        virtual void _freeUnusedBufferCopies(void);

        virtual void _releaseBufferCopies(bool forceFreeUnused = false);

        virtual void _forceReleaseBufferCopies(const HardwareVertexBufferSharedPtr& sourceBuffer);

        virtual void _forceReleaseBufferCopies(HardwareVertexBuffer* sourceBuffer);

        void _notifyVertexBufferDestroyed(HardwareVertexBuffer* buf);
        void _notifyIndexBufferDestroyed(HardwareIndexBuffer* buf);
        void _notifyUniformBufferDestroyed(HardwareUniformBuffer* buf);
        void _notifyCounterBufferDestroyed(HardwareCounterBuffer* buf);
    };

    class _OgreExport HardwareBufferManager : public HardwareBufferManagerBase, public Singleton<HardwareBufferManager>
    {
        friend class HardwareVertexBufferSharedPtr;
        friend class HardwareIndexBufferSharedPtr;
    protected:
        HardwareBufferManagerBase* mImpl;
    public:
        HardwareBufferManager(HardwareBufferManagerBase* imp);
        ~HardwareBufferManager();

        HardwareVertexBufferSharedPtr 
            createVertexBuffer(size_t vertexSize, size_t numVerts, HardwareBuffer::Usage usage, 
            bool useShadowBuffer = false)
        {
            return mImpl->createVertexBuffer(vertexSize, numVerts, usage, useShadowBuffer);
        }
        HardwareIndexBufferSharedPtr 
            createIndexBuffer(HardwareIndexBuffer::IndexType itype, size_t numIndexes, 
            HardwareBuffer::Usage usage, bool useShadowBuffer = false)
        {
            return mImpl->createIndexBuffer(itype, numIndexes, usage, useShadowBuffer);
        }

        RenderToVertexBufferSharedPtr createRenderToVertexBuffer()
        {
            return mImpl->createRenderToVertexBuffer();
        }

        HardwareUniformBufferSharedPtr
                createUniformBuffer(size_t sizeBytes, HardwareBuffer::Usage usage, bool useShadowBuffer, const String& name = "")
        {
            return mImpl->createUniformBuffer(sizeBytes, usage, useShadowBuffer, name);
        }
        
        HardwareCounterBufferSharedPtr
        createCounterBuffer(size_t sizeBytes, HardwareBuffer::Usage usage, bool useShadowBuffer, const String& name = "")
        {
            return mImpl->createCounterBuffer(sizeBytes, usage, useShadowBuffer, name);
        }

        virtual VertexDeclaration* createVertexDeclaration(void)
        {
            return mImpl->createVertexDeclaration();
        }
        virtual void destroyVertexDeclaration(VertexDeclaration* decl)
        {
            mImpl->destroyVertexDeclaration(decl);
        }

        virtual VertexBufferBinding* createVertexBufferBinding(void)
        {
            return mImpl->createVertexBufferBinding();
        }
        virtual void destroyVertexBufferBinding(VertexBufferBinding* binding)
        {
            mImpl->destroyVertexBufferBinding(binding);
        }
        virtual void registerVertexBufferSourceAndCopy(
            const HardwareVertexBufferSharedPtr& sourceBuffer,
            const HardwareVertexBufferSharedPtr& copy)
        {
            mImpl->registerVertexBufferSourceAndCopy(sourceBuffer, copy);
        }
        virtual HardwareVertexBufferSharedPtr allocateVertexBufferCopy(
            const HardwareVertexBufferSharedPtr& sourceBuffer, 
            BufferLicenseType licenseType,
            HardwareBufferLicensee* licensee,
            bool copyData = false)
        {
            return mImpl->allocateVertexBufferCopy(sourceBuffer, licenseType, licensee, copyData);
        }
        virtual void releaseVertexBufferCopy(
            const HardwareVertexBufferSharedPtr& bufferCopy)
        {
            mImpl->releaseVertexBufferCopy(bufferCopy);
        }

        virtual void touchVertexBufferCopy(
            const HardwareVertexBufferSharedPtr& bufferCopy)
        {
            mImpl->touchVertexBufferCopy(bufferCopy);
        }

        virtual void _freeUnusedBufferCopies(void)
        {
            mImpl->_freeUnusedBufferCopies();
        }
        virtual void _releaseBufferCopies(bool forceFreeUnused = false)
        {
            mImpl->_releaseBufferCopies(forceFreeUnused);
        }
        virtual void _forceReleaseBufferCopies(
            const HardwareVertexBufferSharedPtr& sourceBuffer)
        {
            mImpl->_forceReleaseBufferCopies(sourceBuffer);
        }
        virtual void _forceReleaseBufferCopies(HardwareVertexBuffer* sourceBuffer)
        {
            mImpl->_forceReleaseBufferCopies(sourceBuffer);
        }
        void _notifyVertexBufferDestroyed(HardwareVertexBuffer* buf)
        {
            mImpl->_notifyVertexBufferDestroyed(buf);
        }
        void _notifyIndexBufferDestroyed(HardwareIndexBuffer* buf)
        {
            mImpl->_notifyIndexBufferDestroyed(buf);
        }
        void _notifyUniformBufferDestroyed(HardwareUniformBuffer* buf)
        {
            mImpl->_notifyUniformBufferDestroyed(buf);
        }
        void _notifyConterBufferDestroyed(HardwareCounterBuffer* buf)
        {
            mImpl->_notifyCounterBufferDestroyed(buf);
        }

        static HardwareBufferManager& getSingleton(void);
        static HardwareBufferManager* getSingletonPtr(void);

    };

} // namespace Ogre

#include "OgreHeaderSuffix.h"

#endif // __HardwareBufferManager__