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_FADETOBLACK_HPP
18#define HEADER_SUPERTUX_SUPERTUX_FADETOBLACK_HPP
19
20#include "supertux/screen_fade.hpp"
21#include "video/color.hpp"
22
23/**
24 * Fades a screen towards a specific color
25 */
26class FadeToBlack final : public ScreenFade
27{
28public:
29 enum Direction { FADEOUT, FADEIN };
30
31public:
32 FadeToBlack(Direction direction, float fade_time, Color dest_color = Color(0, 0, 0));
33
34 virtual void update(float dt_sec) override;
35 virtual void draw(DrawingContext& context) override;
36
37 /// returns true if the effect is completed
38 virtual bool done() const override;
39
40private:
41 Direction m_direction;
42 float m_fade_time;
43 Color m_color;
44 float m_accum_time;
45
46private:
47 FadeToBlack(const FadeToBlack&) = delete;
48 FadeToBlack& operator=(const FadeToBlack&) = delete;
49};
50
51#endif
52
53/* EOF */
54