a1fe671db8
* all: build: fix sdkPath for relative @src.file
Prior to this commit, the build system heavily assumed that the result
`@src.file` would always be absolute, but this is no longer
guaranteed, likely due to there being no such thing as an "absolute
path" in WASI.
It appears that for normal invocations of `zig build`, it is safe to
assume that `@src.file` is absolute. However, when ZLS uses a custom
`build_runner.zig` to collect build configuration, `@src.file` is
actually relative to the current working directory, at least on my
system. For a while, this led to ZLS completions breaking entirely,
but presently it actually causes ZLS to crash!
The solution is not as simple as using relative `sdkPath` results
as-is, because the build system may attempt to resolve these paths
relative to build root, when the paths are actually relative to the
current working directory.
This leads to a sticky situation: the current working directory is a
runtime concept, but `@src.file` is resolved at compile time. However,
it appears that the build runner does not change current working
directory in between compilation and execution, so it is probably safe
to calculate `sdkPath` using runtime current working directory.
Still, this requires major changes with how `sdkPath` works, since
runtime computation and allocations are required. So pretty much
anything that relied on `sdkPath` being comptime-known has been
refactored in this commit.
The most severe result of this is that, for example, `gpu.pkg` can no
longer be a comptime-known constant: it has to be a runtime function
that takes a `*Builder` and returns a `Pkg`.
This commit deals with usages of `*.pkg` and `sdkPath` within Mach
itself, but projects that depend on Mach such as `mach-examples` will
almost certainly require changes as well.
* all: update README to reflect change in pkg usage
For details on updating your code to use this version, see: 88b1106953
Signed-off-by: Stephen Gutekanst <stephen@hexops.com>
Co-authored-by: Stephen Gutekanst <stephen@hexops.com>
3.4 KiB
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: *Builder) void {
...
exe.addPackage(freetype.pkg(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.addPackage(freetype.harfbuzz_pkg);
freetype.link(b, exe, .{ .harfbuzz = .{} });
You can also optionally build brotli compression (for WOFF2 font support):
exe.addPackage(freetype.pkg(b));
freetype.link(b, exe, .{ .freetype = .{ .brotli = true } });
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: *Builder) void {
...
exe.addPackage(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 Matrix chat 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!