OpenTTD Source  20241121-master-g67a0fccfad
spritecache_internal.h
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 #ifndef SPRITECACHE_INTERNAL_H
11 #define SPRITECACHE_INTERNAL_H
12 
13 #include "stdafx.h"
14 
15 #include "core/math_func.hpp"
16 #include "gfx_type.h"
18 
19 #include "table/sprites.h"
20 
21 /* These declarations are internal to spritecache but need to be exposed for unit-tests. */
22 
23 struct SpriteCache {
24  void *ptr;
25  size_t file_pos;
27  uint32_t id;
28  int16_t lru;
30  bool warned;
31  uint8_t control_flags;
32 };
33 
36 protected:
37  void *AllocatePtr(size_t size) override;
38 };
39 
40 inline bool IsMapgenSpriteID(SpriteID sprite)
41 {
42  return IsInsideMM(sprite, SPR_MAPGEN_BEGIN, SPR_MAPGEN_END);
43 }
44 
45 SpriteCache *AllocateSpriteCache(uint index);
46 
47 #endif /* SPRITECACHE_INTERNAL_H */
SpriteAllocator that allocates memory from the sprite cache.
void * AllocatePtr(size_t size) override
Allocate memory for a sprite.
Interface for something that can allocate memory for a sprite.
RandomAccessFile with some extra information specific for sprite files.
Types related to the graphics and/or input devices.
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:18
SpriteType
Types of sprites that might be loaded.
Definition: gfx_type.h:312
Integer math functions.
constexpr bool IsInsideMM(const T x, const size_t min, const size_t max) noexcept
Checks if a value is in an interval.
Definition: math_func.hpp:268
Base for loading sprites.
This file contains all sprite-related enums and defines.
Definition of base types and functions in a cross-platform compatible way.
uint8_t control_flags
Control flags, see SpriteCacheCtrlFlags.
bool warned
True iff the user has been warned about incorrect use of this sprite.
SpriteType type
In some cases a single sprite is misused by two NewGRFs. Once as real sprite and once as recolour spr...
SpriteFile * file
The file the sprite in this entry can be found in.