OpenTTD Source: src/spritecache_internal.h Source File

OpenTTD Source 15.0-RC2

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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
10#ifndef SPRITECACHE_INTERNAL_H
11#define SPRITECACHE_INTERNAL_H
12
13#include "core/math_func.hpp"
14#include "gfx_type.h"
15#include "spritecache_type.h"
16#include "spriteloader/sprite_file_type.hpp"
17
18#include "table/sprites.h"
19
20/* These declarations are internal to spritecache but need to be exposed for unit-tests. */
21
22 struct SpriteCache {
23 std::unique_ptr<std::byte[]> ptr;
24 size_t file_pos = 0;
25 SpriteFile *file = nullptr;
26 uint32_t length;
27 uint32_t id = 0;
28 uint32_t lru = 0;
29 SpriteType type = SpriteType::Invalid;
30 bool warned = false;
31 SpriteCacheCtrlFlags control_flags{};
32
33 void ClearSpriteData();
34};
35
36inline bool IsMapgenSpriteID(SpriteID sprite)
37{
38 return IsInsideMM(sprite, SPR_MAPGEN_BEGIN, SPR_MAPGEN_END);
39}
40
41 SpriteCache *AllocateSpriteCache(uint index);
42
43#endif /* SPRITECACHE_INTERNAL_H */
EnumBitSet< SpriteCacheCtrlFlag, uint8_t >
SpriteFile
RandomAccessFile with some extra information specific for sprite files.
Definition sprite_file_type.hpp:19
gfx_type.h
Types related to the graphics and/or input devices.
SpriteID
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition gfx_type.h:17
SpriteType
SpriteType
Types of sprites that might be loaded.
Definition gfx_type.h:357
SpriteType::Invalid
@ Invalid
Pseudosprite or other unusable sprite, used only internally.
math_func.hpp
Integer math functions.
IsInsideMM
constexpr bool IsInsideMM(const size_t x, const size_t min, const size_t max) noexcept
Checks if a value is in an interval.
Definition math_func.hpp:267
sprite_file_type.hpp
Random Access File specialised for accessing sprites.
spritecache_type.h
Types related to the sprite cache.
sprites.h
This file contains all sprite-related enums and defines.
SpriteCache
Definition spritecache_internal.h:22
SpriteCache::length
uint32_t length
Length of sprite data.
Definition spritecache_internal.h:26
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
SpriteCacheCtrlFlags control_flags
Control flags, see SpriteCacheCtrlFlags.
Definition spritecache_internal.h:31
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
SpriteCache::file
SpriteFile * file
The file the sprite in this entry can be found in.
Definition spritecache_internal.h:25