added showing commit hash on version page of info screen
[rocksndiamonds.git] / src / tools.h
1 // ============================================================================
2 // Rocks'n'Diamonds - McDuffin Strikes Back!
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
5 //                  Holger Schemel
6 //                  info@artsoft.org
7 //                  https://www.artsoft.org/
8 // ----------------------------------------------------------------------------
9 // tools.h
10 // ============================================================================
11
12 #ifndef TOOLS_H
13 #define TOOLS_H
14
15 #include "main.h"
16 #include "game.h"
17
18
19 // for DrawElementShifted
20 #define NO_CUTTING              0
21 #define CUT_ABOVE               (1 << 0)
22 #define CUT_BELOW               (1 << 1)
23 #define CUT_LEFT                (1 << 2)
24 #define CUT_RIGHT               (1 << 3)
25
26 // for masking functions
27 #define NO_MASKING              0
28 #define USE_MASKING             1
29  
30 // for MoveDoor
31 #define DOOR_OPEN_1             (1 << 0)
32 #define DOOR_OPEN_2             (1 << 1)
33 #define DOOR_CLOSE_1            (1 << 2)
34 #define DOOR_CLOSE_2            (1 << 3)
35 #define DOOR_OPEN_ALL           (DOOR_OPEN_1 | DOOR_OPEN_2)
36 #define DOOR_CLOSE_ALL          (DOOR_CLOSE_1 | DOOR_CLOSE_2)
37 #define DOOR_ACTION_1           (DOOR_OPEN_1 | DOOR_CLOSE_1)
38 #define DOOR_ACTION_2           (DOOR_OPEN_2 | DOOR_CLOSE_2)
39 #define DOOR_ACTION             (DOOR_ACTION_1 | DOOR_ACTION_2)
40 #define DOOR_COPY_BACK          (1 << 4)
41 #define DOOR_NO_COPY_BACK       (1 << 5)
42 #define DOOR_NO_DELAY           (1 << 6)
43 #define DOOR_FORCE_ANIM         (1 << 7)
44 #define DOOR_FORCE_REDRAW       (1 << 8)
45 #define DOOR_GET_STATE          (1 << 9)
46 #define DOOR_SET_STATE          (1 << 10)
47
48 #define DOOR_1                  (DOOR_ACTION_1)
49 #define DOOR_2                  (DOOR_ACTION_2)
50 #define DOOR_OPEN               (DOOR_OPEN_ALL)
51 #define DOOR_CLOSE              (DOOR_CLOSE_ALL)
52
53 #define DOOR_INDEX_FROM_TOKEN(x)        ((x) == DOOR_1 ? 0 : 1)
54 #define DOOR_TOKEN_FROM_INDEX(x)        ((x) == 0 ? DOOR_1 ? : DOOR_2)
55 #define REDRAW_DOOR_FROM_TOKEN(x)       ((x) == DOOR_1 ? REDRAW_DOOR_1 : \
56                                          REDRAW_DOOR_2)
57
58 // for Request
59 #define REQ_ASK                 (1 << 0)
60 #define REQ_CONFIRM             (1 << 1)
61 #define REQ_PLAYER              (1 << 2)
62 #define REQ_STAY_OPEN           (1 << 3)
63 #define REQ_STAY_CLOSED         (1 << 4)
64 #define REQ_REOPEN              (1 << 5)
65
66 #define REQUEST_WAIT_FOR_INPUT  (REQ_ASK | REQ_CONFIRM | REQ_PLAYER)
67
68
69 int getFieldbufferOffsetX_RND(int, int);
70 int getFieldbufferOffsetY_RND(int, int);
71
72 int getLevelFromScreenX(int);
73 int getLevelFromScreenY(int);
74
75 void DumpTile(int, int);
76 void DumpTileFromScreen(int, int);
77
78 void DrawMaskedBorder_FIELD(void);
79 void DrawMaskedBorder_DOOR_1(void);
80 void DrawMaskedBorder_DOOR_2(void);
81 void DrawMaskedBorder_DOOR_3(void);
82 void DrawMaskedBorder_ALL(void);
83 void DrawMaskedBorder(int);
84 void DrawMaskedBorderToTarget(int);
85 void DrawTileCursor(int);
86
87 void SetDrawtoField(int);
88 void RedrawPlayfield(void);
89 void BlitScreenToBitmapExt_RND(Bitmap *, int, int);
90 void BlitScreenToBitmap_RND(Bitmap *);
91 void BlitScreenToBitmap(Bitmap *);
92 void BackToFront(void);
93 void BackToFront_WithFrameDelay(unsigned int);
94
95 void FadeIn(int);
96 void FadeOut(int);
97 void FadeSetEnterMenu(void);
98 void FadeSetLeaveMenu(void);
99 void FadeSetEnterScreen(void);
100 void FadeSetNextScreen(void);
101 void FadeSetLeaveScreen(void);
102 void FadeSetFromType(int);
103 void FadeSetDisabled(void);
104 void FadeSkipNextFadeIn(void);
105 void FadeSkipNextFadeOut(void);
106
107 Bitmap *getGlobalBorderBitmapFromStatus(int);
108
109 void ClearField(void);
110 void SetWindowBackgroundImageIfDefined(int);
111 void SetMainBackgroundImageIfDefined(int);
112 void SetDoorBackgroundImageIfDefined(int);
113 void SetWindowBackgroundImage(int);
114 void SetMainBackgroundImage(int);
115 void SetDoorBackgroundImage(int);
116 void SetPanelBackground(void);
117 void DrawBackground(int, int, int, int);
118 void DrawBackgroundForFont(int, int, int, int, int);
119 void DrawBackgroundForGraphic(int, int, int, int, int);
120 boolean CheckIfGlobalBorderHasChanged(void);
121 void RedrawGlobalBorder(void);
122
123 void MarkTileDirty(int, int);
124 void SetBorderElement(void);
125 void FloodFillLevel(int, int, int, short[][MAX_LEV_FIELDY], int, int);
126 void FloodFillLevelExt(int, int, int, int, int y, short field[][y], int, int);
127
128 void SetRandomAnimationValue(int, int);
129 int getGraphicAnimationFrame(int, int);
130
131 void DrawFixedGraphicAnimation(int, int, int);
132 void DrawFixedGraphicAnimationExt(DrawBuffer *, int, int, int, int, int);
133
134 void DrawLevelGraphicAnimation(int, int, int);
135 void DrawLevelElementAnimation(int, int, int);
136 void DrawLevelGraphicAnimationIfNeeded(int, int, int);
137 void DrawLevelElementAnimationIfNeeded(int, int, int);
138
139 void DrawAllPlayers(void);
140 void DrawPlayerField(int, int);
141 void DrawPlayer(struct PlayerInfo *);
142
143 void getGraphicSourceBitmap(int, int, Bitmap **);
144 void getGraphicSourceXY(int, int, int *, int *, boolean);
145 void getSizedGraphicSourceExt(int, int, int, Bitmap **, int *, int *, boolean);
146 void getSizedGraphicSource(int, int, int, Bitmap **, int *, int *);
147 void getFixedGraphicSource(int, int, Bitmap **, int *, int *);
148 void getMiniGraphicSource(int, Bitmap **, int *, int *);
149 void getGraphicSource(int, int, Bitmap **, int *, int *);
150
151 void DrawGraphic(int, int, int, int);
152 void DrawGraphicExt(DrawBuffer *, int, int, int, int);
153 void DrawGraphicThruMask(int, int, int, int);
154 void DrawGraphicThruMaskExt(DrawBuffer *, int, int, int, int);
155
156 void DrawFixedGraphic(int, int, int, int);
157 void DrawFixedGraphicExt(DrawBuffer *, int, int, int, int);
158 void DrawFixedGraphicThruMask(int, int, int, int);
159 void DrawFixedGraphicThruMaskExt(DrawBuffer *, int, int, int, int);
160
161 void DrawSizedGraphic(int, int, int, int, int);
162 void DrawSizedGraphicExt(DrawBuffer *, int, int, int, int, int);
163 void DrawSizedGraphicThruMask(int, int, int, int, int);
164 void DrawSizedGraphicThruMaskExt(DrawBuffer *, int, int, int, int, int);
165
166 void DrawMiniGraphic(int, int, int);
167 void DrawMiniGraphicExt(DrawBuffer *, int, int, int);
168
169 void DrawScreenElementExt(int, int, int, int, int, int, int);
170 void DrawLevelElementExt(int, int, int, int, int, int, int);
171 void DrawScreenElementShifted(int, int, int, int, int, int);
172 void DrawLevelElementShifted(int, int, int, int, int, int);
173 void DrawScreenElementThruMask(int, int, int);
174 void DrawLevelElementThruMask(int, int, int);
175 void DrawLevelFieldThruMask(int, int);
176 void DrawLevelFieldCrumbled(int, int);
177 void DrawLevelFieldCrumbledDigging(int, int, int, int);
178 void DrawLevelFieldCrumbledNeighbours(int, int);
179 void DrawScreenElement(int, int, int);
180 void DrawLevelElement(int, int, int);
181 void DrawScreenField(int, int);
182 void DrawLevelField(int, int);
183
184 void DrawSizedWallParts_MM(int, int, int, int, boolean, int);
185 void DrawSizedElement(int, int, int, int);
186 void DrawSizedElementThruMask(int, int, int, int);
187 void DrawSizedElementOrWall(int, int, int, int, int);
188
189 void DrawMiniElement(int, int, int);
190 void DrawMiniElementOrWall(int, int, int, int);
191
192 void ShowEnvelope(int);
193 void ShowEnvelopeDoor(char *text, int);
194
195 void DrawLevel(int);
196 void DrawSizedLevel(int, int, int, int, int);
197 void DrawMiniLevel(int, int, int, int);
198 void DrawPreviewPlayers(void);
199 void DrawPreviewLevelInitial(void);
200 void DrawPreviewLevelAnimation(void);
201
202 void DrawNetworkPlayers(void);
203 void ClearNetworkPlayers(void);
204
205 void WaitForEventToContinue(void);
206 boolean Request(char *, unsigned int);
207 void InitGraphicCompatibilityInfo_Doors(void);
208 void InitDoors(void);
209 unsigned int OpenDoor(unsigned int);
210 unsigned int CloseDoor(unsigned int);
211 unsigned int GetDoorState(void);
212 unsigned int SetDoorState(unsigned int);
213 unsigned int MoveDoor(unsigned int);
214
215 void DrawSpecialEditorDoor(void);
216 void UndrawSpecialEditorDoor(void);
217
218 void CreateToolButtons(void);
219 void FreeToolButtons(void);
220
221 int map_element_RND_to_EM_cave(int);
222 int map_element_EM_to_RND_cave(int);
223 int map_element_EM_to_RND_game(int);
224 int map_direction_RND_to_EM(int);
225 int map_direction_EM_to_RND(int);
226
227 void map_android_clone_elements_RND_to_EM(struct LevelInfo *);
228 void map_android_clone_elements_EM_to_RND(struct LevelInfo *);
229
230 int map_element_RND_to_SP(int);
231 int map_element_SP_to_RND(int);
232 int map_action_SP_to_RND(int);
233
234 int map_element_RND_to_MM(int);
235 int map_element_MM_to_RND(int);
236 int map_action_MM_to_RND(int);
237 int map_sound_MM_to_RND(int);
238 int map_mm_wall_element(int);
239 int map_mm_wall_element_editor(int);
240
241 int get_next_element(int);
242 int el_act_dir2img(int, int, int);
243 int el_act2img(int, int);
244 int el_dir2img(int, int);
245 int el2baseimg(int);
246 int el2img(int);
247 int el2edimg(int);
248 int el2preimg(int);
249 int el2panelimg(int);
250 int font2baseimg(int);
251
252 int getBeltNrFromBeltElement(int);
253 int getBeltNrFromBeltActiveElement(int);
254 int getBeltNrFromBeltSwitchElement(int);
255 int getBeltDirNrFromBeltElement(int);
256 int getBeltDirNrFromBeltSwitchElement(int);
257 int getBeltDirFromBeltElement(int);
258 int getBeltDirFromBeltSwitchElement(int);
259 int getBeltElementFromBeltNrAndBeltDirNr(int, int);
260 int getBeltElementFromBeltNrAndBeltDir(int, int);
261 int getBeltSwitchElementFromBeltNrAndBeltDirNr(int, int);
262 int getBeltSwitchElementFromBeltNrAndBeltDir(int, int);
263
264 unsigned int InitRND(int);
265 void InitGraphicInfo_EM(void);
266
267 void PlayMenuSoundExt(int);
268 void PlayMenuSound(void);
269 void PlayMenuSoundStereo(int, int);
270 void PlayMenuSoundIfLoopExt(int);
271 void PlayMenuSoundIfLoop(void);
272 void PlayMenuMusicExt(int);
273 void PlayMenuMusic(void);
274 void PlayMenuSoundsAndMusic(void);
275 void FadeMenuSoundsAndMusic(void);
276 void PlaySoundActivating(void);
277 void PlaySoundSelecting(void);
278
279 void SetAnimStatus(int);
280 void SetGameStatus(int);
281 void SetFontStatus(int);
282 void ResetFontStatus(void);
283
284 void SetLevelSetInfo(char *, int);
285
286 void ToggleFullscreenIfNeeded(void);
287 void ChangeWindowScalingIfNeeded(void);
288 void ChangeVsyncModeIfNeeded(void);
289 void ChangeViewportPropertiesIfNeeded(void);
290
291 boolean CheckIfAllViewportsHaveChanged(void);
292 boolean CheckFadeAll(void);
293
294 #endif  // TOOLS_H