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

Common::OSDMessageQueue Class Reference

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

#include <osd_message_queue.h>

Inheritance diagram for Common::OSDMessageQueue:
Collaboration diagram for Common::OSDMessageQueue:

List of all members.

Public Types

enum  { kMinimumDelay = 1000 }

Public Member Functions

 OSDMessageQueue ()
 ~OSDMessageQueue ()
void registerEventSource ()
void addMessage (const Common::U32String &msg)
 Add a message to the OSD message queue.
virtual bool pollEvent (Common::Event &event) override
 Common::EventSource interface.

Private Attributes

Mutex _mutex
Queue< U32String_messages
uint32 _lastUpdate

Detailed Description

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

Definition at line 38 of file osd_message_queue.h.

Member Enumeration Documentation

anonymous enum

Definition at line 45 of file osd_message_queue.h.

Constructor & Destructor Documentation

Common::OSDMessageQueue::OSDMessageQueue (  ) 

Definition at line 30 of file osd_message_queue.cpp.

Common::OSDMessageQueue::~OSDMessageQueue (  ) 

Definition at line 33 of file osd_message_queue.cpp.

Member Function Documentation

void Common::OSDMessageQueue::addMessage ( const Common::U32String msg  ) 

Add a message to the OSD message queue.

Definition at line 41 of file osd_message_queue.cpp.

bool Common::OSDMessageQueue::pollEvent ( Common::Event event  )  [override, virtual]

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.

Definition at line 47 of file osd_message_queue.cpp.

void Common::OSDMessageQueue::registerEventSource (  ) 

Definition at line 37 of file osd_message_queue.cpp.

Member Data Documentation

Definition at line 68 of file osd_message_queue.h.

Definition at line 66 of file osd_message_queue.h.

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

Generated on Sat Sep 19 2020 05:04:48 for ResidualVM by doxygen 1.7.1
curved edge   curved edge