aboutsummaryrefslogtreecommitdiff
path: root/graphics/screen.h
blob: 3479ce847e9e308077a1cc7f2bf34fe68275dfb2 (plain)
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
/* 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 GRAPHICS_SCREEN_H
#define GRAPHICS_SCREEN_H

#include "graphics/managed_surface.h"
#include "graphics/pixelformat.h"
#include "common/list.h"
#include "common/rect.h"

namespace Graphics {

#define PALETTE_COUNT 256
#define PALETTE_SIZE (256 * 3)

class Screen : virtual public ManagedSurface {
private:
	/**
	 * List of affected areas of the screen
	 */
	Common::List<Common::Rect> _dirtyRects;
private:
	/**
	* 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);
protected:
	/**
	 * Adds a rectangle to the list of modified areas of the screen during the
	 * current frame
	 */
	virtual void addDirtyRect(const Common::Rect &r);
public:
	Screen();
	Screen(int width, int height);
	Screen(int width, int height, PixelFormat pixelFormat);

	/**
	 * Returns true if there are any pending screen updates
	 */
	bool isDirty() const { return _dirtyRects.empty(); }

	/**
	 * Makes the whole screen dirty
	 */
	void makeAllDirty();

	/**
	 * Clear the current dirty rects list
	 */
	virtual void clearDirtyRects() { _dirtyRects.clear(); }

	/**
	 * Updates the screen by copying any affected areas to the system
	 */
	virtual void update();

	/**
	 * 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);

	/**
	 * 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);

	/**
	 * Clears the current palette, setting all entries to black
	 */
	void clearPalette();
};

} // End of namespace Graphics

#endif