RenderLayer.h

Go to the documentation of this file.

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

 
namespace hmi {

enum class RenderLayer : std::int32_t {
    Background = 0,
    Plane,
    Shadow,
    Tile,
    Object,
    Player,
    Foreground,
    UI,
    EditorOverlay,
};

[[nodiscard]] constexpr bool sortsByDepth(RenderLayer layer) noexcept {
    return layer == RenderLayer::Object || layer == RenderLayer::Player;
}

[[nodiscard]] constexpr std::int32_t renderBand(RenderLayer layer) noexcept {
    return static_cast<std::int32_t>(sortsByDepth(layer) ? RenderLayer::Object : layer);
}

using TextureHandle = void*;

struct RenderLayerTag {
    RenderLayer value = RenderLayer::Tile;
};

inline constexpr RenderLayer DEFAULT_RENDER_LAYER = RenderLayer::Tile;

[[nodiscard]] constexpr const char* renderLayerName(RenderLayer layer) noexcept {
    switch (layer) {
        case RenderLayer::Background:
            return "Background";
        case RenderLayer::Plane:
            return "Plane";
        case RenderLayer::Shadow:
            return "Shadow";
        case RenderLayer::Tile:
            return "Tile";
        case RenderLayer::Object:
            return "Object";
        case RenderLayer::Player:
            return "Player";
        case RenderLayer::Foreground:
            return "Foreground";
        case RenderLayer::UI:
            return "UI";
        case RenderLayer::EditorOverlay:
            return "EditorOverlay";
    }
    return "Inconnu";
}
 
}  // namespace hmi