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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
|
/* 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.
*
* $URL$
* $Id$
*
*/
#ifndef SCI_GFX_GFX_RESMGR_H
#define SCI_GFX_GFX_RESMGR_H
// FIXME/TODO: The name "(Graphics) resource manager", and the associated
// filenames, are misleading. This should be renamed to "Graphics manager"
// or something like that.
#include "sci/gfx/gfx_resource.h"
#include "sci/scicore/resource.h"
#include "common/hashmap.h"
namespace Sci {
struct gfx_bitmap_font_t;
class ResourceManager;
enum gfx_resource_type_t {
GFX_RESOURCE_TYPE_VIEW = 0,
GFX_RESOURCE_TYPE_PIC,
GFX_RESOURCE_TYPE_FONT,
GFX_RESOURCE_TYPE_CURSOR,
GFX_RESOURCE_TYPE_PALETTE,
/* FIXME: Add PAL resource */
GFX_RESOURCE_TYPES_NR /* Number of resource types that are to be supported */
};
#define GFX_RESOURCE_TYPE_0 GFX_RESOURCE_TYPE_VIEW
#define GFXR_RES_ID(type, index) ((type) << 16 | (index))
#define GFXR_RES_TYPE(id) (id >> 16)
#define GFXR_RES_NR(id) (id & 0xffff)
struct gfx_resource_t {
int ID; /* Resource ID */
int lock_sequence_nr; /* See description of lock_counter in gfx_resstate_t */
int mode; /* A mode type hash */
union {
gfx_pixmap_t *pointer;
gfxr_view_t *view;
gfx_bitmap_font_t *font;
gfxr_pic_t *pic;
} scaled_data;
union {
gfx_pixmap_t *pointer;
gfxr_view_t *view;
gfx_bitmap_font_t *font;
gfxr_pic_t *pic;
} unscaled_data;
};
struct gfx_options_t;
typedef Common::HashMap<int, gfx_resource_t *> IntResMap;
struct gfx_resstate_t {
int version; /* Interpreter version */
gfx_options_t *options;
gfx_driver_t *driver;
Palette *static_palette;
int lock_counter; /* Global lock counter; increased for each new resource allocated.
** The newly allocated resource will then be assigned the new value
** of the lock_counter, as will any resources referenced afterwards.
*/
int tag_lock_counter; /* lock counter value at tag time */
IntResMap _resourceMaps[GFX_RESOURCE_TYPES_NR];
ResourceManager *resManager;
};
gfx_resstate_t *gfxr_new_resource_manager(int version, gfx_options_t *options,
gfx_driver_t *driver, ResourceManager *resManager);
/* Allocates and initializes a new resource manager
** Parameters: (int) version: Interpreter version
** (gfx_options_t *): Pointer to all relevant drawing options
** (gfx_driver_t *): The graphics driver (needed for capability flags and the mode
** structure)
** (void *) misc_payload: Additional information for the interpreter's
** resource loaders
** Returns : (gfx_resstate_t *): A newly allocated resource manager
** The options are considered to be read-only, as they belong to the overlying state object.
*/
void gfxr_free_resource_manager(gfx_resstate_t *state);
/* Frees a previously allocated resource manager, and all allocated resources.
** Parameters: (gfx_resstate_t *) state: The state manager to free
** Return : (void)
*/
void gfxr_free_all_resources(gfx_resstate_t *state);
/* Frees all resources currently allocated
** Parameter: (gfx_resstate_t *) state: The state to do this on
** Returns : (void)
** This function is intended to be used primarily for debugging.
*/
void gfxr_free_tagged_resources(gfx_resstate_t *state);
/* Frees all tagged resources.
** Parameters: (gfx_resstate_t *) state: The state to alter
** Returns : (void)
** Resources are tagged by calling gfx_tag_resources(), and untagged by calling the
** approprate dereferenciation function.
** Note that this function currently only affects view resources, as pic resources are
** treated differently, while font and cursor resources are relatively rare.
*/
class GfxResManager {
public:
GfxResManager(gfx_resstate_t *state) : _state(state) {}
~GfxResManager() {}
/* 'Tags' all resources for deletion
** Paramters: (void)
** Returns : (void)
** Tagged resources are untagged if they are referenced.
*/
void tagResources() { (_state->tag_lock_counter)++; }
/* Retreives an SCI0/SCI01 mouse cursor
** Parameters: (int) num: The cursor number
** Returns : (gfx_font_t *) The approprate cursor as a pixmap, or NULL on error
*/
gfx_pixmap_t *getCursor(int num);
/* Retreives the static palette from the interpreter-specific code
** Parameters: (int *) colors_nr: Number of colors to use
** (int) nr: The palette to read
** Returns : (gfx_pixmap_color_t *) *colors_nr static color entries
** if a static palette must be used, NULL otherwise
*/
Palette *getPalette(int *colors_nr, int num = 999);
/* Retreives a font
** Parameters: (int) nr: The font number
** (int) scaled: Whether the font should be font-scaled
** Returns : (gfx_font_t *) The appropriate font, or NULL on error
*/
gfx_bitmap_font_t *getFont(int num, bool scaled = false);
/* Retreives a displayable (translated) pic resource
** Parameters: (int) nr: Number of the pic resource
** (int) maps: The maps to translate (ORred GFX_MASK_*)
** (int) flags: Interpreter-dependant pic flags
** (int) default_palette: The default palette to use for drawing (if applicable)
** (bool) scaled: Whether to return the scaled maps, or the unscaled
** ones (which may be identical) for some special operations.
** Returns : (gfx_pic_t *) The appropriate pic resource with all maps as index (but not
** neccessarily translated) data.
*/
gfxr_pic_t *getPic(int num, int maps, int flags, int default_palette, bool scaled = false);
/* Determines whether support for pointers with more than two colors is required
** Returns : (bool) false if no support for multi-colored pointers is required, true
** otherwise
*/
bool multicoloredPointers() { return _state->version > SCI_VERSION_1; }
private:
gfx_resstate_t *_state;
};
gfxr_pic_t *gfxr_add_to_pic(gfx_resstate_t *state, int old_nr, int new_nr, int maps, int flags,
int old_default_palette, int default_palette, int scaled);
/* Retreives a displayable (translated) pic resource written ontop of an existing pic
** Parameters: (gfx_resstate_t *) state: The resource state
** (int) old_nr: Number of the pic resource to write on
** (int) new_nr: Number of the pic resource that is to be added
** (int) maps: The maps to translate (ORred GFX_MASK_*)
** (int) flags: Interpreter-dependant pic flags
** (int) default_palette: The default palette to use for drawing (if applicable)
** (int) scaled: Whether to return the scaled maps, or the unscaled
** ones (which may be identical) for some special operations.
** Returns : (gfx_pic_t *) The appropriate pic resource with all maps as index (but not
** neccessarily translated) data.
** This function invalidates the cached pic pointed to by old_nr in the cache. While subsequent
** gfxr_add_to_pic() writes will still modify the 'invalidated' pic, gfxr_get_pic() operations will
** cause it to be removed from the cache and to be replaced by a clean version.
*/
gfxr_view_t *gfxr_get_view(gfx_resstate_t *state, int nr, int *loop, int *cel, int palette);
/* Retreives a translated view cel
** Parameters: (gfx_resstate_t *) state: The resource state
** (int) nr: The view number
** (int *) loop: Pointer to a variable containing the loop number
** (int *) cel: Pointer to a variable containing the cel number
** (int) palette: The palette to use
** Returns : (gfx_view_t *) The relevant view, or NULL if nr was invalid
** loop and cel are given as pointers in order to allow the underlying variables to be
** modified if they are invalid (this is relevant for SCI version 0, where invalid
** loop and cel numbers have to be interpreted as 'maximum' or 'minimum' by the interpreter)
*/
/* =========================== */
/* Interpreter-dependant stuff */
/* =========================== */
int gfxr_interpreter_options_hash(gfx_resource_type_t type, int version,
gfx_options_t *options, int palette);
/* Calculates a unique hash value for the specified options/type setup
** Parameters: (gfx_resource_type_t) type: The type the hash is to be generated for
** (int) version: The interpreter type and version
** (gfx_options_t *) options: The options to hashify
** (int) palette: The palette to use (FIXME: should this be here?)
** Returns : (int) A hash over the values of the options entries, covering entries iff
** they are relevant for the specified type
** Covering more entries than relevant may slow down the system when options are changed,
** while covering less may result in invalid cached data being used.
** Only positive values may be returned, as negative values are used internally by the generic
** resource manager code.
** Also, only the lower 20 bits are available to the interpreter.
** (Yes, this isn't really a "hash" in the traditional sense...)
*/
int gfxr_interpreter_calculate_pic(gfx_resstate_t *state, gfxr_pic_t *scaled_pic, gfxr_pic_t *unscaled_pic,
int flags, int default_palette, int nr);
/* Instructs the interpreter-specific code to calculate a picture
** Parameters: (gfx_resstate_t *) state: The resource state, containing options and version information
** (gfxr_pic_t *) scaled_pic: The pic structure that is to be written to
** (gfxr_pic_t *) unscaled_pic: The pic structure the unscaled pic is to be written to,
** or NULL if it isn't needed.
** (int) flags: Pic drawing flags (interpreter dependant)
** (int) default_palette: The default palette to use for pic drawing (interpreter dependant)
** (int) nr: pic resource number
** Returns : (int) GFX_ERROR if the resource could not be found, GFX_OK otherwise
*/
gfxr_view_t *gfxr_interpreter_get_view(ResourceManager& resourceManager, int nr, int palette, Palette* staticPalette, int version);
/* Instructs the interpreter-specific code to calculate a view
** Parameters: (ResourceManager& ) resourceManager: The resource manager
** (int) nr: The view resource number
** (int) palette: The palette number to use
** (Palette*) staticPalette: The static palette to use in VGA games
** (int) version: The interpreter version
** Returns : (gfx_view_t *) The appropriate view, or NULL on error
*/
} // End of namespace Sci
#endif // SCI_GFX_GFX_RSMGR_H
|
