BitmapFont.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Valentin Eloy
// SPDX-License-Identifier: GPL-3.0-or-later
 
#pragma once
 
#include <memory>
#include <string>
#include <string_view>
 
#include "HMI/Graphics/ProceduralFont.h"
#include "HMI/Graphics/RenderLayer.h"
 
class QRhiTexture;

 
namespace hmi {
 
struct RhiContext;

inline const std::string FONTS_SUBDIRECTORY = "Fonts/";

class BitmapFont {
public:
    static constexpr const char* FONT_ASSET_FILE_NAME = "font.png";
    static constexpr const char* FONT_METRICS_FILE_NAME = "font.json";

    explicit BitmapFont(const RhiContext& context);

    [[nodiscard]] TextureHandle textureHandle() const {
        return _texture.get();
    }

    [[nodiscard]] int textureWidth() const noexcept {
        return _textureWidth;
    }

    [[nodiscard]] int textureHeight() const noexcept {
        return _textureHeight;
    }

    [[nodiscard]] const FontMetrics& metrics() const noexcept {
        return _metrics;
    }

    [[nodiscard]] TextExtent measure(std::string_view text, float scale = 1.0f) const {
        return measureText(_metrics, text, scale);
    }
 
private:
    bool loadFromAssets(const RhiContext& context);
    void generateProcedural(const RhiContext& context);
 
    FontMetrics _metrics;
    int _textureWidth = 0;
    int _textureHeight = 0;
    std::shared_ptr<QRhiTexture> _texture;
};
 
}  // namespace hmi