Zig-STB-Image

Zig build of the STB image library.

The definitions have been split out of the header file and into a C source file, allowing Zig to include the header w/o needing to transpile the entire library (instead, the C compiler is used to compile it into a static library that Zig can link to).

Getting started

Create a build.zig.zon in your project (replace LATEST_COMMIT with the latest commit hash):

.{
    .name = "mypkg",
    .version = "0.1.0",
    .dependencies = .{
        .zig_stb_image = .{
            .url = "https://github.com/JacobCrabill/zig-stb-image/archive/LATEST_COMMIT.tar.gz",
        },
    },
}

Run zig build in your project, and the compiler will instruct you to add a .hash = "..." field next to .url:

note: expected .hash = "1220b01a5a08e610a3a00ea722cec42c021983afcf81e444ba250adf548f2a245b1f",

To use the library, add the dependency in your build.zig:

const std = @import("std");

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

    const zig_stb_image_dep = b.dependency("zig_stb_image", .{
        .target = tgt,
        .optimize = opt,
    });
    // We need the artifact to link the module
    const zig_stb_image = zig_stb_image_dep.artifact("stb-image");

    //... 

    exe.linkLibrary(zig_stb_image);
    exe.addModule("stb-image", zig_stb_image_dep.module("stb_image"));
    exe.installLibraryHeaders(zig_stb_image);

    // ...
}

You can now use it in your src/main.zig file:

const stb = @import("stb-image");

pub fn main() !void {
    const img = stb.image_load(.{
        .filename = "hello.png",
        .desired_channels = 4,
    });
    defer img.deinit();

    // ...
}