-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Expand file tree
/
Copy pathosd_message_queue.h
More file actions
102 lines (85 loc) · 2.65 KB
/
osd_message_queue.h
File metadata and controls
102 lines (85 loc) · 2.65 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
/* 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 3 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, see <http://www.gnu.org/licenses/>.
*
*/
#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/ustr.h"
#include "common/queue.h"
#include "common/mutex.h"
namespace Graphics {
struct Surface;
}
namespace Common {
/**
* @defgroup common_osd_message_queue OSD message queue
* @ingroup common
*
* @brief API for managing the queue of On Screen Display (OSD) messages.
* @{
*/
/**
* 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) */
kIconCleanupDelay = 2 * 1000, /** < Delay after which an OSD icon is removed if it hasn't been shown (in milliseconds) */
};
/**
* Add a message to the OSD message queue.
*/
void addMessage(const Common::U32String &msg);
/**
* Add an image to the OSD message queue.
*/
void addImage(const Graphics::Surface *surface);
/**
* 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.
*/
bool pollEvent(Common::Event &event) override;
private:
struct OSDQueueEntry {
Common::U32String *_text;
Graphics::Surface *_image;
OSDQueueEntry(const Common::U32String &msg);
OSDQueueEntry(const Graphics::Surface *surface);
~OSDQueueEntry();
};
Mutex _mutex;
Queue<OSDQueueEntry *> _messages;
uint32 _lastUpdate;
bool _iconWasShown;
};
/** @} */
} // End of namespace Common
#endif