documentation/3.0.0/Font_8hpp_source

//

// SFML - Simple and Fast Multimedia Library

// Copyright (C) 2007-2024 Laurent Gomila (laurent@sfml-dev.org)

//

// This software is provided 'as-is', without any express or implied warranty.

// In no event will the authors be held liable for any damages arising from the use of this software.

//

// Permission is granted to anyone to use this software for any purpose,

// including commercial applications, and to alter it and redistribute it freely,

// subject to the following restrictions:

//

// 1. The origin of this software must not be misrepresented;

//    you must not claim that you wrote the original software.

//    If you use this software in a product, an acknowledgment

//    in the product documentation would be appreciated but is not required.

//

// 2. Altered source versions must be plainly marked as such,

//    and must not be misrepresented as being the original software.

//

// 3. This notice may not be removed or altered from any source distribution.

//


#pragma once


// Headers

#include <SFML/Graphics/Export.hpp>


#include <SFML/Graphics/Glyph.hpp>

#include <SFML/Graphics/Rect.hpp>

#include <SFML/Graphics/Texture.hpp>


#include <SFML/System/Vector2.hpp>


#include <filesystem>

#include <memory>

#include <string>

#include <unordered_map>

#include <vector>


#include <cstddef>

#include <cstdint>


#ifdef SFML_SYSTEM_ANDROID

namespace sf::priv

{

class ResourceStream;

}

#endif


namespace sf

{

class InputStream;


class SFML_GRAPHICS_API Font

{

public:


    struct Info

    {

        std::string family;

    };


    Font() = default;


    explicit Font(const std::filesystem::path& filename);


    Font(const void* data, std::size_t sizeInBytes);


    explicit Font(InputStream& stream);


    [[nodiscard]] bool openFromFile(const std::filesystem::path& filename);


    [[nodiscard]] bool openFromMemory(const void* data, std::size_t sizeInBytes);


    [[nodiscard]] bool openFromStream(InputStream& stream);


    [[nodiscard]] const Info& getInfo() const;


    [[nodiscard]] const Glyph& getGlyph(char32_t codePoint, unsigned int characterSize, bool bold, float outlineThickness = 0) const;


    [[nodiscard]] bool hasGlyph(char32_t codePoint) const;


    [[nodiscard]] float getKerning(std::uint32_t first, std::uint32_t second, unsigned int characterSize, bool bold = false) const;


    [[nodiscard]] float getLineSpacing(unsigned int characterSize) const;


    [[nodiscard]] float getUnderlinePosition(unsigned int characterSize) const;


    [[nodiscard]] float getUnderlineThickness(unsigned int characterSize) const;


    [[nodiscard]] const Texture& getTexture(unsigned int characterSize) const;


    void setSmooth(bool smooth);


    [[nodiscard]] bool isSmooth() const;


private:

    struct Row

    {

        Row(unsigned int rowTop, unsigned int rowHeight) : top(rowTop), height(rowHeight)

        {

        }


        unsigned int width{};

        unsigned int top;

        unsigned int height;

    };


    // Types

    using GlyphTable = std::unordered_map<std::uint64_t, Glyph>;


    struct Page

    {

        explicit Page(bool smooth);


        GlyphTable       glyphs;

        Texture          texture;

        unsigned int     nextRow{3};

        std::vector<Row> rows;

    };


    void cleanup();


    Page& loadPage(unsigned int characterSize) const;


    Glyph loadGlyph(char32_t codePoint, unsigned int characterSize, bool bold, float outlineThickness) const;


    IntRect findGlyphRect(Page& page, Vector2u size) const;


    [[nodiscard]] bool setCurrentSize(unsigned int characterSize) const;


    // Types

    struct FontHandles;

    using PageTable = std::unordered_map<unsigned int, Page>;


    // Member data

    std::shared_ptr<FontHandles> m_fontHandles;

    bool                         m_isSmooth{true};

    Info                         m_info;

    mutable PageTable            m_pages;

    mutable std::vector<std::uint8_t> m_pixelBuffer;

#ifdef SFML_SYSTEM_ANDROID

    std::shared_ptr<priv::ResourceStream> m_stream;

#endif

};


} // namespace sf


Glyph.hpp

Export.hpp

SFML_GRAPHICS_API
#define SFML_GRAPHICS_API
Definition Graphics/Export.hpp:42

Rect.hpp

Texture.hpp

Vector2.hpp

sf::Font::openFromMemory
bool openFromMemory(const void *data, std::size_t sizeInBytes)
Open the font from a file in memory.

sf::Font::getLineSpacing
float getLineSpacing(unsigned int characterSize) const
Get the line spacing.

sf::Font::getTexture
const Texture & getTexture(unsigned int characterSize) const
Retrieve the texture containing the loaded glyphs of a certain size.

sf::Font::Font
Font(InputStream &stream)
Construct the font from a custom stream.

sf::Font::getUnderlinePosition
float getUnderlinePosition(unsigned int characterSize) const
Get the position of the underline.

sf::Font::Font
Font(const std::filesystem::path &filename)
Construct the font from a file.

sf::Font::setSmooth
void setSmooth(bool smooth)
Enable or disable the smooth filter.

sf::Font::Font
Font(const void *data, std::size_t sizeInBytes)
Construct the font from a file in memory.

sf::Font::getInfo
const Info & getInfo() const
Get the font information.

sf::Font::getGlyph
const Glyph & getGlyph(char32_t codePoint, unsigned int characterSize, bool bold, float outlineThickness=0) const
Retrieve a glyph of the font.

sf::Font::getKerning
float getKerning(std::uint32_t first, std::uint32_t second, unsigned int characterSize, bool bold=false) const
Get the kerning offset of two glyphs.

sf::Font::openFromStream
bool openFromStream(InputStream &stream)
Open the font from a custom stream.

sf::Font::getUnderlineThickness
float getUnderlineThickness(unsigned int characterSize) const
Get the thickness of the underline.

sf::Font::isSmooth
bool isSmooth() const
Tell whether the smooth filter is enabled or not.

sf::Font::Font
Font()=default
Default constructor.

sf::Font::openFromFile
bool openFromFile(const std::filesystem::path &filename)
Open the font from a file.

sf::Font::hasGlyph
bool hasGlyph(char32_t codePoint) const
Determine if this font has a glyph representing the requested code point.

sf::InputStream
Abstract class for custom file input streams.
Definition InputStream.hpp:46

sf::Texture
Image living on the graphics card that can be used for drawing.
Definition Texture.hpp:56

sf
Definition AudioResource.hpp:36

sf::IntRect
Rect< int > IntRect
Definition Rect.hpp:146

sf::Font::Info
Holds various information about a font.
Definition Font.hpp:71

sf::Font::Info::family
std::string family
The font family.
Definition Font.hpp:72

sf::Glyph
Structure describing a glyph.
Definition Glyph.hpp:42