OgreHardwarePixelBuffer.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-2013 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 __HardwarePixelBuffer__
#define __HardwarePixelBuffer__

// Precompiler options
#include "OgrePrerequisites.h"
#include "OgreHardwareBuffer.h"
#include "OgreSharedPtr.h"
#include "OgrePixelFormat.h"
#include "OgreImage.h"
#include "OgreHeaderPrefix.h"

namespace Ogre {

    class _OgreExport HardwarePixelBuffer : public HardwareBuffer
    {
    protected: 
        // Extents
        size_t mWidth, mHeight, mDepth;
        // Pitches (offsets between rows and slices)
        size_t mRowPitch, mSlicePitch;
        // Internal format
        PixelFormat mFormat;
        // Currently locked region (local coords)
        PixelBox mCurrentLock;
        // The current locked box of this surface (entire surface coords)
        Image::Box mLockedBox;

        
        virtual PixelBox lockImpl(const Image::Box lockBox,  LockOptions options) = 0;

        virtual void* lockImpl(size_t offset, size_t length, LockOptions options);

        // virtual void unlockImpl(void) = 0;

        virtual void _clearSliceRTT(size_t zoffset);
        friend class RenderTexture;
    public:
        HardwarePixelBuffer(size_t mWidth, size_t mHeight, size_t mDepth,
                PixelFormat mFormat,
                HardwareBuffer::Usage usage, bool useSystemMemory, bool useShadowBuffer);
        ~HardwarePixelBuffer();

        using HardwareBuffer::lock; 

        virtual const PixelBox& lock(const Image::Box& lockBox, LockOptions options);
        virtual void* lock(size_t offset, size_t length, LockOptions options);

        const PixelBox& getCurrentLock();
        
        virtual void readData(size_t offset, size_t length, void* pDest);
        virtual void writeData(size_t offset, size_t length, const void* pSource,
                bool discardWholeBuffer = false);
        
        virtual void blit(const HardwarePixelBufferSharedPtr &src, const Image::Box &srcBox, const Image::Box &dstBox);

        void blit(const HardwarePixelBufferSharedPtr &src); 
        
        virtual void blitFromMemory(const PixelBox &src, const Image::Box &dstBox) = 0;
        
        void blitFromMemory(const PixelBox &src)
        {
            blitFromMemory(src, Box(0,0,0,mWidth,mHeight,mDepth));
        }
        
        virtual void blitToMemory(const Image::Box &srcBox, const PixelBox &dst) = 0;

        void blitToMemory(const PixelBox &dst)
        {
            blitToMemory(Box(0,0,0,mWidth,mHeight,mDepth), dst);
        }
        
        virtual RenderTexture *getRenderTarget(size_t slice=0);
        
        size_t getWidth() const { return mWidth; }
        size_t getHeight() const { return mHeight; }
        size_t getDepth() const { return mDepth; }
        PixelFormat getFormat() const { return mFormat; }
    };

    class _OgreExport HardwarePixelBufferSharedPtr : public SharedPtr<HardwarePixelBuffer>
    {
    public:
        HardwarePixelBufferSharedPtr() : SharedPtr<HardwarePixelBuffer>() {}
        explicit HardwarePixelBufferSharedPtr(HardwarePixelBuffer* buf);


    };

}

#include "OgreHeaderSuffix.h"

#endif