OpenTTD Source 20241224-master-gee860a5c8e
|
NewGRF supplied spritelayout. More...
#include <newgrf_commons.h>
Public Member Functions | |
void | Allocate (uint num_sprites) |
Allocate a spritelayout for num_sprites building sprites. | |
void | AllocateRegisters () |
Allocate memory for register modifiers. | |
void | Clone (const DrawTileSeqStruct *source) |
Clone the building sprites of a spritelayout. | |
void | Clone (const NewGRFSpriteLayout *source) |
Clone a spritelayout. | |
void | Clone (const DrawTileSprites *source) |
Clone a spritelayout. | |
bool | NeedsPreprocessing () const |
Tests whether this spritelayout needs preprocessing by PrepareLayout() and ProcessRegisters(), or whether it can be used directly. | |
uint32_t | PrepareLayout (uint32_t orig_offset, uint32_t newgrf_ground_offset, uint32_t newgrf_offset, uint constr_stage, bool separate_ground) const |
Prepares a sprite layout before resolving action-1-2-3 chains. | |
void | ProcessRegisters (uint8_t resolved_var10, uint32_t resolved_sprite, bool separate_ground) const |
Evaluates the register modifiers and integrates them into the preprocessed sprite layout. | |
const DrawTileSeqStruct * | GetLayout (PalSpriteID *ground) const |
Returns the result spritelayout after preprocessing. | |
Public Member Functions inherited from ZeroedMemoryAllocator | |
void * | operator new (size_t size) |
Memory allocator for a single class instance. | |
void * | operator new[] (size_t size) |
Memory allocator for an array of class instances. | |
void | operator delete (void *ptr) |
Memory release for a single class instance. | |
void | operator delete[] (void *ptr) |
Memory release for an array of class instances. | |
Data Fields | |
const TileLayoutRegisters * | registers |
uint | consistent_max_offset |
Number of sprites in all referenced spritesets. | |
Data Fields inherited from DrawTileSprites | |
PalSpriteID | ground |
Palette and sprite for the ground. | |
const DrawTileSeqStruct * | seq |
Array of child sprites. Terminated with a terminator entry. | |
Static Private Attributes | |
static std::vector< DrawTileSeqStruct > | result_seq |
Temporary storage when preprocessing spritelayouts. | |
NewGRF supplied spritelayout.
In contrast to DrawTileSprites this struct is for allocated layouts on the heap. It allocates data and frees them on destruction.
Definition at line 112 of file newgrf_commons.h.
|
inlinevirtual |
Definition at line 137 of file newgrf_commons.h.
void NewGRFSpriteLayout::Allocate | ( | uint | num_sprites | ) |
Allocate a spritelayout for num_sprites building sprites.
num_sprites | Number of building sprites to allocate memory for. (not counting the terminator) |
Definition at line 609 of file newgrf_commons.cpp.
References DrawTileSeqStruct::MakeTerminator(), and DrawTileSprites::seq.
Referenced by ReadSpriteLayout().
void NewGRFSpriteLayout::AllocateRegisters | ( | ) |
Allocate memory for register modifiers.
Definition at line 621 of file newgrf_commons.cpp.
References foreach_draw_tile_seq, and DrawTileSprites::seq.
Referenced by ReadSpriteLayout(), and ReadSpriteLayoutRegisters().
void NewGRFSpriteLayout::Clone | ( | const DrawTileSeqStruct * | source | ) |
Clone the building sprites of a spritelayout.
source | The building sprites to copy. |
Definition at line 571 of file newgrf_commons.cpp.
References foreach_draw_tile_seq, MemCpyT(), and DrawTileSprites::seq.
Referenced by Clone(), Clone(), and StationChangeInfo().
|
inline |
Clone a spritelayout.
source | The spritelayout to copy. |
Definition at line 130 of file newgrf_commons.h.
References Clone(), DrawTileSprites::ground, and DrawTileSprites::seq.
void NewGRFSpriteLayout::Clone | ( | const NewGRFSpriteLayout * | source | ) |
Clone a spritelayout.
source | The spritelayout to copy. |
Definition at line 589 of file newgrf_commons.cpp.
References Clone(), foreach_draw_tile_seq, MemCpyT(), and DrawTileSprites::seq.
|
inline |
Returns the result spritelayout after preprocessing.
Definition at line 162 of file newgrf_commons.h.
References DrawTileSprites::ground, and result_seq.
Referenced by DrawStationTile(), and TileLayoutSpriteGroup::ProcessRegisters().
|
inline |
Tests whether this spritelayout needs preprocessing by PrepareLayout() and ProcessRegisters(), or whether it can be used directly.
Definition at line 149 of file newgrf_commons.h.
Referenced by DrawStationTile(), and TileLayoutSpriteGroup::ProcessRegisters().
uint32_t NewGRFSpriteLayout::PrepareLayout | ( | uint32_t | orig_offset, |
uint32_t | newgrf_ground_offset, | ||
uint32_t | newgrf_offset, | ||
uint | constr_stage, | ||
bool | separate_ground | ||
) | const |
Prepares a sprite layout before resolving action-1-2-3 chains.
Integrates offsets into the layout and determines which chains to resolve.
orig_offset | Offset to apply to non-action-1 sprites. |
newgrf_ground_offset | Offset to apply to action-1 ground sprites. |
newgrf_offset | Offset to apply to action-1 non-ground sprites. |
constr_stage | Construction stage (0-3) to apply to all action-1 sprites. |
separate_ground | Whether the ground sprite shall be resolved by a separate action-1-2-3 chain by default. |
Definition at line 645 of file newgrf_commons.cpp.
References DrawTileSeqStruct::delta_x, DrawTileSeqStruct::delta_z, TileLayoutRegisters::flags, foreach_draw_tile_seq, GetConstructionStageOffset(), DrawTileSprites::ground, HasBit(), DrawTileSeqStruct::MakeTerminator(), TileLayoutRegisters::max_palette_offset, TileLayoutRegisters::max_sprite_offset, PalSpriteID::pal, TileLayoutRegisters::palette_var10, result_seq, DrawTileSprites::seq, SetBit(), PalSpriteID::sprite, SPRITE_MODIFIER_CUSTOM_SPRITE, TileLayoutRegisters::sprite_var10, TLF_PALETTE, TLF_PALETTE_REG_FLAGS, TLF_PALETTE_VAR10, TLF_SPRITE, TLF_SPRITE_REG_FLAGS, and TLF_SPRITE_VAR10.
Referenced by DrawStationTile(), and TileLayoutSpriteGroup::ProcessRegisters().
void NewGRFSpriteLayout::ProcessRegisters | ( | uint8_t | resolved_var10, |
uint32_t | resolved_sprite, | ||
bool | separate_ground | ||
) | const |
Evaluates the register modifiers and integrates them into the preprocessed sprite layout.
resolved_var10 | The value of var10 the action-1-2-3 chain was evaluated for. |
resolved_sprite | Result sprite of the action-1-2-3 chain. |
separate_ground | Whether the ground sprite is resolved by a separate action-1-2-3 chain. |
Definition at line 716 of file newgrf_commons.cpp.
References TileLayoutRegisters::child, DrawTileSeqStruct::delta_x, DrawTileSeqStruct::delta_z, TileLayoutRegisters::dodraw, TileLayoutRegisters::flags, foreach_draw_tile_seq, GetRegister(), DrawTileSprites::ground, HasBit(), DrawTileSeqStruct::IsParentSprite(), TileLayoutRegisters::max_palette_offset, TileLayoutRegisters::max_sprite_offset, PalSpriteID::pal, TileLayoutRegisters::palette, TileLayoutRegisters::palette_var10, TileLayoutRegisters::parent, result_seq, PalSpriteID::sprite, TileLayoutRegisters::sprite, SPRITE_MODIFIER_CUSTOM_SPRITE, TileLayoutRegisters::sprite_var10, TLF_BB_XY_OFFSET, TLF_BB_Z_OFFSET, TLF_CHILD_X_OFFSET, TLF_CHILD_Y_OFFSET, TLF_DODRAW, TLF_PALETTE, TLF_PALETTE_REG_FLAGS, TLF_PALETTE_VAR10, TLF_SPRITE, TLF_SPRITE_REG_FLAGS, and TLF_SPRITE_VAR10.
Referenced by DrawStationTile(), and TileLayoutSpriteGroup::ProcessRegisters().
uint NewGRFSpriteLayout::consistent_max_offset |
Number of sprites in all referenced spritesets.
If these numbers are inconsistent, then this is 0 and the real values are in registers
.
Definition at line 119 of file newgrf_commons.h.
Referenced by TileLayoutSpriteGroup::ProcessRegisters(), ReadSpriteLayout(), and StationChangeInfo().
const TileLayoutRegisters* NewGRFSpriteLayout::registers |
Definition at line 113 of file newgrf_commons.h.
|
staticprivate |
Temporary storage when preprocessing spritelayouts.
Definition at line 170 of file newgrf_commons.h.
Referenced by GetLayout(), PrepareLayout(), and ProcessRegisters().