devilutionX/Source/engine/load_cel.hpp

#pragma once

#include <cstdint>

#include "engine/clx_sprite.hpp"
#include "utils/pointer_value_union.hpp"

#ifdef UNPACKED_MPQS
#define DEVILUTIONX_CEL_EXT ".clx"
#else
#define DEVILUTIONX_CEL_EXT ".cel"
#endif

namespace devilution {

OwnedClxSpriteListOrSheet LoadCelListOrSheet(const char *pszName, PointerOrValue<uint16_t> widthOrWidths);

inline OwnedClxSpriteList LoadCel(const char *pszName, uint16_t width)
{
	return LoadCelListOrSheet(pszName, PointerOrValue<uint16_t> { width }).list();
}

inline OwnedClxSpriteList LoadCel(const char *pszName, const uint16_t *widths)
{
	return LoadCelListOrSheet(pszName, PointerOrValue<uint16_t> { widths }).list();
}

inline OwnedClxSpriteSheet LoadCelSheet(const char *pszName, uint16_t width)
{
	return LoadCelListOrSheet(pszName, PointerOrValue<uint16_t> { width }).sheet();
}

} // namespace devilution
🚚 engine.h: Extract `CelSprite` and file loading 5 years ago			`#pragma once`

Use `uint16_t` for sprite widths 4 years ago			`#include <cstdint>`

CLX: A new graphics format The format is almost identical to CL2, except it uses the frame header to store frame width and height instead of 5 32-line offsets. This means we always have access to frame dimensions, so we can use it as an on-disk format for our graphics as well. Additionally, we may be able to optimize the rendering even more in the future now that we have guaranteed knowledge of frame dimensions. 4 years ago			`#include "engine/clx_sprite.hpp"`
			`#include "utils/pointer_value_union.hpp"`
🚚 engine.h: Extract `CelSprite` and file loading 5 years ago
Support unpacked MPQs from devilutionx-mpq-tools https://github.com/diasurgical/devilutionx-mpq-tools produces an unpacked MPQ with all the graphics converted to CLX and the unused files removed. This is primarily useful on RAM-constrained platforms, such as PS2, because it eliminates the MPQ overhead. Adds a build option to load from such unpacked directories instead of the MPQ. These directories are searched for in the same locations where the MPQs would be searched for otherwise. Example directory layout: * /usr/local/share/diasurgical/devilutionx/diabdat/ -- unpacked and converted diabdat.mpq * /usr/local/share/diasurgical/devilutionx/hellfire/ -- unpacked and converted hellfire MPQs (all of them merged into 1 directory) * /usr/local/share/diasurgical/devilutionx/fonts/ -- unpacked fonts.mpq * /usr/local/share/diasurgical/devilutionx/pl/ -- unpacked pl.mpq These directory structure is produced by calling `unpack_and_minify_mpq` 4 years ago			`#ifdef UNPACKED_MPQS`
			`#define DEVILUTIONX_CEL_EXT ".clx"`
			`#else`
			`#define DEVILUTIONX_CEL_EXT ".cel"`
			`#endif`

🚚 engine.h: Extract `CelSprite` and file loading 5 years ago			`namespace devilution {`

CLX: A new graphics format The format is almost identical to CL2, except it uses the frame header to store frame width and height instead of 5 32-line offsets. This means we always have access to frame dimensions, so we can use it as an on-disk format for our graphics as well. Additionally, we may be able to optimize the rendering even more in the future now that we have guaranteed knowledge of frame dimensions. 4 years ago			`OwnedClxSpriteListOrSheet LoadCelListOrSheet(const char *pszName, PointerOrValue<uint16_t> widthOrWidths);`

			`inline OwnedClxSpriteList LoadCel(const char *pszName, uint16_t width)`
			`{`
			`return LoadCelListOrSheet(pszName, PointerOrValue<uint16_t> { width }).list();`
			`}`

			`inline OwnedClxSpriteList LoadCel(const char pszName, const uint16_t widths)`
			`{`
			`return LoadCelListOrSheet(pszName, PointerOrValue<uint16_t> { widths }).list();`
			`}`

			`inline OwnedClxSpriteSheet LoadCelSheet(const char *pszName, uint16_t width)`
			`{`
			`return LoadCelListOrSheet(pszName, PointerOrValue<uint16_t> { width }).sheet();`
			`}`
Load all CEL as CL2 Convert CEL files to CL2 at load time. CL2 format is more efficient and is about as fast to render. CEL vs CL2 sizes, on dLvl 5: https://gist.github.com/glebm/9bbdd76962abcd4fd2405ecd3379af97 Memory: * Peak memory (while loading): -300 KiB * Memory in-game (dLvl5): -700 KiB * RG99 binary size: -15 KiB (1333096 -> 1317192) Performance on rg99: * On average, -1 FPS in town. * Same FPS in dungeon (20 FPS on dLvl 1). 4 years ago
🚚 engine.h: Extract `CelSprite` and file loading 5 years ago			`} // namespace devilution`