OpenTTD Source  20241121-master-g67a0fccfad
TileLayoutSpriteGroup Struct Reference

Action 2 sprite layout for houses, industry tiles, objects and airport tiles. More...

#include <newgrf_spritegroup.h>

Inheritance diagram for TileLayoutSpriteGroup:
SpriteGroup Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_spritegroup_pool >

Public Member Functions

const DrawTileSpritesProcessRegisters (uint8_t *stage) const
 Process registers and the construction stage into the sprite layout. More...
 
- Public Member Functions inherited from SpriteGroup
virtual SpriteID GetResult () const
 
virtual uint8_t GetNumResults () const
 
virtual uint16_t GetCallbackResult () const
 
- Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_spritegroup_pool >
void * operator new (size_t size)
 Allocates space for new Titem. More...
 
void * operator new (size_t size, size_t index)
 Allocates space for new Titem with given index. More...
 
void * operator new (size_t, void *ptr)
 Allocates space for new Titem at given memory address. More...
 
void operator delete (void *p)
 Marks Titem as free. More...
 

Data Fields

NewGRFSpriteLayout dts
 
- Data Fields inherited from SpriteGroup
uint32_t nfo_line
 
SpriteGroupType type
 
- Data Fields inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_spritegroup_pool >
Tindex index
 Index of this pool item.
 

Additional Inherited Members

- Public Types inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_spritegroup_pool >
typedef struct Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero > Pool
 Type of the pool this item is going to be part of.
 
- Static Public Member Functions inherited from SpriteGroup
static const SpriteGroupResolve (const SpriteGroup *group, ResolverObject &object, bool top_level=true)
 ResolverObject (re)entry point. More...
 
- Static Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_spritegroup_pool >
static bool CanAllocateItem (size_t n=1)
 Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function() More...
 
static bool CleaningPool ()
 Returns current state of pool cleaning - yes or no. More...
 
static bool IsValidID (size_t index)
 Tests whether given index can be used to get valid (non-nullptr) Titem. More...
 
static Titem * Get (size_t index)
 Returns Titem with given index. More...
 
static Titem * GetIfValid (size_t index)
 Returns Titem with given index. More...
 
static size_t GetPoolSize ()
 Returns first unused index. More...
 
static size_t GetNumItems ()
 Returns number of valid items in the pool. More...
 
static void PostDestructor ([[maybe_unused]] size_t index)
 Dummy function called after destructor of each member. More...
 
static Pool::IterateWrapper< Titem > Iterate (size_t from=0)
 Returns an iterable ensemble of all valid Titem. More...
 
- Protected Member Functions inherited from SpriteGroup
 SpriteGroup (SpriteGroupType type)
 
virtual const SpriteGroupResolve ([[maybe_unused]] ResolverObject &object) const
 Base sprite group resolver.
 

Detailed Description

Action 2 sprite layout for houses, industry tiles, objects and airport tiles.

Definition at line 260 of file newgrf_spritegroup.h.

Member Function Documentation

◆ ProcessRegisters()

const DrawTileSprites * TileLayoutSpriteGroup::ProcessRegisters ( uint8_t *  stage) const

Process registers and the construction stage into the sprite layout.

The passed construction stage might get reset to zero, if it gets incorporated into the layout during the preprocessing.

Parameters
[in,out]stageConstruction stage (0-3), or nullptr if not applicable.
Returns
sprite layout to draw.

Definition at line 289 of file newgrf_spritegroup.cpp.

References NewGRFSpriteLayout::consistent_max_offset, GetConstructionStageOffset(), and NewGRFSpriteLayout::NeedsPreprocessing().

Referenced by DrawTileLayout().


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