1

/* $Id$ */

     2

     3

/** @file sprite.h Base for drawing complex sprites. */

     4

     5

#ifndef SPRITE_H

     6

#define SPRITE_H

     7

     8

#include "gfx_type.h"

     9

    10

#define GENERAL_SPRITE_COLOR(color) ((color) + PALETTE_RECOLOR_START)

    11

#define PLAYER_SPRITE_COLOR(owner) (GENERAL_SPRITE_COLOR(_player_colors[owner]))

    12

    13

/**

    14

 * Whether a sprite comes from the original graphics files or a new grf file

    15

 * (either supplied by OpenTTD or supplied by the user).

    16

 *

    17

 * @param sprite The sprite to check

    18

 * @return True if it is a new sprite, or false if it is original.

    19

 */

    20

#define IS_CUSTOM_SPRITE(sprite) ((sprite) >= SPR_SIGNALS_BASE)

    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

    26

struct DrawTileSeqStruct {

    27

	int8 delta_x; // 0x80 is sequence terminator

    28

	int8 delta_y;

    29

	int8 delta_z;

    30

	byte size_x;

    31

	byte size_y;

    32

	byte size_z;

    33

	PalSpriteID image;

    34

};

    35

    36

struct DrawTileSprites {

    37

	PalSpriteID ground;

    38

	const DrawTileSeqStruct *seq;

    39

};

    40

    41

/**

    42

 * This structure is the same for both Industries and Houses.

    43

 * Buildings here reference a general type of construction

    44

 */

    45

struct DrawBuildingsTileStruct {

    46

	PalSpriteID ground;

    47

	PalSpriteID building;

    48

	byte subtile_x;

    49

	byte subtile_y;

    50

	byte width;

    51

	byte height;

    52

	byte dz;

    53

	byte draw_proc;  /* this allows to specify a special drawing procedure.*/

    54

};

    55

    56

/** Iterate through all DrawTileSeqStructs in DrawTileSprites. */

    57

#define foreach_draw_tile_seq(idx, list) for (idx = list; ((byte) idx->delta_x) != 0x80; idx++)

    58

    59

void SkipSpriteData(byte type, uint16 num);

    60

    61

#endif /* SPRITE_H */