AssetContract.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Valentin Eloy
// SPDX-License-Identifier: GPL-3.0-or-later
 
#pragma once
 
#include <string>

 
namespace hmi {

enum class AssetFamily {
    Atlas,
    TileSkin,
    AutotileSheet,
    Background,
    Object,
    CharacterSheet,
    Font,
};

struct AssetDimensionContract {
    int exactWidth = 0;
    int exactHeight = 0;
    bool multipleOfTileSize = false;
    int minimumTiles = 1;
};

struct AssetValidation {
    bool valid = false;
    std::string message;
};

[[nodiscard]] const char* assetFamilyName(AssetFamily family) noexcept;

[[nodiscard]] AssetDimensionContract assetDimensionContract(AssetFamily family) noexcept;

[[nodiscard]] std::string describeContract(const AssetDimensionContract& contract);

[[nodiscard]] AssetValidation validateAsset(AssetFamily family, const std::string& fileName,
                                            int width, int height);
 
}  // namespace hmi