source: OGRE/trunk/ogrenew/OgreMain/include/OgreTimer.h @ 692

/*
-----------------------------------------------------------------------------
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 __Timer_H__
#define __Timer_H__

#include "OgrePrerequisites.h"

namespace Ogre
{
    /** Platform-independent Timer class. 
    @remarks
        You should never create a Timer instance manually; instead, use PlatformManager::createTimer.
    */
    class _OgreExport Timer 
        {
        protected:      
                clock_t zeroClock ;
        
        public:
                /** Creates a timer. 
        @remarks
            You must call reset() after creating it; the constructor cannot do it because the 
            call would not be polymorphic.
                */
                Timer() ;
        virtual ~Timer() { }
                
                /** Resets timer 
                */
                virtual void reset();
                
                /** Returns milliseconds since initialisation or last reset
                */
                virtual unsigned long getMilliseconds() ;
                
                /** Returns milliseconds since initialisation or last reset, only CPU time measured
                */      
                virtual unsigned long getMillisecondsCPU();
                
                /** Returns microseconds since initialisation or last reset
                */
                virtual unsigned long getMicroseconds() ;
                
                /** Returns microseconds since initialisation or last reset, only CPU time measured
                */      
                virtual unsigned long getMicrosecondsCPU();
        } ;
}
#endif