src/scripting/display_effect.hpp

Go to the documentation of this file.

//  SuperTux
//  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
//
//  This program is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 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 General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program.  If not, see <http://www.gnu.org/licenses/>.

#ifndef HEADER_SUPERTUX_SCRIPTING_DISPLAY_EFFECT_HPP
#define HEADER_SUPERTUX_SCRIPTING_DISPLAY_EFFECT_HPP

namespace scripting {

class DisplayEffect
{
public:
#ifndef SCRIPTING_API
  virtual ~DisplayEffect()
  {}
#endif

  virtual void fade_out(float fadetime) = 0;
  virtual void fade_in(float fadetime) = 0;
  virtual void set_black(bool enabled) = 0;
  virtual bool is_black() = 0;
  virtual void sixteen_to_nine(float fadetime) = 0;
  virtual void four_to_three(float fadetime) = 0;

  // fade display until just a small visible circle is left
  // (like what happens in some cartoons at the end)
  // void shrink_fade(Vector goal, float radius, float fadetime);
};

}

#endif

/* EOF */

---