ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

BaseBackend Class Reference

#include <base-backend.h>

Inheritance diagram for BaseBackend:
Collaboration diagram for BaseBackend:

List of all members.

Public Member Functions

virtual void initBackend ()
 The following method is called once, from main.cpp, after all config data (including command line params etc.
virtual void displayMessageOnOSD (const char *msg)
 !!! Not used in ResidualVM !!!
virtual void displayActivityIconOnOSD (const Graphics::Surface *icon)
 Display an icon indicating background activity.
virtual void fillScreen (uint32 col)
 Fills the screen with a given color value.

Protected Member Functions

virtual Common::EventSourcegetDefaultEventSource ()=0

Detailed Description

Definition at line 29 of file base-backend.h.


Member Function Documentation

virtual void BaseBackend::displayActivityIconOnOSD ( const Graphics::Surface icon  )  [inline, virtual]

Display an icon indicating background activity.

The icon is displayed in an 'on screen display'. It is visible above the regular screen content or near it.

The caller keeps ownership of the icon. It is acceptable to free the surface just after the call.

There is no preferred pixel format for the icon. The backend should convert its copy of the icon to an appropriate format.

The caller must call this method again with a null pointer as a parameter to indicate the icon should no longer be displayed.

Parameters:
icon the icon to display on screen

Implements OSystem.

Reimplemented in ModularBackend.

Definition at line 36 of file base-backend.h.

void BaseBackend::displayMessageOnOSD ( const char *  msg  )  [virtual]

!!! Not used in ResidualVM !!!

Display a message in an 'on screen display'. That is, display it in a fashion where it is visible on or near the screen (e.g. in a transparent rectangle over the regular screen content; or in a message box beneath it; etc.).

The message is expected to be provided in the current TranslationManager charset.

Note:
There is a default implementation in BaseBackend which uses a TimedMessageDialog to display the message. Hence implementing this is optional.
Parameters:
msg the message to display on screen

Implements OSystem.

Reimplemented in ModularBackend.

Definition at line 36 of file base-backend.cpp.

void BaseBackend::fillScreen ( uint32  col  )  [virtual]

Fills the screen with a given color value.

!!! Not used in ResidualVM !!!

Note:
We are using uint32 here even though currently we only support 8bpp indexed mode. Thus the value should be always inside [0, 255] for now.

Implements OSystem.

Reimplemented in ModularBackend.

Definition at line 58 of file base-backend.cpp.

virtual Common::EventSource* BaseBackend::getDefaultEventSource (  )  [protected, pure virtual]

Implemented in OSystem_SDL.

void BaseBackend::initBackend (  )  [virtual]

The following method is called once, from main.cpp, after all config data (including command line params etc.

) are fully loaded.

Note:
Subclasses should always invoke the implementation of their parent class. They should do so near the end of their own implementation.

Reimplemented from OSystem.

Reimplemented in OSystem_MacOSX, OSystem_POSIX, OSystem_PS3, OSystem_RISCOS, OSystem_SDL, and OSystem_Win32.

Definition at line 42 of file base-backend.cpp.


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


Generated on Sat Mar 23 2019 05:05:46 for ResidualVM by doxygen 1.7.1
curved edge   curved edge