Font.hpp

Go to the documentation of this file.

//
//  CeresEngine - A game development framework
//
//  Created by Rogiel Sulzbach.
//  Copyright (c) 2018-2022 Rogiel Sulzbach. All rights reserved.
//
 
#pragma once
 
#include "Forward.hpp"
 
#include "CeresEngine/DataTypes.hpp"
 
#include "CeresEngine/Foundation/String.hpp"
#include "CeresEngine/Foundation/Container/Map.hpp"
#include "CeresEngine/Foundation/Container/Span.hpp"
#include "CeresEngine/Foundation/Container/Vector.hpp"
#include "CeresEngine/Foundation/IO/FilePath.hpp"
 
#include "CeresEngine/Graphics/BezierPath.hpp"
#include "CeresEngine/Math/Offset.hpp"
#include "CeresEngine/Math/Rect.hpp"
#include "CeresEngine/Resource/Resource.hpp"
#include "CeresEngine/Texture/Texture.hpp"
#include "CeresEngine/Texture/TextureAtlasLayout.hpp"
 
namespace CeresEngine {
 
    using Glyph = UInt32;
 
    enum class FontRenderingMode {
        DefaultRenderingMode,
 
        AntialiasedRenderingMode,
 
        IntegerAdvancementsRenderingMode,
 
        AntialiasedIntegerAdvancementsRenderingMode
    };
 
    struct GlyphProperties {
        UInt32 characterID;
 
        Rect2 bounds;
 
        Offset2 advance;
    };
 
    struct FontProperties {
        String familyName;
        String styleName;
 
        double ascender;
 
        double descender;
        double height;
        double baseline;
 
        HashMap<Glyph, GlyphProperties> glyphs;
        HashMap<char32_t, Glyph> charCodeToGlyph;
    };
 
    using FontSize = double;
 
    class Font : public TResource<Font> {
    private:
        FontSize mSize;
        void* handle;
 
        Vector2 mFontUnitScale;
        FontProperties mProperties;
 
    public:
        Map<Glyph, Rect2> uvMap;
        SPtr<Texture> image;
 
    public:
        Font(const FilePath& fontFile, FontSize size);
        ~Font() override;
 
    public:
        [[nodiscard]] double getPointSize() const;
 
        [[nodiscard]] bool isFixedPitch() const;
 
        [[nodiscard]] UInt32 getNumberOfGlyphs() const;
 
        [[nodiscard]] UInt32 getControlGlyph() const;
 
        [[nodiscard]] UInt32 getNullGlyph() const;
 
        [[nodiscard]] String getDisplayName() const;
 
        [[nodiscard]] String getFamilyName() const;
 
        [[nodiscard]] String getFontName() const;
 
        [[nodiscard]] FontRenderingMode getRenderingMode() const;
 
    public:
        [[nodiscard]] Size2 getAdvancement(Glyph aGlyph) const;
 
        [[nodiscard]] Rect2 getBoundingRect(Glyph aGlyph) const;
 
        [[nodiscard]] Rect2 getUV(Glyph aGlyph) const;
 
        [[nodiscard]] Vector<Size2> getAdvancements(const Span<Glyph>& glyphs) const;
 
        void getAdvancements(const Span<Glyph>& glyphs, TemporaryVector<Size2>& advancements);
 
        [[nodiscard]] Vector<Size2> getPackedAdvancements(const Span<Glyph>& packedGlyphs) const;
 
        void getPackedAdvancements(const Span<Glyph>& packedGlyphs, TemporaryVector<Size2>& packedAdvancements) const;
 
        [[nodiscard]] Vector<Rect2> getBoundingRects(const Span<Glyph>& glyphs) const;
 
        void getBoundingRects(const Span<Glyph>& glyphs, TemporaryVector<Rect2>& boundingRects) const;
 
        [[nodiscard]] Glyph getGlyph(StringView glyphName) const;
 
        [[nodiscard]] BezierPath getPathForGlyph(Glyph glyph) const;
 
    public:
        void prepareCharacterSet(StringView characterSet);
 
        void prepareCharacterSet(StringView characterSet, double pointSize, const AffineTransform& transform);
    };
 
    struct KerningPair {
        UInt32 otherCharId;
        Int32 amount;
    };
 
    struct GlyphDescriptor {
        UInt32 characterID;
 
        UInt32 page;
 
        float uvX, uvY;
 
        float uvWidth, uvHeight;
 
        UInt32 width, height;
 
        float xOffset, yOffset;
 
        float xAdvance, yAdvance;
 
        Vector<KerningPair> kerningPairs;
    };
 
} // namespace CeresEngine