poopmup/timer.h

   1 /**
   2  * @file poopmup/timer.h
   3  * The public interface file for the timer class.
   4  *
   5  * Copyright Stephen M. Webb  <bregma@poopmup.org>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20  */
  21 #ifndef POOPMUP_TIMER_H_
  22 #define POOPMUP_TIMER_H_
  23
  24 #include <SDL/SDL.h>
  25
  26
  27 namespace Poopmup
  28 {
  29         /**
  30          * Provides a programmable timer.
  31          */
  32         class Timer
  33         {
  34         public:
  35                 typedef SDL_TimerID TimerId;
  36
  37         public:
  38                 Timer(Uint32 msecs);
  39                 ~Timer();
  40
  41                 TimerId timerId() const;
  42
  43         private:
  44                 TimerId  m_timerId;
  45         };
  46 } // namespace Poopmup
  47
  48 #endif // POOPMUP_TIMER_H_
  49