PlaneFileNaming.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>
#include <vector>

 
namespace hmi {

inline const std::string PLANE_FILE_EXTENSION = ".png";

struct PlanePixelSize {
    int width = 0;
    int height = 0;
 
    [[nodiscard]] friend bool operator==(const PlanePixelSize&,
                                         const PlanePixelSize&) noexcept = default;
};

[[nodiscard]] PlanePixelSize planePixelSize(int widthUnits, int heightUnits,
                                            int pixelsPerUnit) noexcept;

[[nodiscard]] std::string uniquePlaneFileName(const std::string& levelName,
                                              const std::vector<std::string>& existing);

[[nodiscard]] std::string sanitizePlaneBaseName(const std::string& name);
 
}  // namespace hmi