130 lines
3.8 KiB
Markdown
130 lines
3.8 KiB
Markdown
# zgui v0.9.5 - dear imgui bindings
|
|
|
|
Easy to use, hand-crafted API with default arguments, named parameters and Zig style text formatting. For a test application please see [here](https://github.com/michal-z/zig-gamedev/tree/main/samples/gui_test_wgpu).
|
|
|
|
## Features
|
|
|
|
* Most public dear imgui API exposed
|
|
* All memory allocations go through user provided Zig allocator
|
|
* [DrawList API](#drawlist-api) for vector graphics, text rendering and custom widgets
|
|
* [Plot API](#plot-api) for advanced data visualizations
|
|
|
|
## Getting started
|
|
|
|
Copy `zgui` folder to a `libs` subdirectory of the root of your project.
|
|
|
|
To get glfw/wgpu rendering backend working also copy `zgpu`, `zglfw` and `zpool` folders (see [zgpu](https://github.com/michal-z/zig-gamedev/tree/main/libs/zgpu) for the details). Alternatively, you can provide your own rendering backend, see: [backend_glfw_wgpu.zig](src/backend_glfw_wgpu.zig) for an example.
|
|
|
|
Then in your `build.zig` add:
|
|
```zig
|
|
const zgui = @import("libs/zgui/build.zig");
|
|
|
|
// Needed for glfw/wgpu rendering backend
|
|
const zglfw = @import("libs/zglfw/build.zig");
|
|
const zgpu = @import("libs/zgpu/build.zig");
|
|
const zpool = @import("libs/zpool/build.zig");
|
|
|
|
pub fn build(b: *std.Build) void {
|
|
...
|
|
const zgui_pkg = zgui.package(b, .{
|
|
.options = .{ .backend = .glfw_wgpu },
|
|
});
|
|
|
|
exe.addModule("zgui", zgui_pkg.module);
|
|
|
|
zgui.link(exe, zgui_pkg.options);
|
|
|
|
// Needed for glfw/wgpu rendering backend
|
|
const zglfw_pkg = zglfw.package(b, .{});
|
|
const zpool_pkg = zpool.package(b, .{});
|
|
const zgpu_pkg = zgpu.package(b, .{
|
|
.deps = .{ .zpool = zpool_pkg.module, .zglfw = zglfw_pkg.module },
|
|
});
|
|
|
|
exe.addModule("zgpu", zgpu_pkg.module);
|
|
exe.addModule("zglfw", zglfw_pkg.module);
|
|
|
|
zglfw.link(exe);
|
|
zgpu.link(exe);
|
|
}
|
|
```
|
|
Now in your code you may import and use `zgui`:
|
|
```zig
|
|
const zgui = @import("zgui");
|
|
|
|
zgui.init(allocator);
|
|
|
|
_ = zgui.io.addFontFromFile(content_dir ++ "Roboto-Medium.ttf", 16.0);
|
|
|
|
zgui.backend.init(
|
|
window,
|
|
demo.gctx.device,
|
|
@enumToInt(swapchain_format),
|
|
);
|
|
```
|
|
|
|
```zig
|
|
// Main loop
|
|
while (...) {
|
|
zgui.backend.newFrame(framebuffer_width, framebuffer_height);
|
|
|
|
zgui.bulletText(
|
|
"Average : {d:.3} ms/frame ({d:.1} fps)",
|
|
.{ demo.gctx.stats.average_cpu_time, demo.gctx.stats.fps },
|
|
);
|
|
zgui.bulletText("W, A, S, D : move camera", .{});
|
|
zgui.spacing();
|
|
|
|
if (zgui.button("Setup Scene", .{})) {
|
|
// Button pressed.
|
|
}
|
|
|
|
if (zgui.dragFloat("Drag 1", .{ .v = &value0 })) {
|
|
// value0 has changed
|
|
}
|
|
|
|
if (zgui.dragFloat("Drag 2", .{ .v = &value0, .min = -1.0, .max = 1.0 })) {
|
|
// value1 has changed
|
|
}
|
|
|
|
// Setup wgpu render pass here
|
|
|
|
zgui.backend.draw(pass);
|
|
}
|
|
```
|
|
|
|
### DrawList API
|
|
|
|
```zig
|
|
draw_list.addQuad(.{
|
|
.p1 = .{ 170, 420 },
|
|
.p2 = .{ 270, 420 },
|
|
.p3 = .{ 220, 520 },
|
|
.p4 = .{ 120, 520 },
|
|
.col = 0xff_00_00_ff,
|
|
.thickness = 3.0,
|
|
});
|
|
draw_list.addText(.{ 130, 130 }, 0xff_00_00_ff, "The number is: {}", .{7});
|
|
draw_list.addCircleFilled(.{ .p = .{ 200, 600 }, .r = 50, .col = 0xff_ff_ff_ff });
|
|
draw_list.addCircle(.{ .p = .{ 200, 600 }, .r = 30, .col = 0xff_00_00_ff, .thickness = 11 });
|
|
draw_list.addPolyline(
|
|
&.{ .{ 100, 700 }, .{ 200, 600 }, .{ 300, 700 }, .{ 400, 600 } },
|
|
.{ .col = 0xff_00_aa_11, .thickness = 7 },
|
|
);
|
|
```
|
|
### Plot API
|
|
```zig
|
|
if (zgui.plot.beginPlot("Line Plot", .{ .h = -1.0 })) {
|
|
zgui.plot.setupAxis(.x1, .{ .label = "xaxis" });
|
|
zgui.plot.setupAxisLimits(.x1, .{ .min = 0, .max = 5 });
|
|
zgui.plot.setupLegend(.{ .south = true, .west = true }, .{});
|
|
zgui.plot.setupFinish();
|
|
zgui.plot.plotLineValues("y data", i32, .{ .v = &.{ 0, 1, 0, 1, 0, 1 } });
|
|
zgui.plot.plotLine("xy data", f32, .{
|
|
.xv = &.{ 0.1, 0.2, 0.5, 2.5 },
|
|
.yv = &.{ 0.1, 0.3, 0.5, 0.9 },
|
|
});
|
|
zgui.plot.endPlot();
|
|
}
|
|
```
|