Common::OSDMessageQueue Class Reference

#include <osd_message_queue.h>

Inheritance diagram for Common::OSDMessageQueue:

Public Types
enum	{ kMinimumDelay = 1000 }

Public Member Functions
void	registerEventSource ()
void	addMessage (const Common::U32String &msg)
bool	pollEvent (Common::Event &event) override
Public Member Functions inherited from Common::EventSource
virtual bool	allowMapping () const

Additional Inherited Members
Static Public Member Functions inherited from Common::Singleton< OSDMessageQueue >
static bool	hasInstance ()
static OSDMessageQueue &	instance ()
static void	destroy ()
Protected Types inherited from Common::Singleton< OSDMessageQueue >
typedef OSDMessageQueue	SingletonBaseType
Static Protected Attributes inherited from Common::Singleton< OSDMessageQueue >
static OSDMessageQueue *	_singleton

Detailed Description

Queue OSD messages from any thread to be displayed by the graphic thread.

Member Function Documentation

addMessage()

void Common::OSDMessageQueue::addMessage

(

const Common::U32String &

msg

)

Add a message to the OSD message queue.

pollEvent()

bool Common::OSDMessageQueue::pollEvent ( Common::Event &  event )

overridevirtual

Common::EventSource interface

The OSDMessageQueue registers itself as an event source even if it does not actually produce events as a mean to be polled periodically by the GUI or engine code.

The periodical polling is used to update the OSD messages.

Implements Common::EventSource.

---

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

• common/osd_message_queue.h