mirror of
https://github.com/libretro/scummvm.git
synced 2024-12-03 15:41:41 +00:00
3ae52a61af
Registering the OSDMessageQueue instance as an event source is now done right after the event manager is initialised. This ensures that it is created in a sensible place and not for example in another thread). Also registering the event source is moved to a separate function instead of being in the constructor to remove any issue in case some code tries to display a OSD Message very early on (the instance would be created then, but it would be registered as an event source later).
73 lines
2.0 KiB
C++
73 lines
2.0 KiB
C++
/* ScummVM - Graphic Adventure Engine
|
|
*
|
|
* ScummVM is the legal property of its developers, whose names
|
|
* are too numerous to list here. Please refer to the COPYRIGHT
|
|
* file distributed with this source distribution.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
*/
|
|
|
|
#ifndef COMMON_OSD_MESSAGE_QUEUE_H
|
|
#define COMMON_OSD_MESSAGE_QUEUE_H
|
|
|
|
#include "common/events.h"
|
|
#include "common/singleton.h"
|
|
#include "common/str.h"
|
|
#include "common/queue.h"
|
|
#include "common/mutex.h"
|
|
|
|
namespace Common {
|
|
|
|
/**
|
|
* Queue OSD messages from any thread to be displayed by the graphic thread.
|
|
*/
|
|
class OSDMessageQueue : public Singleton<OSDMessageQueue>, public EventSource {
|
|
public:
|
|
OSDMessageQueue();
|
|
~OSDMessageQueue();
|
|
|
|
void registerEventSource();
|
|
|
|
enum {
|
|
kMinimumDelay = 1000 /** < Minimum delay between two OSD messages (in milliseconds) */
|
|
};
|
|
|
|
/**
|
|
* Add a message to the OSD message queue.
|
|
*/
|
|
void addMessage(const char *msg);
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
virtual bool pollEvent(Common::Event &event) override;
|
|
|
|
private:
|
|
Mutex _mutex;
|
|
Queue<String> _messages;
|
|
uint32 _lastUpdate;
|
|
};
|
|
|
|
} // End of namespace Common
|
|
|
|
#endif
|