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-2005 The OGRE Team
Also see acknowledgements in Readme.html

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/copyleft/lesser.txt.
-----------------------------------------------------------------------------
*/
#ifndef __HardwarePixelBuffer__
#define __HardwarePixelBuffer__

// Precompiler options
#include "OgrePrerequisites.h"
#include "OgreHardwareBuffer.h"
#include "OgreSharedPtr.h"
#include "OgrePixelFormat.h"
#include "OgreImage.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
        PixelBox mCurrentLock;
        
        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;
    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(HardwarePixelBuffer *src, const Image::Box &srcBox, const Image::Box &dstBox);

        void blit(HardwarePixelBuffer *src)
        {
            blit(src, 
                Box(0,0,0,src->getWidth(),src->getHeight(),src->getDepth()), 
                Box(0,0,0,mWidth,mHeight,mDepth)
            );
        }
        
        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);
        }
        
        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);


    };

}
#endif

---

Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Feb 12 12:59:46 2006