src/supertux/screen_fade.hpp

   1 //  SuperTux
   2 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
   3 //
   4 //  This program is free software: you can redistribute it and/or modify
   5 //  it under the terms of the GNU General Public License as published by
   6 //  the Free Software Foundation, either version 3 of the License, or
   7 //  (at your option) any later version.
   8 //
   9 //  This program is distributed in the hope that it will be useful,
  10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 //  GNU General Public License for more details.
  13 //
  14 //  You should have received a copy of the GNU General Public License
  15 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 #ifndef HEADER_SUPERTUX_SUPERTUX_SCREEN_FADE_HPP
  18 #define HEADER_SUPERTUX_SUPERTUX_SCREEN_FADE_HPP
  19
  20 class DrawingContext;
  21
  22 /**
  23  * Screen to be displayed simultaneously with another Screen.
  24  *
  25  * This is used for Screen transition effects like a fade-out or a shrink-fade
  26  */
  27 class ScreenFade
  28 {
  29 public:
  30   virtual ~ScreenFade()
  31   {}
  32
  33   /** returns true if the effect is completed */
  34   virtual bool done() = 0;
  35
  36   /** gets called once per frame. The ScreenFade should draw itself in
  37       this function.  State changes should not be done in this
  38       function, but rather in update */
  39   virtual void draw(DrawingContext& context) = 0;
  40
  41   /** gets called for once (per logical) frame. ScreenFades should do
  42       their state updates and logic here */
  43   virtual void update(float elapsed_time) = 0;
  44 };
  45
  46 #endif
  47
  48 /* EOF */