tile-manager.h 3.76 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
/* The GIMP -- an image manipulation program
 * Copyright (C) 1995 Spencer Kimball and Peter Mattis
 *
 * 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
16
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17
 */
Elliot Lee's avatar
Elliot Lee committed
18
19
20
21
22
23
24
25
26
27
#ifndef __TILE_MANAGER_H__
#define __TILE_MANAGER_H__


#include "tile.h"


typedef struct _TileManager  TileManager;

typedef void (*TileValidateProc) (TileManager *tm,
28
				  Tile        *tile);
Elliot Lee's avatar
Elliot Lee committed
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


/* Creates a new tile manager with the specified
 *  width for the toplevel. The toplevel sizes is
 *  used to compute the number of levels and there
 *  size. Each level is 1/2 the width and height of
 *  the level above it.
 * The toplevel is level 0. The smallest level in the
 *  hierarchy is "nlevels - 1". That level will be smaller
 *  than TILE_WIDTH x TILE_HEIGHT
 */
TileManager* tile_manager_new (int toplevel_width,
			       int toplevel_height,
			       int bpp);

/* Destroy a tile manager and all the tiles it contains.
 */
void tile_manager_destroy (TileManager *tm);

/* Set the validate procedure for the tile manager.
 *  The validate procedure is called when an invalid tile
 *  is referenced. If the procedure is NULL, then the tile
 *  is set to valid and its memory is allocated, but
 *  not initialized.
 */
void tile_manager_set_validate_proc (TileManager      *tm,
				     TileValidateProc  proc);

57
/* Get a specified tile from a tile manager. 
Elliot Lee's avatar
Elliot Lee committed
58
59
60
61
 */
Tile* tile_manager_get_tile (TileManager *tm,
			     int          xpixel,
			     int          ypixel,
62
63
			     int          wantread,
			     int          wantwrite);
Elliot Lee's avatar
Elliot Lee committed
64
65
66
67
68

/* Get a specified tile from a tile manager.
 */
Tile* tile_manager_get (TileManager *tm,
			int          tile_num,
69
70
71
			int          wantread,
			int          wantwrite);

72
/* Request that (if possible) the tile at x,y be swapped
73
74
75
76
77
78
 * in.  This is only a hint to improve performance; no guarantees.
 * The tile may be swapped in or otherwise made more accessible
 * if it is convenient...
 */
void tile_manager_get_async (TileManager *tm,
			     int          xpixel,
79
			     int          ypixel);
80

81
82
83
84
85
86
87
88
void tile_manager_map_tile (TileManager *tm,
			    int          xpixel,
			    int          ypixel,
			    Tile        *srctile);

void tile_manager_map (TileManager *tm,
		       int          time_num,
		       Tile        *srctile);
Elliot Lee's avatar
Elliot Lee committed
89
90
91
92
93
94

/* Validate a tiles memory.
 */
void tile_manager_validate (TileManager *tm,
			    Tile        *tile);

scott's avatar
scott committed
95
96
void tile_invalidate (Tile **tile_ptr, TileManager *tm, int tile_num);
void tile_invalidate_tile (Tile **tile_ptr, TileManager *tm, 
97
			   int xpixel, int ypixel);
scott's avatar
scott committed
98

Elliot Lee's avatar
Elliot Lee committed
99
/* Given a toplevel tile, this procedure will invalidate
100
 *  (set the dirty bit) for this toplevel tile.
Elliot Lee's avatar
Elliot Lee committed
101
102
103
104
 */
void tile_manager_invalidate_tiles (TileManager *tm,
				    Tile        *toplevel_tile);

105
106
107
108
109
void tile_manager_set_user_data (TileManager *tm,
				 void        *user_data);

void *tile_manager_get_user_data (TileManager *tm);

110
111
112
int tile_manager_level_width  (TileManager *tm);
int tile_manager_level_height (TileManager *tm);
int tile_manager_level_bpp    (TileManager *tm);
113
114
115

void tile_manager_get_tile_coordinates (TileManager *tm, Tile *tile,
					int *x, int *y);
Elliot Lee's avatar
Elliot Lee committed
116

117
118
119
void tile_manager_map_over_tile (TileManager *tm, Tile *tile, Tile *srctile);


Elliot Lee's avatar
Elliot Lee committed
120
#endif /* __TILE_MANAGER_H__ */