gizlang / mach-freetype

Gizzified Freetype 2 bindings with zero-fuss installation, cross compilation, and more.

mach/freetype - Ziggified FreeType 2 bindings

Ziggified FreeType 2 bindings that Mach engine uses, with zero-fuss installation, cross compilation, and more.

This repository is a separate copy of the same library in the main Mach repository, and is automatically kept in sync, so that anyone can use this library in their own project / engine if they like!

Zero fuss installation, cross compilation, and more

Just as with Mach, you get zero fuss installation & cross compilation using these Freetype bindings. only zig and git are needed to build from any OS and produce binaries for every OS. No system dependencies at all.

Usage

Getting started

Adding dependency (using Git)

In a libs subdirectory of the root of your project:

git clone https://github.com/hexops/mach-freetype

Then in your build.zig add:

...
const freetype = @import("libs/mach-freetype/build.zig");

pub fn build(b: *Build) void {
    ...
    exe.addModule("freetype", freetype.module(b));
    freetype.link(b, exe, .{});

    // use this option if you are including zlib separately
    //freetype.link(b, exe, .{ .freetype = .{ .use_system_zlib = true } });
}

and optionaly add harfbuzz:

exe.addModule("harfbuzz", freetype.harfbuzzModule(b));
freetype.link(b, exe, .{ .harfbuzz = .{} });

You can also optionally build brotli compression (for WOFF2 font support):

    exe.addModule("freetype", freetype.module(b));
    freetype.link(b, exe, .{ .freetype = .{ .brotli = true } });

Optional: Using Gyro dependency manager

gyro add --src github hexops/mach-freetype --root src/main.zig --alias freetype
gyro add --build-dep --src github hexops/mach-freetype --root build.zig --alias build-freetype

Then in your build.zig add:

...
const pkgs = @import("deps.zig").pkgs;
const freetype = @import("build-freetype");

pub fn build(b: *Build) void {
    ...

    exe.addModule("freetype", pkgs.freetype);
    freetype.link(b, exe, .{});
}

WARNING: You should use gyro build instead of zig build now!

Now you can import in code:

const freetype = @import("freetype");

Examples

See the examples/ directory. for running each example do:

zig build run-example-<name> # e.g run-example-single-glyph

Join the community

Join the Mach engine community on Discord to discuss this project, ask questions, get help, etc.

Issues

Issues are tracked in the main Mach repository.

Contributing

Contributions are very welcome. Pull requests must be sent to the main repository to avoid some complex merge conflicts we'd get by accepting contributions in both repositories. Once the changes are merged there, they'll get sync'd to this repository automatically.

Thanks

Special thanks to @alichraghi, original author of these bindings who contributed them to Mach!