supertux
Public Types | Public Member Functions | List of all members
ScreenFade Class Referenceabstract

Screen to be displayed simultaneously with another Screen. More...

#include <screen_fade.hpp>

Inheritance diagram for ScreenFade:
Inheritance graph
[legend]

Public Types

enum  FadeType { NONE, FADE, CIRCLE }
 

Public Member Functions

virtual bool done () const =0
 returns true if the effect is completed
 
virtual void draw (DrawingContext &context)=0
 gets called once per frame. More...
 
virtual void update (float dt_sec)=0
 gets called for once (per logical) frame. More...
 

Detailed Description

Screen to be displayed simultaneously with another Screen.

This is used for Screen transition effects like a fade-out or a shrink-fade

Member Function Documentation

◆ draw()

virtual void ScreenFade::draw ( DrawingContext context)
pure virtual

gets called once per frame.

The ScreenFade should draw itself in this function. State changes should not be done in this function, but rather in update

Implemented in FadeToBlack, and ShrinkFade.

◆ update()

virtual void ScreenFade::update ( float  dt_sec)
pure virtual

gets called for once (per logical) frame.

ScreenFades should do their state updates and logic here

Implemented in FadeToBlack, and ShrinkFade.


The documentation for this class was generated from the following file: