OpenTTD Source: src/newgrf_debug.h Source File

OpenTTD Source 13.2.1

newgrf_debug.h
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD 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, version 2.
4 * OpenTTD 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.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
10 #ifndef NEWGRF_DEBUG_H
11 #define NEWGRF_DEBUG_H
12
13 #include "newgrf.h"
14 #include "core/smallvec_type.hpp"
15 #include "tile_type.h"
16 #include "vehicle_type.h"
17
19 enum NewGrfDebugSpritePickerMode {
20 SPM_NONE,
21 SPM_WAIT_CLICK,
22 SPM_REDRAW,
23 };
24
26 struct NewGrfDebugSpritePicker {
27 NewGrfDebugSpritePickerMode mode;
28 void *clicked_pixel;
29 std::vector<SpriteID> sprites;
30 };
31
32 extern NewGrfDebugSpritePicker _newgrf_debug_sprite_picker;
33
34 bool IsNewGRFInspectable(GrfSpecFeature feature, uint index);
35 void ShowNewGRFInspectWindow(GrfSpecFeature feature, uint index, const uint32 grfid = 0);
36 void InvalidateNewGRFInspectWindow(GrfSpecFeature feature, uint index);
37 void DeleteNewGRFInspectWindow(GrfSpecFeature feature, uint index);
38
39 GrfSpecFeature GetGrfSpecFeature(TileIndex tile);
40 GrfSpecFeature GetGrfSpecFeature(VehicleType type);
41
42 void ShowSpriteAlignerWindow();
43
44 #endif /* NEWGRF_DEBUG_H */
NewGrfDebugSpritePicker::clicked_pixel
void * clicked_pixel
Clicked pixel (pointer to blitter buffer)
Definition: newgrf_debug.h:28
ShowSpriteAlignerWindow
void ShowSpriteAlignerWindow()
Show the window for aligning sprites.
Definition: newgrf_debug_gui.cpp:1130
DeleteNewGRFInspectWindow
void DeleteNewGRFInspectWindow(GrfSpecFeature feature, uint index)
Delete inspect window for a given feature and index.
Definition: newgrf_debug_gui.cpp:730
NewGrfDebugSpritePickerMode
NewGrfDebugSpritePickerMode
Current state of spritepicker.
Definition: newgrf_debug.h:19
_newgrf_debug_sprite_picker
NewGrfDebugSpritePicker _newgrf_debug_sprite_picker
The sprite picker.
Definition: newgrf_debug_gui.cpp:48
smallvec_type.hpp
NewGrfDebugSpritePicker::sprites
std::vector< SpriteID > sprites
Sprites found.
Definition: newgrf_debug.h:29
NewGrfDebugSpritePicker::mode
NewGrfDebugSpritePickerMode mode
Current state.
Definition: newgrf_debug.h:27
TileIndex
The index/ID of a Tile.
Definition: tile_type.h:85
InvalidateNewGRFInspectWindow
void InvalidateNewGRFInspectWindow(GrfSpecFeature feature, uint index)
Invalidate the inspect window for a given feature and index.
Definition: newgrf_debug_gui.cpp:714
GetGrfSpecFeature
GrfSpecFeature GetGrfSpecFeature(TileIndex tile)
Get the GrfSpecFeature associated with the tile.
Definition: newgrf_debug_gui.cpp:764
VehicleType
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21
GrfSpecFeature
GrfSpecFeature
Definition: newgrf.h:66
NewGrfDebugSpritePicker
Spritepicker of SpriteAligner.
Definition: newgrf_debug.h:26
vehicle_type.h
tile_type.h
newgrf.h
ShowNewGRFInspectWindow
void ShowNewGRFInspectWindow(GrfSpecFeature feature, uint index, const uint32 grfid=0)
Show the inspect window for a given feature and index.
Definition: newgrf_debug_gui.cpp:696
IsNewGRFInspectable
bool IsNewGRFInspectable(GrfSpecFeature feature, uint index)
Can we inspect the data given a certain feature and index.
Definition: newgrf_debug_gui.cpp:752