Plane.h

Go to the documentation of this file.

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

 
namespace core {

enum class PlaneDepth {
    Behind,
    Front,
};

struct Plane {
    std::string fileName;
    int pixelsPerUnit = 16;
    float parallaxX = 1.0f;
    float parallaxY = 1.0f;
    float opacity = 1.0f;
    PlaneDepth depth = PlaneDepth::Behind;
};

inline constexpr int PLANE_NATIVE_PIXELS_PER_UNIT = 16;

[[nodiscard]] constexpr bool isValidPlaneDensity(int pixelsPerUnit) noexcept {
    return pixelsPerUnit == 4 || pixelsPerUnit == 8 ||
           pixelsPerUnit == PLANE_NATIVE_PIXELS_PER_UNIT;
}

inline constexpr std::size_t MAX_PLANES_PER_LEVEL = 16;

inline constexpr int MAX_PLANE_TEXTURE_EXTENT = 16384;
 
}  // namespace core