scripting::DisplayEffect Class Reference

#include <display_effect.hpp>

Inherited by DisplayEffect.

List of all members.

Public Member Functions

virtual ~DisplayEffect ()
virtual void fade_out (float fadetime)=0
 fade display to black
virtual void fade_in (float fadetime)=0
 fade display from black to normal
virtual void set_black (bool enabled)=0
 set display black (or back to normal)
virtual bool is_black ()=0
 check if display is set to black
virtual void sixteen_to_nine (float fadetime)=0
 set black borders for cutscenes
virtual void four_to_three (float fadetime)=0
 deactivate borders


Detailed Description

Definition at line 22 of file display_effect.hpp.


Constructor & Destructor Documentation

virtual scripting::DisplayEffect::~DisplayEffect (  )  [inline, virtual]

Reimplemented in DisplayEffect.

Definition at line 26 of file display_effect.hpp.

00027   {}


Member Function Documentation

virtual void scripting::DisplayEffect::fade_out ( float  fadetime  )  [pure virtual]

fade display to black

Implemented in DisplayEffect.

Referenced by scripting::wrapper::DisplayEffect_fade_out_wrapper().

virtual void scripting::DisplayEffect::fade_in ( float  fadetime  )  [pure virtual]

fade display from black to normal

Implemented in DisplayEffect.

Referenced by scripting::wrapper::DisplayEffect_fade_in_wrapper().

virtual void scripting::DisplayEffect::set_black ( bool  enabled  )  [pure virtual]

set display black (or back to normal)

Implemented in DisplayEffect.

Referenced by scripting::wrapper::DisplayEffect_set_black_wrapper().

virtual bool scripting::DisplayEffect::is_black (  )  [pure virtual]

check if display is set to black

Implemented in DisplayEffect.

Referenced by scripting::wrapper::DisplayEffect_is_black_wrapper().

virtual void scripting::DisplayEffect::sixteen_to_nine ( float  fadetime  )  [pure virtual]

set black borders for cutscenes

Implemented in DisplayEffect.

Referenced by scripting::wrapper::DisplayEffect_sixteen_to_nine_wrapper().

virtual void scripting::DisplayEffect::four_to_three ( float  fadetime  )  [pure virtual]

deactivate borders

Implemented in DisplayEffect.

Referenced by scripting::wrapper::DisplayEffect_four_to_three_wrapper().


The documentation for this class was generated from the following file:
Generated on Mon Apr 21 03:38:34 2014 for SuperTux by  doxygen 1.5.1