src/scripting/display_effect.hpp

   1 #ifndef __SCRIPTING_DISPLAY_EFFECT_H__
   2 #define __SCRIPTING_DISPLAY_EFFECT_H__
   3
   4 namespace Scripting
   5 {
   6
   7 class DisplayEffect
   8 {
   9 public:
  10 #ifndef SCRIPTING_API
  11     virtual ~DisplayEffect()
  12     {}
  13 #endif
  14
  15     /// fade display to black
  16     virtual void fade_out(float fadetime) = 0;
  17     /// fade display from black to normal
  18     virtual void fade_in(float fadetime) = 0;
  19     /// set display black (or back to normal)
  20     virtual void set_black(bool enabled) = 0;
  21     /// check if display is set to black
  22     virtual bool is_black() = 0;
  23     /// set black borders for cutscenes
  24     virtual void sixteen_to_nine(float fadetime) = 0;
  25     /// deactivate borders
  26     virtual void four_to_three(float fadetime) = 0;
  27
  28     // fade display until just a small visible circle is left
  29     // (like what happens in some cartoons at the end)
  30     // void shrink_fade(Vector goal, float radius, float fadetime);
  31 };
  32
  33 }
  34
  35 #endif
  36