rnd-20140129-1-src
[rocksndiamonds.git] / src / tools.h
1 /***********************************************************
2 * Rocks'n'Diamonds -- McDuffin Strikes Back!               *
3 *----------------------------------------------------------*
4 * (c) 1995-2006 Artsoft Entertainment                      *
5 *               Holger Schemel                             *
6 *               Detmolder Strasse 189                      *
7 *               33604 Bielefeld                            *
8 *               Germany                                    *
9 *               e-mail: info@artsoft.org                   *
10 *----------------------------------------------------------*
11 * tools.h                                                  *
12 ***********************************************************/
13
14 #ifndef TOOLS_H
15 #define TOOLS_H
16
17 #include "main.h"
18 #include "game.h"
19
20 /* for SetDrawtoField */
21 #define DRAW_BUFFERED           1
22 #define DRAW_BACKBUFFER         2
23
24 /* for DrawElementShifted */
25 #define NO_CUTTING              0
26 #define CUT_ABOVE               (1 << 0)
27 #define CUT_BELOW               (1 << 1)
28 #define CUT_LEFT                (1 << 2)
29 #define CUT_RIGHT               (1 << 3)
30
31 /* for masking functions */
32 #define NO_MASKING              0
33 #define USE_MASKING             1
34  
35 /* for MoveDoor */
36 #define DOOR_OPEN_1             (1 << 0)
37 #define DOOR_OPEN_2             (1 << 1)
38 #define DOOR_CLOSE_1            (1 << 2)
39 #define DOOR_CLOSE_2            (1 << 3)
40 #define DOOR_OPEN_ALL           (DOOR_OPEN_1 | DOOR_OPEN_2)
41 #define DOOR_CLOSE_ALL          (DOOR_CLOSE_1 | DOOR_CLOSE_2)
42 #define DOOR_ACTION_1           (DOOR_OPEN_1 | DOOR_CLOSE_1)
43 #define DOOR_ACTION_2           (DOOR_OPEN_2 | DOOR_CLOSE_2)
44 #define DOOR_ACTION             (DOOR_ACTION_1 | DOOR_ACTION_2)
45 #define DOOR_COPY_BACK          (1 << 4)
46 #define DOOR_NO_COPY_BACK       (1 << 5)
47 #define DOOR_NO_DELAY           (1 << 6)
48 #define DOOR_FORCE_REDRAW       (1 << 7)
49 #define DOOR_GET_STATE          (1 << 8)
50 #define DOOR_SET_STATE          (1 << 9)
51
52 /* for Request */
53 #define REQ_ASK                 (1 << 0)
54 #define REQ_CONFIRM             (1 << 1)
55 #define REQ_PLAYER              (1 << 2)
56 #define REQ_STAY_OPEN           (1 << 3)
57 #define REQ_STAY_CLOSED         (1 << 4)
58 #define REQ_REOPEN              (1 << 5)
59
60 #define REQUEST_WAIT_FOR_INPUT  (REQ_ASK | REQ_CONFIRM | REQ_PLAYER)
61
62
63 void DumpTile(int, int);
64
65 void DrawMaskedBorder_FIELD();
66 void DrawMaskedBorder_DOOR_1();
67 void DrawMaskedBorder_DOOR_2();
68 void DrawMaskedBorder_DOOR_3();
69 void DrawMaskedBorder_ALL();
70 void DrawMaskedBorder(int);
71
72 void SetDrawtoField(int);
73 void RedrawPlayfield(boolean, int, int, int, int);
74 void BlitScreenToBitmap(Bitmap *);
75 void BackToFront();
76
77 void FadeIn(int);
78 void FadeOut(int);
79 void FadeSetEnterMenu();
80 void FadeSetLeaveMenu();
81 void FadeSetEnterScreen();
82 void FadeSetNextScreen();
83 void FadeSetLeaveScreen();
84 void FadeSetFromType(int);
85 void FadeSetDisabled();
86 void FadeSkipNextFadeIn();
87 void FadeSkipNextFadeOut();
88
89 void ClearField();
90 void SetWindowBackgroundImageIfDefined(int);
91 void SetMainBackgroundImageIfDefined(int);
92 void SetDoorBackgroundImageIfDefined(int);
93 void SetWindowBackgroundImage(int);
94 void SetMainBackgroundImage(int);
95 void SetDoorBackgroundImage(int);
96 void SetPanelBackground();
97 void DrawBackground(int, int, int, int);
98 void DrawBackgroundForFont(int, int, int, int, int);
99 void DrawBackgroundForGraphic(int, int, int, int, int);
100
101 void MarkTileDirty(int, int);
102 void SetBorderElement();
103 void FloodFillLevel(int, int, int, short[MAX_LEV_FIELDX][MAX_LEV_FIELDY],
104                     int, int);
105
106 void SetRandomAnimationValue(int, int);
107 int getGraphicAnimationFrame(int, int);
108
109 void DrawGraphicAnimation(int, int, int);
110 void DrawGraphicAnimationExt(DrawBuffer *, int, int, int, int, int);
111
112 void DrawFixedGraphicAnimation(int, int, int);
113 void DrawFixedGraphicAnimationExt(DrawBuffer *, int, int, int, int, int);
114
115 void DrawLevelGraphicAnimation(int, int, int);
116 void DrawLevelElementAnimation(int, int, int);
117 void DrawLevelGraphicAnimationIfNeeded(int, int, int);
118 void DrawLevelElementAnimationIfNeeded(int, int, int);
119
120 void DrawAllPlayers(void);
121 void DrawPlayerField(int, int);
122 void DrawPlayer(struct PlayerInfo *);
123
124 void getSizedGraphicSourceExt(int, int, int, Bitmap **, int *, int *, boolean);
125 void getFixedGraphicSourceExt(int, int, Bitmap **, int *, int *, boolean);
126 void getSizedGraphicSource(int, int, int, Bitmap **, int *, int *);
127 void getFixedGraphicSource(int, int, Bitmap **, int *, int *);
128 void getMiniGraphicSource(int, Bitmap **, int *, int *);
129 void getGraphicSourceExt(int, int, Bitmap **, int *, int *, boolean);
130 void getGraphicSource(int, int, Bitmap **, int *, int *);
131
132 void DrawGraphic(int, int, int, int);
133 void DrawGraphicExt(DrawBuffer *, int, int, int, int);
134 void DrawGraphicThruMask(int, int, int, int);
135 void DrawGraphicThruMaskExt(DrawBuffer *, int, int, int, int);
136
137 void DrawFixedGraphic(int, int, int, int);
138 void DrawFixedGraphicExt(DrawBuffer *, int, int, int, int);
139 void DrawFixedGraphicThruMask(int, int, int, int);
140 void DrawFixedGraphicThruMaskExt(DrawBuffer *, int, int, int, int);
141
142 void DrawSizedGraphic(int, int, int, int, int);
143 void DrawSizedGraphicExt(DrawBuffer *, int, int, int, int, int);
144
145 void DrawMiniGraphic(int, int, int);
146 void DrawMiniGraphicExt(DrawBuffer *, int, int, int);
147
148 void DrawScreenElementExt(int, int, int, int, int, int, int);
149 void DrawLevelElementExt(int, int, int, int, int, int, int);
150 void DrawScreenElementShifted(int, int, int, int, int, int);
151 void DrawLevelElementShifted(int, int, int, int, int, int);
152 void DrawScreenElementThruMask(int, int, int);
153 void DrawLevelElementThruMask(int, int, int);
154 void DrawLevelFieldThruMask(int, int);
155 void DrawLevelFieldCrumbled(int, int);
156 void DrawLevelFieldCrumbledDigging(int, int, int, int);
157 void DrawLevelFieldCrumbledNeighbours(int, int);
158 void DrawScreenElement(int, int, int);
159 void DrawLevelElement(int, int, int);
160 void DrawScreenField(int, int);
161 void DrawLevelField(int, int);
162
163 void DrawMiniElement(int, int, int);
164 void DrawMiniElementOrWall(int, int, int, int);
165
166 void ShowEnvelope(int);
167 void ShowEnvelopeDoor(char *text, int);
168
169 void DrawLevel(void);
170 void DrawMiniLevel(int, int, int, int);
171 void DrawPreviewLevelInitial(void);
172 void DrawPreviewLevelAnimation(void);
173
174 void WaitForEventToContinue();
175 boolean Request(char *, unsigned int);
176 unsigned int OpenDoor(unsigned int);
177 unsigned int CloseDoor(unsigned int);
178 unsigned int GetDoorState(void);
179 unsigned int SetDoorState(unsigned int);
180 unsigned int MoveDoor(unsigned int);
181
182 void DrawSpecialEditorDoor();
183 void UndrawSpecialEditorDoor();
184
185 void CreateToolButtons();
186 void FreeToolButtons();
187
188 int map_element_RND_to_EM(int);
189 int map_element_EM_to_RND(int);
190 int map_direction_RND_to_EM(int);
191 int map_direction_EM_to_RND(int);
192
193 void map_android_clone_elements_RND_to_EM(struct LevelInfo *);
194 void map_android_clone_elements_EM_to_RND(struct LevelInfo *);
195
196 int map_element_RND_to_SP(int);
197 int map_element_SP_to_RND(int);
198 int map_action_SP_to_RND(int);
199
200 int get_next_element(int);
201 int el_act_dir2img(int, int, int);
202 int el_act2img(int, int);
203 int el_dir2img(int, int);
204 int el2baseimg(int);
205 int el2img(int);
206 int el2edimg(int);
207 int el2preimg(int);
208 int el2panelimg(int);
209 int font2baseimg(int);
210
211 int getBeltNrFromBeltElement(int);
212 int getBeltNrFromBeltActiveElement(int);
213 int getBeltNrFromBeltSwitchElement(int);
214 int getBeltDirNrFromBeltElement(int);
215 int getBeltDirNrFromBeltSwitchElement(int);
216 int getBeltDirFromBeltElement(int);
217 int getBeltDirFromBeltSwitchElement(int);
218 int getBeltElementFromBeltNrAndBeltDirNr(int, int);
219 int getBeltElementFromBeltNrAndBeltDir(int, int);
220 int getBeltSwitchElementFromBeltNrAndBeltDirNr(int, int);
221 int getBeltSwitchElementFromBeltNrAndBeltDir(int, int);
222
223 unsigned int InitRND(int);
224 void InitGraphicInfo_EM(void);
225
226 void PlayMenuSoundExt(int);
227 void PlayMenuSound();
228 void PlayMenuSoundStereo(int, int);
229 void PlayMenuSoundIfLoopExt(int);
230 void PlayMenuSoundIfLoop();
231 void PlayMenuMusicExt(int);
232 void PlayMenuMusic();
233 void PlaySoundActivating();
234 void PlaySoundSelecting();
235
236 void ToggleFullscreenOrChangeWindowScalingIfNeeded();
237 void ChangeViewportPropertiesIfNeeded();
238
239 #endif  /* TOOLS_H */