src/newgrf_debug.h

   1 /* $Id: newgrf_debug.h 25946 2013-11-07 18:17:21Z frosch $ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * 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.
   6  * 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.
   7  * 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/>.
   8  */
   9
  10 /** @file newgrf_debug.h Functions/types related to NewGRF debugging. */
  11
  12 #ifndef NEWGRF_DEBUG_H
  13 #define NEWGRF_DEBUG_H
  14
  15 #include "newgrf.h"
  16 #include "core/smallvec_type.hpp"
  17 #include "tile_type.h"
  18 #include "vehicle_type.h"
  19
  20 /** Current state of spritepicker */
  21 enum NewGrfDebugSpritePickerMode {
  22         SPM_NONE,
  23         SPM_WAIT_CLICK,
  24         SPM_REDRAW,
  25 };
  26
  27 /** Spritepicker of SpriteAligner */
  28 struct NewGrfDebugSpritePicker {
  29         NewGrfDebugSpritePickerMode mode;   ///< Current state
  30         void *clicked_pixel;                ///< Clicked pixel (pointer to blitter buffer)
  31         uint32 click_time;                  ///< Realtime tick when clicked to detect next frame
  32         SmallVector<SpriteID, 256> sprites; ///< Sprites found
  33 };
  34
  35 extern NewGrfDebugSpritePicker _newgrf_debug_sprite_picker;
  36
  37 bool IsNewGRFInspectable(GrfSpecFeature feature, uint index);
  38 void ShowNewGRFInspectWindow(GrfSpecFeature feature, uint index, const uint32 grfid = 0);
  39 void InvalidateNewGRFInspectWindow(GrfSpecFeature feature, uint index);
  40 void DeleteNewGRFInspectWindow(GrfSpecFeature feature, uint index);
  41
  42 GrfSpecFeature GetGrfSpecFeature(TileIndex tile);
  43 GrfSpecFeature GetGrfSpecFeature(VehicleType type);
  44
  45 void ShowSpriteAlignerWindow();
  46
  47 #endif /* NEWGRF_DEBUG_H */