#include <EventPump.h>
Inheritance diagram for GG::EventPumpBase:
Protected Member Functions | |
| void | LoopBody (GUI *gui, EventPumpState &state, bool do_non_rendering, bool do_rendering) |
Static Protected Member Functions | |
| static EventPumpState & | State () |
The action taken by EventPumpBase is a part of the basic GG::GUI functionality; users who wish to define a new type of event pump should do so by inheriting from EventPump instead of this class.
Definition at line 53 of file EventPump.h.
| void GG::EventPumpBase::LoopBody | ( | GUI * | gui, | |
| EventPumpState & | state, | |||
| bool | do_non_rendering, | |||
| bool | do_rendering | |||
| ) | [protected] |
executes everything but the system event handling portion of the event handling and rendering cycle.
If do_non_rendering is true, all the non-rendering code in LoopBody() will be executed; if do_rendering is true, all rendering code in LoopBody() will be executed as well. Set one or both of these to false to remove them from the execution of LoopBody(). This is provided mainly so users don't have to manually turn off and then turn back on FPS limits, etc., if they don't want them to take place in their custom event pump. Also, this provides a convenient way to turn rendering off completely in a custom event pump, if that is desired.
| static EventPumpState& GG::EventPumpBase::State | ( | ) | [static, protected] |
returns the EventPumpState object shared by all event pump types.
1.5.2