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

Update readme with new build.zig usage

Browse Source
This commit is contained in:
Robin Voetter
2021-10-25 13:50:36 +02:00
parent 0eccd593ce
commit 933010cfff
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -36,10 +36,10 @@ pub fn build(b: *Builder) void {
exe.step.dependOn(&gen.step); exe.step.dependOn(&gen.step);
// Add the generated file as package to the final executable // Add the generated file as package to the final executable
exe.addPackagePath("vulkan", gen.full_out_path); exe.addPackage(gen.package);
} }
``` ```
This reads vk.xml, parses its contents, and renders the Vulkan bindings to "vk.zig", which is then formatted and placed in `zig-cache`. The resulting file can then be added to an executable by using `addPackagePath`. This reads vk.xml, parses its contents, and renders the Vulkan bindings to "vk.zig", which is then formatted and placed in `zig-cache`. The resulting file can then be added to an executable by using `addPackage`, after which the bindings will be made available to the executable under the name `vulkan`.
### Function & field renaming ### Function & field renaming
Functions and fields are renamed to be more or less in line with [Zig's standard library style](https://ziglang.org/documentation/master/#Style-Guide): Functions and fields are renamed to be more or less in line with [Zig's standard library style](https://ziglang.org/documentation/master/#Style-Guide):
@@ -231,7 +231,7 @@ pub fn build(b: *Builder) void {
const gen = vkgen.VkGenerateStep(b, "path/to/vk.xml", "vk.zig"); const gen = vkgen.VkGenerateStep(b, "path/to/vk.xml", "vk.zig");
exe.step.dependOn(&gen.step); exe.step.dependOn(&gen.step);
exe.addPackagePath("vulkan", gen.full_out_path); exe.addPackage(gen.package);
const shader_comp = vkgen.ShaderCompileStep.init( const shader_comp = vkgen.ShaderCompileStep.init(
builder, builder,