OgreRenderTexture.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 __RenderTexture_H__
#define __RenderTexture_H__

#include "OgrePrerequisites.h"
#include "OgreRenderTarget.h"
#include "OgreHeaderPrefix.h"

namespace Ogre
{    
    class _OgreExport RenderTexture: public RenderTarget
    {
    public:
        RenderTexture(HardwarePixelBuffer *buffer, uint32 zoffset);
        virtual ~RenderTexture();

        virtual void copyContentsToMemory(const PixelBox &dst, FrameBuffer buffer);
        PixelFormat suggestPixelFormat() const;

    protected:
        HardwarePixelBuffer *mBuffer;
        uint32 mZOffset;
    };

    class _OgreExport MultiRenderTarget: public RenderTarget
    {
    public:
        MultiRenderTarget(const String &name);

        virtual void bindSurface(size_t attachment, RenderTexture *target)
        {
            for (size_t i = mBoundSurfaces.size(); i <= attachment; ++i)
            {
                mBoundSurfaces.push_back(0);
            }
            mBoundSurfaces[attachment] = target;

            bindSurfaceImpl(attachment, target);
        }



        virtual void unbindSurface(size_t attachment)
        {
            if (attachment < mBoundSurfaces.size())
                mBoundSurfaces[attachment] = 0;
            unbindSurfaceImpl(attachment);
        }

        virtual void copyContentsToMemory(const PixelBox &dst, FrameBuffer buffer);

        PixelFormat suggestPixelFormat() const { return PF_UNKNOWN; }

        typedef vector<RenderTexture*>::type BoundSufaceList;
        const BoundSufaceList& getBoundSurfaceList() const { return mBoundSurfaces; }

        RenderTexture* getBoundSurface(size_t index)
        {
            assert (index < mBoundSurfaces.size());
            return mBoundSurfaces[index];
        }


    protected:
        BoundSufaceList mBoundSurfaces;

        virtual void bindSurfaceImpl(size_t attachment, RenderTexture *target) = 0;
        virtual void unbindSurfaceImpl(size_t attachment) = 0;


    };
}

#include "OgreHeaderSuffix.h"

#endif