OpenTTD Source  20240919-master-gdf0233f4c2
mock_spritecache.cpp
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6  */
7 
10 #include "../stdafx.h"
11 
12 #include "../blitter/factory.hpp"
13 #include "../core/math_func.hpp"
14 #include "../spritecache.h"
15 #include "../spritecache_internal.h"
16 #include "../table/sprites.h"
17 
18 static bool MockLoadNextSprite(int load_index)
19 {
20  SimpleSpriteAllocator allocator;
21  static Sprite *sprite = allocator.Allocate<Sprite>(sizeof(*sprite));
22 
23  bool is_mapgen = IsMapgenSpriteID(load_index);
24 
25  SpriteCache *sc = AllocateSpriteCache(load_index);
26  sc->file = nullptr;
27  sc->file_pos = 0;
28  sc->ptr = sprite;
29  sc->lru = 0;
30  sc->id = 0;
31  sc->type = is_mapgen ? SpriteType::MapGen : SpriteType::Normal;
32  sc->warned = false;
33  sc->control_flags = 0;
34 
35  /* Fill with empty sprites up until the default sprite count. */
36  return (uint)load_index < SPR_OPENTTD_BASE + OPENTTD_SPRITE_COUNT;
37 }
38 
39 void MockGfxLoadSprites()
40 {
41  /* Force blitter 'null'. This is necessary for GfxInitSpriteMem() to function. */
43 
44  GfxInitSpriteMem();
45 
46  int load_index = 0;
47  while (MockLoadNextSprite(load_index)) {
48  load_index++;
49  }
50 }
SpriteType::Normal
@ Normal
The most basic (normal) sprite.
SimpleSpriteAllocator
SpriteAllocate that uses malloc to allocate memory.
Definition: spritecache.h:35
SpriteCache::warned
bool warned
True iff the user has been warned about incorrect use of this sprite.
Definition: spritecache_internal.h:30
SpriteCache::control_flags
uint8_t control_flags
Control flags, see SpriteCacheCtrlFlags.
Definition: spritecache_internal.h:31
SpriteType::MapGen
@ MapGen
Special sprite for the map generator.
SpriteCache::file
SpriteFile * file
The file the sprite in this entry can be found in.
Definition: spritecache_internal.h:26
SpriteAllocator::Allocate
T * Allocate(size_t size)
Allocate memory for a sprite.
Definition: spriteloader.hpp:99
SpriteCache
Definition: spritecache_internal.h:23
BlitterFactory::SelectBlitter
static Blitter * SelectBlitter(const std::string_view name)
Find the requested blitter and return its class.
Definition: factory.hpp:96
SpriteCache::type
SpriteType type
In some cases a single sprite is misused by two NewGRFs. Once as real sprite and once as recolour spr...
Definition: spritecache_internal.h:29
SPR_OPENTTD_BASE
static const SpriteID SPR_OPENTTD_BASE
Extra graphic spritenumbers.
Definition: sprites.h:56
Sprite
Data structure describing a sprite.
Definition: spritecache.h:17