ScummVM API documentation
mouseimg.h
1/* ScummVM - Graphic Adventure Engine
2 *
3 * ScummVM is the legal property of its developers, whose names
4 * are too numerous to list here. Please refer to the COPYRIGHT
5 * file distributed with this source distribution.
6 *
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 *
20 *
21 * Based on the original sources
22 * Faery Tale II -- The Halls of the Dead
23 * (c) 1993-1996 The Wyrmkeep Entertainment Co.
24 */
25
26#ifndef SAGA2_MOUSEIMG_H
27#define SAGA2_MOUSEIMG_H
28
29namespace Saga2 {
30
31enum {
32 kMouseCloseBx1Image = 0,
33 kMouseCloseBx2Image,
34 kMouseUsePtrImage,
35 kMouseXPointerImage,
36 kMouseArrowImage,
37 kMouseGrabPtrImage,
38 kMouseAttakPtrImage,
39 kMouseCenterActorIndicatorImage,
40 kMousePgUpImage,
41 kMousePgDownImage,
42 kMousePgLeftImage,
43 kMousePgRightImage,
44 kMouseAutoWalkImage,
45 kMouseGaugeImage,
46 kMouseMax
47};
48
49extern gStaticImage *mouseCursors[kMouseMax];
50
51// Set a new image for the mouse pointer
52void setMouseImage(int id, int16 x, int16 y);
53
54// Set a new image for the mouse pointer
55void setMouseImage(gPixelMap &img, int16 x, int16 y);
56
57// Set new text for the mouse pointer
58void setMouseText(char *text);
59
60// Set the gauge value for the mouse pointer (automatically turns
61// gauge on if necessary ).
62void setMouseGauge(int numerator, int denominator);
63
64// Turn off the gauge on the mouse pointer
65void clearMouseGauge();
66
67void initCursors();
68void freeCursors();
69
70} // end of namespace Saga2
71
72#endif