You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
58 lines
2.2 KiB
C++
58 lines
2.2 KiB
C++
/*
|
|
* 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/>.
|
|
*/
|
|
|
|
/** @file sprite_file_type.hpp Random Access File specialised for accessing sprites. */
|
|
|
|
#ifndef SPRITE_FILE_TYPE_HPP
|
|
#define SPRITE_FILE_TYPE_HPP
|
|
|
|
#include "../random_access_file_type.h"
|
|
|
|
enum SpriteFileFlags : uint8_t {
|
|
SFF_NONE = 0,
|
|
SFF_USERGRF = 1 << 0,
|
|
SFF_PROGSIG = 1 << 1,
|
|
SFF_OPENTTDGRF = 1 << 2,
|
|
};
|
|
DECLARE_ENUM_AS_BIT_SET(SpriteFileFlags)
|
|
|
|
/**
|
|
* RandomAccessFile with some extra information specific for sprite files.
|
|
* It automatically detects and stores the container version upload opening the file.
|
|
*/
|
|
class SpriteFile : public RandomAccessFile {
|
|
size_t content_begin; ///< The begin of the content of the sprite file, i.e. after the container metadata.
|
|
bool palette_remap; ///< Whether or not a remap of the palette is required for this file.
|
|
uint8_t container_version; ///< Container format of the sprite file.
|
|
|
|
public:
|
|
SpriteFileFlags flags = SFF_NONE;
|
|
|
|
SpriteFile(const std::string &filename, Subdirectory subdir, bool palette_remap);
|
|
SpriteFile(const SpriteFile&) = delete;
|
|
void operator=(const SpriteFile&) = delete;
|
|
|
|
/**
|
|
* Whether a palette remap is needed when loading sprites from this file.
|
|
* @return True when needed, otherwise false.
|
|
*/
|
|
bool NeedsPaletteRemap() const { return this->palette_remap; }
|
|
|
|
/**
|
|
* Get the version number of container type used by the file.
|
|
* @return The version.
|
|
*/
|
|
uint8_t GetContainerVersion() const { return this->container_version; }
|
|
|
|
/**
|
|
* Seek to the begin of the content, i.e. the position just after the container version has been determined.
|
|
*/
|
|
void SeekToBegin() { this->SeekTo(this->content_begin, SEEK_SET); }
|
|
};
|
|
|
|
#endif /* SPRITE_FILE_TYPE_HPP */
|