Files
@ r3668:ccd06bb86e8c
Branch filter:
Location: cpp/openttd-patchpack/source/newgrf_spritegroup.h
r3668:ccd06bb86e8c
4.0 KiB
text/x-c
(svn r4583) - NewGRF: Revamp sprite group loading to support advanced varadjusts and variable size. These are not yet processed, however.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 | /* $Id$ */
#ifndef NEWGRF_SPRITEGROUP_H
#define NEWGRF_SPRITEGROUP_H
typedef struct SpriteGroup SpriteGroup;
/* 'Real' sprite groups contain a list of other result or callback sprite
* groups. */
typedef struct RealSpriteGroup {
// Loaded = in motion, loading = not moving
// Each group contains several spritesets, for various loading stages
// XXX: For stations the meaning is different - loaded is for stations
// with small amount of cargo whilst loading is for stations with a lot
// of da stuff.
byte num_loaded; ///< Number of loaded groups
byte num_loading; ///< Number of loading groups
SpriteGroup **loaded; ///< List of loaded groups (can be SpriteIDs or Callback results)
SpriteGroup **loading; ///< List of loading groups (can be SpriteIDs or Callback results)
} RealSpriteGroup;
/* Shared by deterministic and random groups. */
typedef enum VarSpriteGroupScopes {
VSG_SCOPE_SELF,
// Engine of consists for vehicles, city for stations.
VSG_SCOPE_PARENT,
} VarSpriteGroupScope;
typedef enum DeterministicSpriteGroupSizes {
DSG_SIZE_BYTE,
DSG_SIZE_WORD,
DSG_SIZE_DWORD,
} DeterministicSpriteGroupSize;
typedef enum DeterministicSpriteGroupAdjustTypes {
DSGA_TYPE_NONE,
DSGA_TYPE_DIV,
DSGA_TYPE_MOD,
} DeterministicSpriteGroupAdjustType;
typedef enum DeterministicSpriteGroupAdjustOperations {
DSGA_OP_ADD, // a + b
DSGA_OP_SUB, // a - b
DSGA_OP_SMIN, // (signed) min(a, b)
DSGA_OP_SMAX, // (signed) max(a, b)
DSGA_OP_UMIN, // (unsigned) min(a, b)
DSGA_OP_UMAX, // (unsigned) max(a, b)
DSGA_OP_SDIV, // (signed) a / b
DSGA_OP_SMOD, // (signed) a % b
DSGA_OP_UDIV, // (unsigned) a / b
DSGA_OP_UMOD, // (unsigned) a & b
DSGA_OP_MUL, // a * b
DSGA_OP_AND, // a & b
DSGA_OP_OR, // a | b
DSGA_OP_XOR, // a ^ b
} DeterministicSpriteGroupAdjustOperation;
typedef struct DeterministicSpriteGroupAdjust {
DeterministicSpriteGroupAdjustOperation operation;
DeterministicSpriteGroupAdjustType type;
byte variable;
byte parameter; ///< Used for variables between 0x60 and 0x7F inclusive.
byte shift_num;
uint32 and_mask;
uint32 add_val;
uint32 divmod_val;
} DeterministicSpriteGroupAdjust;
typedef struct DeterministicSpriteGroupRange {
SpriteGroup *group;
uint32 low;
uint32 high;
} DeterministicSpriteGroupRange;
typedef struct DeterministicSpriteGroup {
VarSpriteGroupScope var_scope;
DeterministicSpriteGroupSize size;
byte num_adjusts;
byte num_ranges;
DeterministicSpriteGroupAdjust *adjusts;
DeterministicSpriteGroupRange *ranges; // Dynamically allocated
// Dynamically allocated, this is the sole owner
SpriteGroup *default_group;
} DeterministicSpriteGroup;
typedef enum RandomizedSpriteGroupCompareModes {
RSG_CMP_ANY,
RSG_CMP_ALL,
} RandomizedSpriteGroupCompareMode;
typedef struct RandomizedSpriteGroup {
// Take this object:
VarSpriteGroupScope var_scope;
// Check for these triggers:
RandomizedSpriteGroupCompareMode cmp_mode;
byte triggers;
// Look for this in the per-object randomized bitmask:
byte lowest_randbit;
byte num_groups; // must be power of 2
// Take the group with appropriate index:
SpriteGroup **groups;
} RandomizedSpriteGroup;
/* This contains a callback result. A failed callback has a value of
* CALLBACK_FAILED */
typedef struct CallbackResultSpriteGroup {
uint16 result;
} CallbackResultSpriteGroup;
/* A result sprite group returns the first SpriteID and the number of
* sprites in the set */
typedef struct ResultSpriteGroup {
SpriteID sprite;
byte num_sprites;
} ResultSpriteGroup;
/* List of different sprite group types */
typedef enum SpriteGroupType {
SGT_INVALID,
SGT_REAL,
SGT_DETERMINISTIC,
SGT_RANDOMIZED,
SGT_CALLBACK,
SGT_RESULT,
} SpriteGroupType;
/* Common wrapper for all the different sprite group types */
struct SpriteGroup {
SpriteGroupType type;
union {
RealSpriteGroup real;
DeterministicSpriteGroup determ;
RandomizedSpriteGroup random;
CallbackResultSpriteGroup callback;
ResultSpriteGroup result;
} g;
};
SpriteGroup *AllocateSpriteGroup(void);
void InitializeSpriteGroupPool(void);
#endif /* NEWGRF_SPRITEGROUP_H */
|