update for modern vulkan and zig

Author: andrewrk

.gitignore

@@ -1,3 +1,2 @@
-zig-cache/
-shaders/frag.spv
-shaders/vert.spv
+/.zig-cache/
+/zig-out/

README.md

@@ -1,12 +1,27 @@
 # zig-vulkan-triangle
 
-Live coding every Thursday at 17:00 EST.
-https://www.twitch.tv/andrewrok
+Example of using [vulkan-zig](https://github.com/Snektron/vulkan-zig) and
+[shader_compiler](https://github.com/Games-by-Mason/shader_compiler) along with
+libxcb to open a window and draw a triangle.
 
 ![](https://i.imgur.com/pHEHvMU.png)
 
-## Building
+## Building and Running
 
 ```
 zig build run
 ```
+
+## System Configuration
+
+On NixOS, I had to add these to my shell:
+
+```
+buildInputs = [
+    vulkan-loader
+    vulkan-validation-layers
+    xorg.libxcb
+];
+
+VK_LAYER_PATH="${pkgs.vulkan-validation-layers}/share/vulkan/explicit_layer.d";
+```

build.zig

@@ -1,38 +1,78 @@
 const std = @import("std");
-const path = std.fs.path;
-const Builder = std.build.Builder;
-
-pub fn build(b: *Builder) !void {
-    const mode = b.standardReleaseOptions();
-    const exe = b.addExecutable("zig-vulkan-triangle", "src/main.zig");
-    exe.setBuildMode(mode);
-    exe.linkSystemLibrary("glfw");
+
+pub fn build(b: *std.Build) void {
+    const target = b.standardTargetOptions(.{});
+    const optimize = b.standardOptimizeOption(.{});
+
+    const registry = b.dependency("vulkan_headers", .{}).path("registry/vk.xml");
+    const shader_compiler = b.dependency("shader_compiler", .{
+        .target = b.host,
+        .optimize = .ReleaseFast,
+    }).artifact("shader_compiler");
+
+    const exe = b.addExecutable(.{
+        .name = "vulkan-triangle-example",
+        .root_source_file = b.path("src/main.zig"),
+        .target = target,
+        .optimize = optimize,
+        .link_libc = true,
+    });
     exe.linkSystemLibrary("vulkan");
-    exe.linkSystemLibrary("c");
+    exe.linkSystemLibrary("xcb");
+    b.installArtifact(exe);
+
+    const vk_gen = b.dependency("vulkan", .{}).artifact("vulkan-zig-generator");
+    const vk_generate_cmd = b.addRunArtifact(vk_gen);
+    vk_generate_cmd.addFileArg(registry);
 
-    b.default_step.dependOn(&exe.step);
-    exe.install();
+    exe.root_module.addAnonymousImport("vulkan", .{
+        .root_source_file = vk_generate_cmd.addOutputFileArg("vk.zig"),
+    });
+
+    exe.root_module.addAnonymousImport("shaders.triangle.vert", .{
+        .root_source_file = compileShader(b, optimize, shader_compiler, b.path("shaders/triangle.vert"), "triangle.vert.spv"),
+    });
+    exe.root_module.addAnonymousImport("shaders.triangle.frag", .{
+        .root_source_file = compileShader(b, optimize, shader_compiler, b.path("shaders/triangle.frag"), "triangle.frag.spv"),
+    });
+
+    const run_cmd = b.addRunArtifact(exe);
+    run_cmd.step.dependOn(b.getInstallStep());
+    if (b.args) |args| {
+        run_cmd.addArgs(args);
+    }
 
     const run_step = b.step("run", "Run the app");
-    const run_cmd = exe.run();
     run_step.dependOn(&run_cmd.step);
-
-    try addShader(b, exe, "shader.vert", "vert.spv");
-    try addShader(b, exe, "shader.frag", "frag.spv");
 }
 
-fn addShader(b: *Builder, exe: anytype, in_file: []const u8, out_file: []const u8) !void {
-    // example:
-    // glslc -o shaders/vert.spv shaders/shader.vert
-    const dirname = "shaders";
-    const full_in = try path.join(b.allocator, &[_][]const u8{ dirname, in_file });
-    const full_out = try path.join(b.allocator, &[_][]const u8{ dirname, out_file });
-
-    const run_cmd = b.addSystemCommand(&[_][]const u8{
-        "glslc",
-        "-o",
-        full_out,
-        full_in,
+fn compileShader(
+    b: *std.Build,
+    optimize: std.builtin.OptimizeMode,
+    shader_compiler: *std.Build.Step.Compile,
+    src: std.Build.LazyPath,
+    out_basename: []const u8,
+) std.Build.LazyPath {
+    const compile_shader = b.addRunArtifact(shader_compiler);
+    compile_shader.addArgs(&.{
+        "--target", "Vulkan-1.3",
     });
-    exe.step.dependOn(&run_cmd.step);
+    switch (optimize) {
+        .Debug => compile_shader.addArgs(&.{
+            "--robust-access",
+        }),
+        .ReleaseSafe => compile_shader.addArgs(&.{
+            "--optimize-perf",
+            "--robust-access",
+        }),
+        .ReleaseFast => compile_shader.addArgs(&.{
+            "--optimize-perf",
+        }),
+        .ReleaseSmall => compile_shader.addArgs(&.{
+            "--optimize-perf",
+            "--optimize-small",
+        }),
+    }
+    compile_shader.addFileArg(src);
+    return compile_shader.addOutputFileArg(out_basename);
 }

build.zig.zon

@@ -0,0 +1,28 @@
+.{
+    .name = "vulkan-triangle-example",
+    .version = "0.0.0",
+    .minimum_zig_version = "0.14.0-dev.1359+e9a00ba7f",
+
+    .dependencies = .{
+        .vulkan = .{
+            .url = "git+https://github.com/andrewrk/vulkan-zig.git#b6e589d62bc1d9070c47d73ce942168fb92624c8",
+            .hash = "12201e484e173e70634e664864763223427703e677f28c63ebec9332513c8ca5121c",
+        },
+        .vulkan_headers = .{
+            .url = "https://github.com/KhronosGroup/Vulkan-Headers/archive/v1.3.283.tar.gz",
+            .hash = "1220a7e73d72a0d56bc2a65f9d8999a7c019e42260a0744c408d1cded111bc205e10",
+        },
+        .shader_compiler = .{
+            .url = "git+https://github.com/andrewrk/shader_compiler.git#89550bb2cbe85276bd1fd89d020f3bbd686937c3",
+            .hash = "12207b775b98ac87f583d5ca95386537432c22f4bc83bc0c7fd9d6cbfdf265cc0444",
+        },
+    },
+
+    .paths = .{
+        "build.zig",
+        "build.zig.zon",
+        "src",
+        "LICENSE",
+        "README.md",
+    },
+}

shaders/shader.frag

@@ -0,0 +1,9 @@
+#version 450
+
+layout(location = 0) in vec3 v_color;
+
+layout(location = 0) out vec4 f_color;
+
+void main() {
+    f_color = vec4(v_color, 1.0);
+}

shaders/shader.vert

@@ -0,0 +1,11 @@
+#version 450
+
+layout(location = 0) in vec2 a_pos;
+layout(location = 1) in vec3 a_color;
+
+layout(location = 0) out vec3 v_color;
+
+void main() {
+    gl_Position = vec4(a_pos, 0.0, 1.0);
+    v_color = a_color;
+}