ZBgfx

When zig meets bgfx.

Features

• Zig api.
• Compile as standard zig library.
• shaderc as build artifact.
• Shader compile from runtime via shaderc as child process.
• Shader compile in build.zig and embed as zig module.
• Binding for DebugDraw API
• imgui render backend. Use build option imgui_include to enable. ex. for zgui: .imgui_include = zgui.path("libs").getPath(b),
• Zig based allocator.

[!IMPORTANT]

• This is only zig binding. For BGFX stuff goto bgfx.
• Github repository is only mirror. Development continues here

[!WARNING]

• shaderc need some time to compile.

License

Folders libs, shaders is copy&paste from bgfx for more sell-contained experience and is licensed by LICENSEE

Zig binding is licensed by WTFPL

Zig version

Minimal is 0.16.0. But you know try your version and believe.

Bgfx version

• BX
• BImg
• BGFX

Useful tools

• bgfx_shader_analyzer - LSP for bgfx shaders.

Getting started

Copy zbgfx to a subdirectory of your project and then add the following to your build.zig.zon .dependencies:

    .zbgfx = .{ .path = "path/to/zbgfx" },

or use zig fetch --save ... way.

Then in your build.zig add:

const zbgfx = @import("zbgfx");

pub fn build(b: *std.Build) void {
    const exe = b.addExecutable(.{ ... });

    const zbgfx_dep = b.dependency("zbgfx", .{});
    exe.root_module.addImport("zbgfx", zbgfx_dep.module("zbgfx"));
    exe.linkLibrary(zbgfx.artifact("bgfx"));
    _ = try zbgfx.build_step.installShaderc(b, zbgfx_dep);
}

Usage

See examples for binding usage and bgfx for bgfx stuff.

Build options

Examples

Run this for build all examples:

cd examples
zig build

Minimal GLFW

Minimal setup with GLFW for window and input.

examples/zig-out/bin/minimal-glfw

Shader embed

Basic usage of shaders compiled in build and embed to zig module.

examples/zig-out/bin/shader-embed

Shader runtime

Basic usage of shader compile in runtime. Try edit shaders in zig-out/bin/shaders and hit r to recompile.

examples/zig-out/bin/shader-runtime

ZGui

Minimal setup for zgui/ImGui.

examples/zig-out/bin/zgui

debugdraw

DebugDraw api usage example.

examples/zig-out/bin/debugdraw