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
20class 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 */
27class ScreenFade
28{
29public:
30 virtual ~ScreenFade() {}
31
32 /** returns true if the effect is completed */
33 virtual bool done() const = 0;
34
35 /** gets called once per frame. The ScreenFade should draw itself in
36 this function. State changes should not be done in this
37 function, but rather in update */
38 virtual void draw(DrawingContext& context) = 0;
39
40 /** gets called for once (per logical) frame. ScreenFades should do
41 their state updates and logic here */
42 virtual void update(float dt_sec) = 0;
43};
44
45#endif
46
47/* EOF */
48