OpenTTD Source  20241108-master-g80f628063a
NewGRFSpriteLayout Struct Reference

NewGRF supplied spritelayout. More...

#include <newgrf_commons.h>

Inheritance diagram for NewGRFSpriteLayout:
ZeroedMemoryAllocator DrawTileSprites

Public Member Functions

void Allocate (uint num_sprites)
 Allocate a spritelayout for num_sprites building sprites. More...
 
void AllocateRegisters ()
 Allocate memory for register modifiers.
 
void Clone (const DrawTileSeqStruct *source)
 Clone the building sprites of a spritelayout. More...
 
void Clone (const NewGRFSpriteLayout *source)
 Clone a spritelayout. More...
 
void Clone (const DrawTileSprites *source)
 Clone a spritelayout. More...
 
bool NeedsPreprocessing () const
 Tests whether this spritelayout needs preprocessing by PrepareLayout() and ProcessRegisters(), or whether it can be used directly. More...
 
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. More...
 
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. More...
 
const DrawTileSeqStructGetLayout (PalSpriteID *ground) const
 Returns the result spritelayout after preprocessing. More...
 
- Public Member Functions inherited from ZeroedMemoryAllocator
void * operator new (size_t size)
 Memory allocator for a single class instance. More...
 
void * operator new[] (size_t size)
 Memory allocator for an array of class instances. More...
 
void operator delete (void *ptr)
 Memory release for a single class instance. More...
 
void operator delete[] (void *ptr)
 Memory release for an array of class instances. More...
 

Data Fields

const TileLayoutRegistersregisters
 
uint consistent_max_offset
 Number of sprites in all referenced spritesets. More...
 
- Data Fields inherited from DrawTileSprites
PalSpriteID ground
 Palette and sprite for the ground.
 
const DrawTileSeqStructseq
 Array of child sprites. Terminated with a terminator entry.
 

Static Private Attributes

static std::vector< DrawTileSeqStructresult_seq
 Temporary storage when preprocessing spritelayouts.
 

Detailed Description

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.

Member Function Documentation

◆ Allocate()

void NewGRFSpriteLayout::Allocate ( uint  num_sprites)

Allocate a spritelayout for num_sprites building sprites.

Parameters
num_spritesNumber 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().

◆ Clone() [1/3]

void NewGRFSpriteLayout::Clone ( const DrawTileSeqStruct source)

Clone the building sprites of a spritelayout.

Parameters
sourceThe 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() [2/3]

void NewGRFSpriteLayout::Clone ( const DrawTileSprites source)
inline

Clone a spritelayout.

Parameters
sourceThe spritelayout to copy.

Definition at line 130 of file newgrf_commons.h.

References Clone(), DrawTileSprites::ground, and DrawTileSprites::seq.

◆ Clone() [3/3]

void NewGRFSpriteLayout::Clone ( const NewGRFSpriteLayout source)

Clone a spritelayout.

Parameters
sourceThe spritelayout to copy.

Definition at line 589 of file newgrf_commons.cpp.

References Clone(), foreach_draw_tile_seq, MemCpyT(), and DrawTileSprites::seq.

◆ GetLayout()

const DrawTileSeqStruct* NewGRFSpriteLayout::GetLayout ( PalSpriteID ground) const
inline

Returns the result spritelayout after preprocessing.

Precondition
PrepareLayout() and ProcessRegisters() need calling first.
Returns
result spritelayout

Definition at line 162 of file newgrf_commons.h.

References DrawTileSprites::ground, and result_seq.

◆ NeedsPreprocessing()

bool NewGRFSpriteLayout::NeedsPreprocessing ( ) const
inline

Tests whether this spritelayout needs preprocessing by PrepareLayout() and ProcessRegisters(), or whether it can be used directly.

Returns
true if preprocessing is needed

Definition at line 149 of file newgrf_commons.h.

Referenced by TileLayoutSpriteGroup::ProcessRegisters().

◆ PrepareLayout()

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.

Note
The function uses statically allocated temporary storage, which is reused every time when calling the function. That means, you have to use the sprite layout before calling PrepareLayout() the next time.
Parameters
orig_offsetOffset to apply to non-action-1 sprites.
newgrf_ground_offsetOffset to apply to action-1 ground sprites.
newgrf_offsetOffset to apply to action-1 non-ground sprites.
constr_stageConstruction stage (0-3) to apply to all action-1 sprites.
separate_groundWhether the ground sprite shall be resolved by a separate action-1-2-3 chain by default.
Returns
Bitmask of values for variable 10 to resolve action-1-2-3 chains for.

Definition at line 645 of file newgrf_commons.cpp.

References result_seq.

◆ 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.

Precondition
PrepareLayout() needs calling first.
Parameters
resolved_var10The value of var10 the action-1-2-3 chain was evaluated for.
resolved_spriteResult sprite of the action-1-2-3 chain.
separate_groundWhether the ground sprite is resolved by a separate action-1-2-3 chain.
Returns
Resulting spritelayout after processing the registers.

Definition at line 716 of file newgrf_commons.cpp.

Field Documentation

◆ consistent_max_offset

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().


The documentation for this struct was generated from the following files: