Trex API Documentation

Font

Used internally by Atlas to load a font file and generate a bitmap.

Font::Font

Font::Font(const char* path);
Font::Font(std::span<const uint8_t> data);

path - Path to the font file.
data - Font file data. This span should represent contiguous array of bytes.

Note: data is copied into the font object. It is safe to destroy the original data after the font is created.

Font::SetSize

using FontSize = std::variant<Pixels, Points>;

void Font::SetSize(const FontSize& size);

Change font size. The default font size after loading is 12pt.

size - Size of the font in pixels or points.

Note: After the atlas is generated, the font size must not be changed.

Font::GetGlyphIndex

uint32_t Font::GetGlyphIndex(uint32_t codepoint) const;

Get the glyph index of a codepoint. Returns 0 if the codepoint is not supported by the font.

codepoint - Unicode codepoint.

Font::GetMetrics

FontMetrics Font::GetMetrics() const;

Get the font metrics. See: FontMetrics.

FontMetrics

Represents the metrics of a font.

struct FontMetrics
{
    int ascender;
    int descender;
    int height;
};

ascender - Max distance (in pixels) from baseline to top of a glyph (positive value)
descender - Max distance (in pixels) from baseline to the bottom of a glyph (negative value)
height - Distance (in pixels) from one baseline to the next.

These values are always scaled according to the font size and they are rounded to the nearest integer.

Charset

Represents a set of supported codepoints.

Charset::Charset

using Range = std::pair<uint32_t, uint32_t>;

explicit Charset(); // empty charset
explicit Charset(uint32_t first, uint32_t last);
explicit Charset(const std::vector<Range> codepointRanges);
explicit Charset(std::span<const Range> codepointRanges);

first - First codepoint in the range.
last - Last codepoint in the range.
codepointRanges - An array of pairs first and last.

Charset::Full

static Charset Charset::Full();

Returns a charset containing all possible codepoints.

Note: Charset does not know what codepoints are supported by the font. So it is impossible to count the number of supported codepoints. It will be determined during the atlas generation for the given font.

Charset::Ascii

static Charset Charset::Ascii();

Returns a charset containing ASCII codepoints (0-127).

Charset::Size

size_t Charset::Size() const;

Returns the number of codepoints in the charset.

Charset::Codepoints

const std::set<uint32_t>& Charset::Codepoints() const;

Returns a vector of codepoints in the charset.

Note: If the charset is marked as "full", the vector will be empty because it is impossible to list all possible codepoints without knowing the font.

Charset::IsFull

bool Charset::IsFull() const;

Returns true if the charset contains all possible codepoints.

Charset::begin/end

This struct is iterable and thus can be used in range-based for loops. It iterates over all codepoints in the charset.

Glyph

Represents a glyph in the atlas.

struct Glyph
{
    int codepoint;
    int glyphIndex;
    int x, y;
    int width, height,
    int bearingX, bearingY;
};

codepoint - Unicode codepoint.
glyphIndex - Glyph index in the font.
x - X coordinate of the glyph in the atlas.
y - Y coordinate of the glyph in the atlas.
width - Width of the glyph in the atlas.
height - Height of the glyph in the atlas.
bearingX - Horizontal bearing of the glyph.
bearingY - Vertical bearing of the glyph.

RenderMode

Specifies how the text should be rendered.

enum class RenderMode
{
    DEFAULT,
    COLOR,
    SDF,
    LCD
};

DEFAULT - Rasterize the text with the default, grayscale FreeType renderer. The bitmap will have 1-byte color channel.
COLOR - Rasterize the text with colors if the font supports it. The bitmap will have 4-byte color channels in RGBA format.
SDF - rasterize the text with the SDF renderer. You will need a fragment shader to display the text properly. The bitmap will have 1-byte color channel.
LCD - rasterize the text with the subpixel renderer. The bitmap will have 3 color channels and the bitmap will be in RGB format.

Atlas

Represents aa atlas of glyphs.

Atlas::Atlas

Atlas(const std::string& fontPath, int fontSize, const Charset&, RenderMode, int padding);
Atlas(std::span<const uint8_t> fontData, int fontSize, const Charset&, RenderMode, int padding);

fontPath - Path to the font file.
fontSize - Size of the font in pixels.
charset - Charset of the atlas. Default is Full. See: Charset.
renderMode - Render mode of the atlas. Default is DEFAULT. See: RenderMode.
padding - Padding between glyphs in the atlas. Default is 1.
fontData - Font file data. This span should represent contiguous array of bytes.

Note: Charset and fontData are copied and then owned by the atlas. They can be safely destroyed after the atlas is created.

Atlas::GetBitmap

const Atlas::Bitmap& Atlas::GetBitmap() const;

Get the atlas bitmap. See: Atlas::Bitmap.

Atlas::GetGlyphs

const Atlas::Glyphs& Atlas::GetGlyphs() const;

Get all glyphs data. See: Atlas::Glyphs.
Note: If you use TextShaper to shape text, you don't need to use this function. All needed glyph data is already stored in the ShapedGlyph::info.

Atlas::GetFont

const shared_ptr<const Font> Atlas::GetFontFace() const;

Get the Font object.

Note: You should never use the Font::face without making sure that the Font object is still alive.

Atlas::SaveToFile

void Atlas::SaveToFile(const std::string& path) const;

Save the atlas bitmap to a PNG or BMP file.

path - Path to the file. The file extension determines the format. It must be one of: .png, .bmp.

Atlas::Glyphs

Represents all rendered glyphs in the atlas.

Atlas::Glyphs::SetUnknownGlyph

void Atlas::Glyphs::SetUnknownGlyph(uint32_t codepoint) const;

Set the unknown glyph to be used when a glyph is not found in the atlas.

codepoint - Unicode codepoint. If the codepoint is not found in the atlas, the function does nothing.

If the unknown glyph is not set, the atlas will try to set it to some sensible value.

Atlas::Glyphs::GetUnknownGlyph

const Glyph& Atlas::Glyphs::GetUnknownGlyph() const;

Get the unknown glyph.

Atlas::Glyphs::GetGlyphByCodepoint

const Glyph& Atlas::Glyphs::GetGlyphByCodepoint(uint32_t codepoint) const;

Get a Glyph by its codepoint. If the glyph is not found, the default glyph is returned.

codepoint - Unicode codepoint.

Atlas::Glyphs::GetGlyphByIndex

const Glyph& Atlas::Glyphs::GetGlyphByIndex(uint32_t glyphIndex) const;

Get a Glyph by its glyph index. If the glyph is not found, the default glyph is returned.

glyphIndex - Glyph index.

Atlas::Glyphs::Add

void Atlas::Glyphs::Add(int x, int y, const FreeTypeGlyph&);

Add new glyph. Internal use only.

Atlas::Bitmap

Represents the rendered atlas bitmap with all glyphs.

Atlas::Bitmap::GetWidth

unsigned int Atlas::Bitmap::Width() const;

Get the width of the atlas bitmap.

Atlas::Bitmap::GetHeight

unsigned int Atlas::Bitmap::Height() const;

Get the height of the atlas bitmap.

Atlas::Bitmap::GetChannels

unsigned int Atlas::Bitmap::Channels() const;

Get the number of color channels in the atlas bitmap. When RenderMode::DEFAULT or RenderMode::SDF is used it is always 1. When RenderMode::SDF is used it is always 3 and the bitmap is in RGB format.

Atlas::Bitmap::Format

PixelFormat Atlas::Bitmap::Format() const;

Get the PixelFormat of the atlas bitmap.

Atlas::Bitmap::Draw

void Atlas::Bitmap::Draw(int x, int y, const FreeTypeGlyph&);

Draw a glyph into the atlas bitmap. Internal use only.

ShapedGlyph

Represents a shaped glyph.

struct ShapedGlyph
{
    float xOffset;
    float yOffset;
    float xAdvance;
    float yAdvance;

    Glyph info;
};

xOffset - Horizontal offset of the glyph.
yOffset - Vertical offset of the glyph.
xAdvance - Horizontal advance of the glyph.
yAdvance - Vertical advance of the glyph.
info - Glyph info object.

AtlasBitmap

Represents a bitmap of the atlas.

using AtlasBitmap = std::vector<uint8_t>;

AtlasGlyphs

Represents a map of Glyphs. The key is the glyph index.

using AtlasGlyphs = std::map<uint32_t, Glyph>;

ShapedGlyphs

Represents a vector of ShapedGlyphs.

using ShapedGlyphs = std::vector<ShapedGlyph>;

TextMeasurement

Represents the dimension of a shaped text.

struct TextMeasurement
{
    float width, height;
    float xOffset, yOffset;
    float xAdvance, yAdvance;
};

width - Width of the bounding box of the text.
height - Height of the bounding box of the text.
xOffset - Offset from the baseline origin to the leftmost edge of the bounding box.
yOffset - Offset from the baseline origin to the topmost edge of the bounding box.
xAdvance - Advance from the baseline origin to the end of the text (including advance of the last glyph).
yAdvance - Advance from the baseline origin to the end of the text (including advance of the last glyph).

TextShaper

Used to shape text into ShapedGlyphs.

TextShaper::TextShaper

TextShaper::TextShaper(const Atlas& atlas);

atlas - Atlas object. Can be cafely destroyed after the TextShaper is created.

TextShaper::ShapeAscii

ShapedGlyphs TextShaper::ShapeAscii(std::span<const char> text);

Shape ASCII text into ShapedGlyphs. This is alias to ShapeUtf8. All ASCII characters are already UTF-8 encoded.

text - ASCII text.

TextShaper::ShapeUtf8

ShapedGlyphs TextShaper::ShapeUtf8(std::span<const char> text);

Shape UTF-8 text into ShapedGlyphs.

text - byte sequence of UTF-8 encoded text.

TextShaper::ShapeUtf32

ShapedGlyphs TextShaper::ShapeUtf32(std::span<const char32_t> text);

Shape UTF-32 text into ShapedGlyphs.

text - UTF-32 encoded text. Each character is a Unicode codepoint.

Note: char32_t* text must be converted to a vector of uint32_t before shaping. It allocates additional memory and copies the string. Use ShapeUnicode function whenever possible.

TextShaper::ShapeUnicode

ShapedGlyphs TextShaper::ShapeUnicode(std::span<const uint32_t> codepoints);

Shape Unicode text into ShapedGlyphs.

codepoints - Unicode codepoints.

TextShaper::GetFontMetrics

FontMetrics TextShaper::GetFontMetrics() const;