OpenTTD
sprite.h
Go to the documentation of this file.
1 /* $Id: sprite.h 23706 2012-01-01 17:36:19Z smatz $ */
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 
12 #ifndef SPRITE_H
13 #define SPRITE_H
14 
15 #include "transparency.h"
16 
17 #include "table/sprites.h"
18 
19 #define GENERAL_SPRITE_COLOUR(colour) ((colour) + PALETTE_RECOLOUR_START)
20 #define COMPANY_SPRITE_COLOUR(owner) (GENERAL_SPRITE_COLOUR(_company_colours[owner]))
21 
22 /* The following describes bunch of sprites to be drawn together in a single 3D
23  * bounding box. Used especially for various multi-sprite buildings (like
24  * depots or stations): */
25 
28  int8 delta_x;
29  int8 delta_y;
30  int8 delta_z;
31  byte size_x;
32  byte size_y;
33  byte size_z;
34  PalSpriteID image;
35 
38  {
39  this->delta_x = (int8)0x80;
40  }
41 
43  bool IsTerminator() const
44  {
45  return (byte)this->delta_x == 0x80;
46  }
47 
49  bool IsParentSprite() const
50  {
51  return (byte)this->delta_z != 0x80;
52  }
53 };
54 
63 };
64 
70  PalSpriteID ground;
71  PalSpriteID building;
72  byte subtile_x;
73  byte subtile_y;
74  byte width;
75  byte height;
76  byte dz;
77  byte draw_proc; // this allows to specify a special drawing procedure.
78 };
79 
81 #define foreach_draw_tile_seq(idx, list) for (idx = list; !idx->IsTerminator(); idx++)
82 
83 void DrawCommonTileSeq(const struct TileInfo *ti, const DrawTileSprites *dts, TransparencyOption to, int32 orig_offset, uint32 newgrf_offset, PaletteID default_palette, bool child_offset_is_unsigned);
84 void DrawCommonTileSeqInGUI(int x, int y, const DrawTileSprites *dts, int32 orig_offset, uint32 newgrf_offset, PaletteID default_palette, bool child_offset_is_unsigned);
85 
91 static inline void DrawRailTileSeq(const struct TileInfo *ti, const DrawTileSprites *dts, TransparencyOption to, int32 total_offset, uint32 newgrf_offset, PaletteID default_palette)
92 {
93  DrawCommonTileSeq(ti, dts, to, total_offset, newgrf_offset, default_palette, false);
94 }
95 
101 static inline void DrawRailTileSeqInGUI(int x, int y, const DrawTileSprites *dts, int32 total_offset, uint32 newgrf_offset, PaletteID default_palette)
102 {
103  DrawCommonTileSeqInGUI(x, y, dts, total_offset, newgrf_offset, default_palette, false);
104 }
105 
109 static inline void DrawOrigTileSeq(const struct TileInfo *ti, const DrawTileSprites *dts, TransparencyOption to, PaletteID default_palette)
110 {
111  DrawCommonTileSeq(ti, dts, to, 0, 0, default_palette, false);
112 }
113 
117 static inline void DrawOrigTileSeqInGUI(int x, int y, const DrawTileSprites *dts, PaletteID default_palette)
118 {
119  DrawCommonTileSeqInGUI(x, y, dts, 0, 0, default_palette, false);
120 }
121 
126 static inline void DrawNewGRFTileSeq(const struct TileInfo *ti, const DrawTileSprites *dts, TransparencyOption to, uint32 stage, PaletteID default_palette)
127 {
128  DrawCommonTileSeq(ti, dts, to, 0, stage, default_palette, true);
129 }
130 
135 static inline void DrawNewGRFTileSeqInGUI(int x, int y, const DrawTileSprites *dts, uint32 stage, PaletteID default_palette)
136 {
137  DrawCommonTileSeqInGUI(x, y, dts, 0, stage, default_palette, true);
138 }
139 
151 static inline PaletteID SpriteLayoutPaletteTransform(SpriteID image, PaletteID pal, PaletteID default_pal)
152 {
154  return (pal != 0 ? pal : default_pal);
155  } else {
156  return PAL_NONE;
157  }
158 }
159 
170 static inline PaletteID GroundSpritePaletteTransform(SpriteID image, PaletteID pal, PaletteID default_pal)
171 {
172  if (HasBit(image, PALETTE_MODIFIER_COLOUR)) {
173  return (pal != 0 ? pal : default_pal);
174  } else {
175  return PAL_NONE;
176  }
177 }
178 
179 #endif /* SPRITE_H */
uint32 PaletteID
The number of the palette.
Definition: gfx_type.h:20
static void DrawOrigTileSeqInGUI(int x, int y, const DrawTileSprites *dts, PaletteID default_palette)
Draw TTD sprite sequence in GUI.
Definition: sprite.h:117
Tile information, used while rendering the tile.
Definition: tile_cmd.h:44
static void DrawNewGRFTileSeq(const struct TileInfo *ti, const DrawTileSprites *dts, TransparencyOption to, uint32 stage, PaletteID default_palette)
Draw NewGRF industrytile or house sprite layout.
Definition: sprite.h:126
static void DrawNewGRFTileSeqInGUI(int x, int y, const DrawTileSprites *dts, uint32 stage, PaletteID default_palette)
Draw NewGRF object in GUI.
Definition: sprite.h:135
Combination of a palette sprite and a &#39;real&#39; sprite.
Definition: gfx_type.h:24
void MakeTerminator()
Make this struct a sequence terminator.
Definition: sprite.h:37
void DrawCommonTileSeq(const TileInfo *ti, const DrawTileSprites *dts, TransparencyOption to, int32 orig_offset, uint32 newgrf_offset, PaletteID default_palette, bool child_offset_is_unsigned)
Draws a tile sprite sequence.
Definition: sprite.cpp:32
const DrawTileSeqStruct * seq
Array of child sprites. Terminated with a terminator entry.
Definition: sprite.h:62
static void DrawRailTileSeqInGUI(int x, int y, const DrawTileSprites *dts, int32 total_offset, uint32 newgrf_offset, PaletteID default_palette)
Draw tile sprite sequence in GUI with railroad specifics.
Definition: sprite.h:101
bool IsTerminator() const
Check whether this is a sequence terminator.
Definition: sprite.h:43
Ground palette sprite of a tile, together with its sprite layout.
Definition: sprite.h:60
void DrawCommonTileSeqInGUI(int x, int y, const DrawTileSprites *dts, int32 orig_offset, uint32 newgrf_offset, PaletteID default_palette, bool child_offset_is_unsigned)
Draws a tile sprite sequence in the GUI.
Definition: sprite.cpp:94
static PaletteID GroundSpritePaletteTransform(SpriteID image, PaletteID pal, PaletteID default_pal)
Applies PALETTE_MODIFIER_COLOUR to a palette entry of a ground sprite.
Definition: sprite.h:170
This structure is the same for both Industries and Houses.
Definition: sprite.h:69
bool IsParentSprite() const
Check whether this is a parent sprite with a boundingbox.
Definition: sprite.h:49
static void DrawRailTileSeq(const struct TileInfo *ti, const DrawTileSprites *dts, TransparencyOption to, int32 total_offset, uint32 newgrf_offset, PaletteID default_palette)
Draw tile sprite sequence on tile with railroad specifics.
Definition: sprite.h:91
static void DrawOrigTileSeq(const struct TileInfo *ti, const DrawTileSprites *dts, TransparencyOption to, PaletteID default_palette)
Draw TTD sprite sequence on tile.
Definition: sprite.h:109
PalSpriteID ground
Palette and sprite for the ground.
Definition: sprite.h:61
this bit is set when a recolouring process is in action
Definition: sprites.h:1509
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:19
Functions related to transparency.
when a sprite is to be displayed transparently, this bit needs to be set.
Definition: sprites.h:1508
int8 delta_z
0x80 identifies child sprites
Definition: sprite.h:30
static PaletteID SpriteLayoutPaletteTransform(SpriteID image, PaletteID pal, PaletteID default_pal)
Applies PALETTE_MODIFIER_TRANSPARENT and PALETTE_MODIFIER_COLOUR to a palette entry of a sprite layou...
Definition: sprite.h:151
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
int8 delta_x
0x80 is sequence terminator
Definition: sprite.h:28
A tile child sprite and palette to draw for stations etc, with 3D bounding box.
Definition: sprite.h:27
This file contains all sprite-related enums and defines.
TransparencyOption
Transparency option bits: which position in _transparency_opt stands for which transparency.
Definition: transparency.h:24