OgreProfiler.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-2011 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.
-----------------------------------------------------------------------------
*/
/*

    Although the code is original, many of the ideas for the profiler were borrowed from 
"Real-Time In-Game Profiling" by Steve Rabin which can be found in Game Programming
Gems 1.

    This code can easily be adapted to your own non-Ogre project. The only code that is 
Ogre-dependent is in the visualization/logging routines and the use of the Timer class.

    Enjoy!

*/

#ifndef __Profiler_H__
#define __Profiler_H__

#include "OgrePrerequisites.h"
#include "OgreSingleton.h"
#include "OgreString.h"
#include "OgreOverlay.h"

#if OGRE_PROFILING == 1
#   define OgreProfile( a ) Ogre::Profile _OgreProfileInstance( (a) )
#   define OgreProfileBegin( a ) Ogre::Profiler::getSingleton().beginProfile( (a) )
#   define OgreProfileEnd( a ) Ogre::Profiler::getSingleton().endProfile( (a) )
#   define OgreProfileGroup( a, g ) Ogre::Profile _OgreProfileInstance( (a), (g) )
#   define OgreProfileBeginGroup( a, g ) Ogre::Profiler::getSingleton().beginProfile( (a), (g) )
#   define OgreProfileEndGroup( a, g ) Ogre::Profiler::getSingleton().endProfile( (a), (g) )
#else
#   define OgreProfile( a )
#   define OgreProfileBegin( a )
#   define OgreProfileEnd( a )
#   define OgreProfileGroup( a, g ) 
#   define OgreProfileBeginGroup( a, g ) 
#   define OgreProfileEndGroup( a, g ) 
#endif

namespace Ogre {
    enum ProfileGroupMask
    {
        OGREPROF_USER_DEFAULT = 0x00000001,
        OGREPROF_ALL = 0xFF000000,
        OGREPROF_GENERAL = 0x80000000,
        OGREPROF_CULLING = 0x40000000,
        OGREPROF_RENDERING = 0x20000000
    };

    class _OgreExport Profile : public ProfilerAlloc {

        public:
            Profile(const String& profileName, uint32 groupID = (uint32)OGREPROF_USER_DEFAULT);
            ~Profile();

        protected:

            String mName;
            uint32 mGroupID;
            

    };

    class _OgreExport Profiler : public Singleton<Profiler>, public ProfilerAlloc {

        public:
            Profiler();
            ~Profiler();

            void setTimer(Timer* t);

            Timer* getTimer();

            void beginProfile(const String& profileName, uint32 groupID = (uint32)OGREPROF_USER_DEFAULT);

            void endProfile(const String& profileName, uint32 groupID = (uint32)OGREPROF_USER_DEFAULT);

            void setEnabled(bool enabled);

            bool getEnabled() const;

            void enableProfile(const String& profileName);

            void disableProfile(const String& profileName);

            void setProfileGroupMask(uint32 mask) { mProfileMask = mask; }
            uint32 getProfileGroupMask() const { return mProfileMask; }

            bool watchForMax(const String& profileName);

            bool watchForMin(const String& profileName);

            bool watchForLimit(const String& profileName, Real limit, bool greaterThan = true);

            void logResults();

            void reset();

            enum DisplayMode
            {
                DISPLAY_PERCENTAGE,
                DISPLAY_MILLISECONDS
            };

            void setDisplayMode(DisplayMode d) { mDisplayMode = d; }
            DisplayMode getDisplayMode() const { return mDisplayMode; }

            void setUpdateDisplayFrequency(uint freq);

            uint getUpdateDisplayFrequency() const;

            void setOverlayDimensions(Real width, Real height);

            void setOverlayPosition(Real left, Real top);

            Real getOverlayWidth() const;
            Real getOverlayHeight() const;
            Real getOverlayLeft() const;
            Real getOverlayTop() const;

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

        protected:

            void initialize();

            void displayResults();

            void processFrameStats();

            void changeEnableState();

            OverlayContainer* createContainer();

            OverlayElement* createTextArea(const String& name, Real width, Real height, Real top, Real left, 
                                       uint fontSize, const String& caption, bool show = true);

            OverlayElement* createPanel(const String& name, Real width, Real height, Real top, Real left, 
                                    const String& materialName, bool show = true);

            struct ProfileInstance {

                String      name;

                String      parent;

                ulong       currTime;

                ulong       accum;

                uint        hierarchicalLvl;
            };

            struct ProfileFrame {
                
                String  name;

                ulong   frameTime;

                uint    calls;

                uint    hierarchicalLvl;

            };
            
            struct ProfileHistory {

                String  name;

                Real    currentTimePercent; 
                Real    currentTimeMillisecs;

                Real    maxTimePercent; 
                Real    maxTimeMillisecs; 

                Real    minTimePercent; 
                Real    minTimeMillisecs; 

                uint    numCallsThisFrame;

                Real    totalTimePercent;
                Real    totalTimeMillisecs;

                ulong   totalCalls; 

                uint    hierarchicalLvl;

            };

            
            typedef list<ProfileInstance>::type ProfileStack;
            typedef list<ProfileFrame>::type ProfileFrameList;
            typedef list<ProfileHistory>::type ProfileHistoryList;
            typedef map<String, ProfileHistoryList::iterator>::type ProfileHistoryMap;
            typedef map<String, bool>::type DisabledProfileMap;

            typedef list<OverlayElement*>::type ProfileBarList;

            ProfileStack mProfiles;

            ProfileFrameList mProfileFrame;

            ProfileHistoryList mProfileHistory;

            ProfileHistoryMap mProfileHistoryMap;

            DisabledProfileMap mDisabledProfiles;

            ProfileBarList mProfileBars;

            bool mInitialized;

            uint mMaxDisplayProfiles;

            Overlay* mOverlay;

            OverlayContainer* mProfileGui;

            Real mBarHeight;

            Real mGuiHeight;

            Real mGuiWidth;

            Real mGuiLeft;

            Real mGuiTop;

            Real mBarIndent;

            Real mGuiBorderWidth;

            Real mBarLineWidth;

            Real mBarSpacing;

            uint mUpdateDisplayFrequency;

            uint mCurrentFrame;

            Timer* mTimer;

            ulong mTotalFrameTime;

            bool mEnabled;

            bool mEnableStateChangePending;

            bool mNewEnableState;

            uint32 mProfileMask;

            DisplayMode mDisplayMode;

            ulong mMaxTotalFrameTime;

            Real mAverageFrameTime;
            bool mResetExtents;


    }; // end class
} // end namespace

#endif