spritecache_internal.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */
 
#ifndef SPRITECACHE_INTERNAL_H
#define SPRITECACHE_INTERNAL_H
 
#include "core/math_func.hpp"
#include "gfx_type.h"
#include "spritecache_type.h"
#include "spriteloader/spriteloader.hpp"
 
#include "table/sprites.h"
 
/* These declarations are internal to spritecache but need to be exposed for unit-tests. */
 
struct SpriteCache {
  std::unique_ptr<std::byte[]> ptr;
  size_t file_pos = 0;
  SpriteFile *file = nullptr; 
  uint32_t length; 
  uint32_t id = 0;
  uint32_t lru = 0;
  SpriteType type = SpriteType::Invalid; 
  bool warned = false; 
  SpriteCacheCtrlFlags control_flags{}; 
 
  void ClearSpriteData();
};
struct SpriteCache {…};
 
inline bool IsMapgenSpriteID(SpriteID sprite)
{
  return IsInsideMM(sprite, SPR_MAPGEN_BEGIN, SPR_MAPGEN_END);
}
 
SpriteCache *AllocateSpriteCache(uint index);
 
#endif /* SPRITECACHE_INTERNAL_H */