allemang.d/vulkan-zig
1
0
Fork 0
forked from mirror/vulkan-zig
Code Pull Requests Activity

Update "Shader compilation" in README

Browse Source
This commit is contained in:
Timofey Peshin
2023-09-24 23:44:05 -07:00
parent 348ac5d35a
commit 9fbfa26046
1 changed files with 19 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -288,27 +288,35 @@ pub const xcb_connection_t = if (@hasDecl(root, "xcb_connection_t")) root.xcb_co
For some times (such as those from Google Games Platform) no default is known. Usage of these without providing a concrete type in the project root generates a compile error. For some times (such as those from Google Games Platform) no default is known. Usage of these without providing a concrete type in the project root generates a compile error.
### Shader compilation ### Shader compilation
vulkan-zig provides functionality to help compiling shaders to spir-v using glslc. It can be used from build.zig as follows:
vulkan-zig provides functionality to help compile shaders to SPIR-V using glslc.
It can be used from build.zig as follows:
```zig ```zig
const vkgen = @import("vulkan-zig/generator/index.zig"); const vkgen = @import("vulkan_zig");
pub fn build(b: *Builder) void { pub fn build(b: *Builder) void {
... ...
const exe = b.addExecutable("my-executable", "src/main.zig");
const gen = vkgen.VkGenerateStep(b, "path/to/vk.xml", "vk.zig");
exe.addPackage(gen.package);
const shader_comp = vkgen.ShaderCompileStep.create( const shader_comp = vkgen.ShaderCompileStep.create(
builder, builder,
&[_][]const u8{"glslc", "--target-env=vulkan1.2"}, // Path to glslc and additional parameters &[_][]const u8{"glslc", "--target-env=vulkan1.2"},
"-o",
); );
exe.addPackage(shader_comp.getPackage("shaders")); shader_comp.add("shader_frag", "path/to/shader.frag", .{});
shader_comp.add("shader", "path/to/shader.frag", .{}); shader_comp.add("shader_vert", "path/to/shader.vert", .{});
exe.addModule("shaders", shader_comp.getModule());
} }
``` ```
Upon compilation, glslc is then invoked to compile each shader, and the result is placed within `zig-cache`. All shaders which are compiled using a particular `ShaderCompileStep` are imported in a single Zig file using `@embedFile`, and this file can be added to an executable as a package using `getPackage`. To slightly improve compile times, shader compilation is cached; as long as a shader's source and its compile commands stay the same, the shader is not recompiled. The spir-v code for any particular shader is aligned to that of a 32-bit integer as follows, as required by vkCreateShaderModule:
Upon compilation, glslc is invoked to compile each shader, and the result is
placed within `zig-cache`. All shaders which are compiled using a particular
`ShaderCompileStep` are imported in a single Zig file using `@embedFile`, and
this file can be added to an executable as a module using `addModule`. To
slightly improve compile times, shader compilation is cached; as long as a
shader's source and its compile commands stay the same, the shader is not
recompiled. The SPIR-V code for any particular shader is aligned to that of a
32-bit integer as follows, as required by vkCreateShaderModule:
```zig ```zig
pub const ${name} align(@alignOf(u32)) = @embedFile("${path}").*; pub const ${name} align(@alignOf(u32)) = @embedFile("${path}").*;
``` ```