OgreRenderTarget.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 __RenderTarget_H__
#define __RenderTarget_H__

#include "OgrePrerequisites.h"

#include "OgreString.h"
#include "OgreTextureManager.h"
#include "OgreViewport.h"
#include "OgreTimer.h"

/* Define the number of priority groups for the render system's render targets. */
#ifndef OGRE_NUM_RENDERTARGET_GROUPS
    #define OGRE_NUM_RENDERTARGET_GROUPS 10
    #define OGRE_DEFAULT_RT_GROUP 4
    #define OGRE_REND_TO_TEX_RT_GROUP 2
#endif

namespace Ogre {

    class _OgreExport RenderTarget
    {
    public:
        enum StatFlags
        {
            SF_NONE           = 0,
            SF_FPS            = 1,
            SF_AVG_FPS        = 2,
            SF_BEST_FPS       = 4,
            SF_WORST_FPS      = 8,
            SF_TRIANGLE_COUNT = 16,
            SF_ALL            = 0xFFFF
        };

        struct FrameStats
        {
            float lastFPS;
            float avgFPS;
            float bestFPS;
            float worstFPS;
            unsigned long bestFrameTime;
            unsigned long worstFrameTime;
            size_t triangleCount;
        };

        RenderTarget();
        virtual ~RenderTarget();

        virtual const String& getName(void) const;

        virtual void getMetrics(unsigned int& width, unsigned int& height, unsigned int& colourDepth);

        virtual unsigned int getWidth(void) const;
        virtual unsigned int getHeight(void) const;
        virtual unsigned int getColourDepth(void) const;

        virtual void update(void);

        virtual Viewport* addViewport(Camera* cam, int ZOrder = 0, float left = 0.0f, float top = 0.0f ,
            float width = 1.0f, float height = 1.0f);

        virtual unsigned short getNumViewports(void) const;

        virtual Viewport* getViewport(unsigned short index);

        virtual void removeViewport(int ZOrder);

        virtual void removeAllViewports(void);

        virtual void getStatistics(float& lastFPS, float& avgFPS,
            float& bestFPS, float& worstFPS) const;  // Access to stats

        virtual const FrameStats& getStatistics(void) const;

        virtual float getLastFPS() const;

        virtual float getAverageFPS() const;

        virtual float getBestFPS() const;

        virtual float getWorstFPS() const;

        virtual float getBestFrameTime() const;

        virtual float getWorstFrameTime() const;

        virtual void resetStatistics(void);

        virtual void getCustomAttribute(const String& name, void* pData);

        virtual void setDebugText(const String& text);

        const String& getDebugText() const;

        virtual void addListener(RenderTargetListener* listener);
        virtual void removeListener(RenderTargetListener* listener);
        virtual void removeAllListeners(void);

        virtual void setPriority( uchar priority ) { mPriority = priority; }
        virtual uchar getPriority() const { return mPriority; }

        virtual bool isActive() const;

        virtual void setActive( bool state );

        virtual void setAutoUpdated(bool autoupdate);
        virtual bool isAutoUpdated(void) const;

        virtual void writeContentsToFile(const String& filename) = 0;

    virtual String writeContentsToTimestampedFile(const String& filenamePrefix, const String& filenameSuffix);

        virtual bool requiresTextureFlipping() const = 0;

        virtual size_t getTriangleCount(void) const;
        virtual void _notifyCameraRemoved(const Camera* cam);

        virtual bool isPrimary(void) const;

    protected:
        String mName;
        uchar mPriority;

        unsigned int mWidth;
        unsigned int mHeight;
        unsigned int mColourDepth;
        bool mIsDepthBuffered;

        // Stats
        FrameStats mStats;
        
        Timer* mTimer ;
        String mDebugText;
        unsigned long mLastSecond;
        unsigned long mLastTime;
        size_t mFrameCount;

        bool mActive;
        bool mAutoUpdate;

        void updateStats(void);

        typedef std::map<int, Viewport*, std::less<int> > ViewportList;
        ViewportList mViewportList;

        typedef std::vector<RenderTargetListener*> RenderTargetListenerList;
        RenderTargetListenerList mListeners;

        virtual void firePreUpdate(void);
        virtual void firePostUpdate(void);
        virtual void fireViewportPreUpdate(Viewport* vp);
        virtual void fireViewportPostUpdate(Viewport* vp);
    };

} // Namespace

#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:51 2006