GG: GG::EventPumpBase Class Reference

GG

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Protected Member Functions | Static Protected Member Functions | List of all members
GG::EventPumpBase Class Reference

`#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 ()

## Detailed Description

The base type for all EventPump types.

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 58 of file EventPump.h.

## Member Function Documentation

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 | ( |  | ) |
| staticprotected

Returns the EventPumpState object shared by all event pump types.

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

- EventPump.h