PlaneVisuals.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 <filesystem>
#include <string>
#include <vector>
 
#include "Core/Levels/Plane.h"
#include "Core/Math/Rect.h"
#include "HMI/Graphics/ComposedScene.h"
#include "HMI/Graphics/PlaneVisibility.h"
#include "HMI/Graphics/RenderMode.h"

 
namespace hmi {
 
class TextureCache;

inline const std::string PLANES_SUBDIRECTORY = "Plans/";

[[nodiscard]] RenderLayer planeRenderLayer(core::PlaneDepth depth) noexcept;

struct PlaneTexture {
    TextureHandle texture = nullptr;
    int width = 0;
    int height = 0;
};

[[nodiscard]] std::vector<PlaneTexture> resolvePlaneTextures(
    TextureCache& cache, const std::filesystem::path& directory,
    const std::vector<core::Plane>& planes);

struct PlaneParallax {
    bool active = false;
    core::Rect cameraBounds{};
    float pixelsPerWorldUnit = 0.0f;
};

void composePlanes(ComposedScene& scene, const std::vector<core::Plane>& planes,
                   const std::vector<PlaneTexture>& textures, int levelWidth, int levelHeight,
                   RenderMode mode, const PlaneVisibility& visibility = PlaneVisibility{},
                   const PlaneParallax& parallax = PlaneParallax{});

inline constexpr std::size_t PLANE_TEXTURE_BYTES_PER_PIXEL = 4;

[[nodiscard]] std::size_t planeTextureMemoryBytes(const core::Plane& plane, int levelWidth,
                                                  int levelHeight) noexcept;

[[nodiscard]] std::size_t planesTextureMemoryBytes(const std::vector<core::Plane>& planes,
                                                   int levelWidth, int levelHeight) noexcept;
 
}  // namespace hmi