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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
/* 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 GRAPHICS_SCREEN_H
#define GRAPHICS_SCREEN_H
#include "graphics/managed_surface.h"
#include "graphics/palette.h"
#include "graphics/pixelformat.h"
#include "common/list.h"
#include "common/rect.h"
namespace Graphics {
/**
* @defgroup graphics_screen Screen
* @ingroup graphics
*
* @brief Screen class for managing the screen.
*
* @{
*/
/**
* Implements a specialised surface that represents the screen.
* It keeps track of any areas of itself that are updated by drawing
* calls, and provides an update that method that blits the affected
* areas to the physical screen
*/
class Screen : public ManagedSurface {
protected:
/**
* List of affected areas of the screen
*/
Common::List<Common::Rect> _dirtyRects;
protected:
/**
* Merges together overlapping dirty areas of the screen
*/
void mergeDirtyRects();
/**
* Returns the union of two dirty area rectangles
*/
bool unionRectangle(Common::Rect &destRect, const Common::Rect &src1, const Common::Rect &src2);
public:
Screen();
Screen(int width, int height);
Screen(int width, int height, PixelFormat pixelFormat);
/**
* Returns true if there are any pending screen updates (dirty areas)
*/
bool isDirty() const { return !_dirtyRects.empty(); }
/**
* Marks the whole screen as dirty. This forces the next call to update
* to copy the entire screen contents
*/
void makeAllDirty();
/**
* Clear the current dirty rects list
*/
virtual void clearDirtyRects() { _dirtyRects.clear(); }
/**
* Adds a rectangle to the list of modified areas of the screen during the
* current frame
*/
virtual void addDirtyRect(const Common::Rect &r);
/**
* Updates the screen by copying any affected areas to the system
*/
virtual void update();
/**
* Updates the screen at the end of an update call
*/
virtual void updateScreen();
/**
* Return the currently active palette
*/
void getPalette(byte palette[PALETTE_SIZE]);
/**
* Return a portion of the currently active palette
*/
void getPalette(byte *palette, uint start, uint num);
/**
* Return a portion of the currently active palette as a palette object
*/
Graphics::Palette getPalette(uint start = 0, uint num = PALETTE_COUNT) {
byte tmp[PALETTE_SIZE];
getPalette(tmp, start, num);
return Graphics::Palette(tmp, num);
}
/**
* Set the palette
*/
void setPalette(const byte palette[PALETTE_SIZE]);
/**
* Set a subsection of the palette
*/
void setPalette(const byte *palette, uint start, uint num);
/**
* Set a palette based on a passed palette object
*/
void setPalette(const Graphics::Palette &pal, uint start = 0) {
setPalette(pal.data(), start, pal.size());
}
/**
* Clears the current palette, setting all entries to black
*/
void clearPalette();
};
/** @} */
} // End of namespace Graphics
#endif
|
