sprite.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */
 
#ifndef SPRITE_H
#define SPRITE_H
 
#include "transparency.h"
 
#include "table/sprites.h"
 
#define GENERAL_SPRITE_COLOUR(colour) ((colour) + PALETTE_RECOLOUR_START)
#define COMPANY_SPRITE_COLOUR(owner) (GENERAL_SPRITE_COLOUR(_company_colours[owner]))
 
/* The following describes bunch of sprites to be drawn together in a single 3D
 * bounding box. Used especially for various multi-sprite buildings (like
 * depots or stations): */
 
struct DrawTileSeqStruct {
  int8_t delta_x = 0;
  int8_t delta_y = 0;
  int8_t delta_z = 0; 
  uint8_t size_x = 0;
  uint8_t size_y = 0;
  uint8_t size_z = 0;
  PalSpriteID image{};
 
  bool IsParentSprite() const
  {
    return (uint8_t)this->delta_z != 0x80;
  }
};
 
struct DrawTileSprites {
  PalSpriteID ground{}; 
 
  DrawTileSprites(PalSpriteID ground) : ground(ground) {}
  DrawTileSprites() = default;
 
  virtual ~DrawTileSprites() = default;
  virtual std::span<const DrawTileSeqStruct> GetSequence() const = 0;
};
 
struct DrawTileSpriteSpan : DrawTileSprites {
  std::span<const DrawTileSeqStruct> seq; 
 
  template <size_t N>
  DrawTileSpriteSpan(PalSpriteID ground, const DrawTileSeqStruct (&seq)[N]) : DrawTileSprites(ground), seq(std::begin(seq), std::end(seq)) {}
  DrawTileSpriteSpan(PalSpriteID ground) : DrawTileSprites(ground) {};
  DrawTileSpriteSpan() = default;
 
  std::span<const DrawTileSeqStruct> GetSequence() const override { return this->seq; }
};
 
struct DrawBuildingsTileStruct {
  PalSpriteID ground;
  PalSpriteID building;
  uint8_t subtile_x;
  uint8_t subtile_y;
  uint8_t width;
  uint8_t height;
  uint8_t dz;
  uint8_t draw_proc;  // this allows to specify a special drawing procedure.
};
 
void DrawCommonTileSeq(const struct TileInfo *ti, const DrawTileSprites *dts, TransparencyOption to, int32_t orig_offset, uint32_t newgrf_offset, PaletteID default_palette, bool child_offset_is_unsigned);
void DrawCommonTileSeqInGUI(int x, int y, const DrawTileSprites *dts, int32_t orig_offset, uint32_t newgrf_offset, PaletteID default_palette, bool child_offset_is_unsigned);
 
inline void DrawRailTileSeq(const struct TileInfo *ti, const DrawTileSprites *dts, TransparencyOption to, int32_t total_offset, uint32_t newgrf_offset, PaletteID default_palette)
{
  DrawCommonTileSeq(ti, dts, to, total_offset, newgrf_offset, default_palette, false);
}
 
inline void DrawRailTileSeqInGUI(int x, int y, const DrawTileSprites *dts, int32_t total_offset, uint32_t newgrf_offset, PaletteID default_palette)
{
  DrawCommonTileSeqInGUI(x, y, dts, total_offset, newgrf_offset, default_palette, false);
}
 
inline void DrawOrigTileSeq(const struct TileInfo *ti, const DrawTileSprites *dts, TransparencyOption to, PaletteID default_palette)
{
  DrawCommonTileSeq(ti, dts, to, 0, 0, default_palette, false);
}
 
inline void DrawOrigTileSeqInGUI(int x, int y, const DrawTileSprites *dts, PaletteID default_palette)
{
  DrawCommonTileSeqInGUI(x, y, dts, 0, 0, default_palette, false);
}
 
inline void DrawNewGRFTileSeq(const struct TileInfo *ti, const DrawTileSprites *dts, TransparencyOption to, uint32_t stage, PaletteID default_palette)
{
  DrawCommonTileSeq(ti, dts, to, 0, stage, default_palette, true);
}
 
inline void DrawNewGRFTileSeqInGUI(int x, int y, const DrawTileSprites *dts, uint32_t stage, PaletteID default_palette)
{
  DrawCommonTileSeqInGUI(x, y, dts, 0, stage, default_palette, true);
}
 
inline PaletteID SpriteLayoutPaletteTransform(SpriteID image, PaletteID pal, PaletteID default_pal)
{
  if (HasBit(image, PALETTE_MODIFIER_TRANSPARENT) || HasBit(image, PALETTE_MODIFIER_COLOUR)) {
    return (pal != 0 ? pal : default_pal);
  } else {
    return PAL_NONE;
  }
}
 
inline PaletteID GroundSpritePaletteTransform(SpriteID image, PaletteID pal, PaletteID default_pal)
{
  if (HasBit(image, PALETTE_MODIFIER_COLOUR)) {
    return (pal != 0 ? pal : default_pal);
  } else {
    return PAL_NONE;
  }
}
 
#endif /* SPRITE_H */