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
|
/* 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_CURSOR_H
#define GRAPHICS_CURSOR_H
#include "common/scummsys.h"
namespace Graphics {
/**
* @defgroup graphics_cursor Cursor
* @ingroup graphics
*
* @brief Cursor class used for representing the mouse cursor on the screen.
*
* @{
*/
/**
* A simple cursor representation
* TODO: Switch to using Graphics::Surface instead of a byte*
*/
class Cursor {
public:
Cursor() {}
virtual ~Cursor() {}
/** Return the cursor's width. */
virtual uint16 getWidth() const = 0;
/** Return the cursor's height. */
virtual uint16 getHeight() const = 0;
/** Return the cursor's hotspot's x coordinate. */
virtual uint16 getHotspotX() const = 0;
/** Return the cursor's hotspot's y coordinate. */
virtual uint16 getHotspotY() const = 0;
/** Return the cursor's transparent key. */
virtual byte getKeyColor() const = 0;
/** Return the cursor's surface. */
virtual const byte *getSurface() const = 0;
/** Return the cursor's mask, if it has one. */
virtual const byte *getMask() const { return nullptr; }
/** Return the cursor's palette in RGB format. */
virtual const byte *getPalette() const = 0;
/** Return the starting index of the palette. */
virtual byte getPaletteStartIndex() const = 0;
/** Return the number of colors in the palette. */
virtual uint16 getPaletteCount() const = 0;
};
/** @} */
} // End of namespace Graphics
#endif
|
