font.h

Go to the documentation of this file.

 
 
#pragma once
 
#include <scimesh/types.h>
 
#include <cstdint>
#include <memory>
#include <string>
#include <vector>
 
namespace scimesh {
 
struct FontMetrics {
    float ascent = 0.0f;
 
    float descent = 0.0f;
 
    float line_gap = 0.0f;
 
    float line_height() const { return ascent + descent + line_gap; }
 
    float box_height() const { return ascent + descent; }
};
 
struct GlyphBitmap {
    int width = 0;
 
    int height = 0;
 
    int x_offset = 0;
 
    int y_offset = 0;
 
    float advance = 0.0f;
 
    std::vector<uint8_t> coverage;
 
    bool empty() const { return width <= 0 || height <= 0 || coverage.empty(); }
 
    uint8_t at(int x, int y) const {
        return coverage[static_cast<size_t>(y) * static_cast<size_t>(width) +
                        static_cast<size_t>(x)];
    }
};
 
class Font {
public:
    Font() = default;
 
    static Font from_file(const std::string &path, float pixel_size);
 
    static Font from_memory(std::vector<uint8_t> data, float pixel_size);
 
    bool valid() const { return static_cast<bool>(impl_); }
 
    float pixel_size() const;
 
    std::string source_path() const;
 
    FontMetrics metrics() const;
 
    float measure(const std::string &text) const;
 
    float advance(uint32_t codepoint) const;
 
    float kerning(uint32_t first, uint32_t second) const;
 
    const GlyphBitmap *glyph(uint32_t codepoint) const;
 
    std::string family_name() const;
 
    Font with_pixel_size(float new_pixel_size) const;
 
    static std::vector<uint32_t> decode_utf8(const std::string &text);
 
    static size_t line_count(const std::string &text);
 
private:
    struct Impl;
 
    explicit Font(std::shared_ptr<Impl> impl) : impl_(std::move(impl)) {}
 
    std::shared_ptr<Impl> impl_;
};
 
std::string resolve_font_path(const std::string &path);
 
std::string default_font_path();
 
Font cached_font(const std::string &path, float pixel_size);
 
void clear_font_cache();
 
} // namespace scimesh