WIP: Upgrade BGFX

Author: OndraVoves

.gitignore

@@ -27,6 +27,9 @@
 project.xcworkspace/
 xcuserdata/
 
+# Kevelop
+*.kdev4
+
 kcov-output/
 
 imgui.ini
@@ -36,6 +39,7 @@ _static.zig
 # VSCode
 .vscode/launch.json
 .vscode/settings.json
+.vscode/tasks.json
 
 # Idea
 .idea/
@@ -51,4 +55,4 @@ result.xml
 *.tracy
 NodeEditor.json
 
-*.zst
+*.zst

.ide.zon

@@ -1,4 +1,8 @@
 .{
+    .tasks = .{
+        .{ .name = "Build", .type = "shell", .command = "zig", .args = .{"build"} },
+    },
+
     .launchers = .{
         .{ .name = "Unit tests", .program = .{ .path = "zig-out/bin/cetech1_test" }, .args = .{} },
         .{ .name = "No asset root", .args = .{} },

build.zig

@@ -2,6 +2,7 @@ const std = @import("std");
 const builtin = @import("builtin");
 
 pub const generate_ide = @import("src/tools/generate_ide.zig");
+const zbgfx = @import("zbgfx");
 
 const min_zig_version = std.SemanticVersion.parse("0.15.1") catch @panic("Where is .zigversion?");
 const cetech1_version = std.SemanticVersion.parse(@embedFile(".version")) catch @panic("Where is .version?");
@@ -131,6 +132,8 @@ pub fn createKernelExe(
     ignored_modules: ?[]const []const u8,
     ignored_modules_prefix: ?[]const []const u8,
 ) !*std.Build.Step.Compile {
+    const use_lld = !target.result.os.tag.isDarwin();
+
     const exe = b.addExecutable(.{
         .name = bin_name,
         .version = versionn,
@@ -140,6 +143,7 @@ pub fn createKernelExe(
             .optimize = optimize,
         }),
         .use_llvm = true,
+        .use_lld = use_lld,
     });
     exe.root_module.link_libc = true;
     exe.root_module.addImport("kernel", cetech1_kernel);
@@ -172,7 +176,7 @@ pub fn createStudioExe(
     return try createKernelExe(
         b,
         base_bin_name ++ "_studio",
-        "studio",
+        "run-studio",
         "Run studio",
         root_source,
         cetech1_kernel,
@@ -246,7 +250,7 @@ pub fn build(b: *std.Build) !void {
         .nfd_portal = b.option(bool, "nfd_portal", "build NFD with xdg-desktop-portal instead of GTK. ( Linux, nice for steamdeck;) )") orelse true,
 
         // ZGUI
-        .with_freetype = b.option(bool, "with_freetype", "build coreui with freetype support") orelse false,
+        .with_freetype = b.option(bool, "with_freetype", "build coreui with freetype support") orelse true,
 
         // BGFX
         .with_shaderc = b.option(bool, "with_shaderc", "build with shaderc support") orelse true,
@@ -264,6 +268,8 @@ pub fn build(b: *std.Build) !void {
     }
     const options_module = options_step.createModule();
 
+    const use_lld = !target.result.os.tag.isDarwin();
+
     //
     // Extrnals
     //
@@ -343,7 +349,8 @@ pub fn build(b: *std.Build) !void {
     );
 
     // ZBGFX
-    const zbgfx = b.dependency(
+    // TODO: Remove
+    const zbgfx_dep = b.dependency(
         "zbgfx",
         .{
             .target = target,
@@ -475,7 +482,6 @@ pub fn build(b: *std.Build) !void {
     const gen_ide_step = b.step("gen-ide", "init/update IDE configs");
     {
         const ide = b.option(generate_ide.EditorType, "ide", "IDE for gen-ide command") orelse .VSCode;
-        const no_zls = b.option(bool, "no_zls", "Dont write zls path with gen-ide command") orelse false;
 
         const gen_ide = b.addRunArtifact(generate_ide_tool);
 
@@ -493,10 +499,6 @@ pub fn build(b: *std.Build) !void {
         gen_ide.addArg("--config");
         gen_ide.addDirectoryArg(b.path(".ide.zon"));
 
-        if (no_zls) {
-            gen_ide.addArg("--no-zls");
-        }
-
         gen_ide_step.dependOn(&gen_ide.step);
     }
 
@@ -520,7 +522,8 @@ pub fn build(b: *std.Build) !void {
     });
 
     if (options.with_shaderc) {
-        b.installArtifact(zbgfx.artifact("shaderc"));
+        const shaderc_install = try zbgfx.build_step.installShaderc(b, zbgfx_dep);
+        b.getInstallStep().dependOn(shaderc_install);
     }
 
     //
@@ -655,6 +658,7 @@ pub fn build(b: *std.Build) !void {
             .imports = &imports,
         }),
         .use_llvm = true,
+        .use_lld = use_lld,
     });
     useSystemSDK(b, target, tests);
     b.installArtifact(tests);

build.zig.zon

@@ -106,8 +106,8 @@
 
         // zig-gamedev
         .system_sdk = .{
-            .url = "https://github.com/zig-gamedev/system_sdk/archive/c0dbf11cdc17da5904ea8a17eadc54dee26567ec.tar.gz",
-            .hash = "system_sdk-0.3.0-dev-alwUNnYaaAJAtIdE2fg4NQfDqEKs7QCXy_qYukAOBfmF",
+            .url = "https://github.com/zig-gamedev/system_sdk/archive/777e76828f05d5d223df47a4c0de95ae4efde884.tar.gz",
+            .hash = "system_sdk-0.3.0-dev-alwUNqAaaALJ5VoZImZo3n6prezBnQnrpziun3ZeZwcp",
             .lazy = true,
         },
         .zglfw = .{ .path = "externals/shared/lib/zglfw" },

docs/topics/getting-started.md

@@ -46,21 +46,18 @@ Get ZIG `0.15.1`.
     </tab>
 </tabs>
 
-## VSCode
-
-> Repository contain recommended extension.
+## NVim
 
-> add `-Dno_zls` to disable zls path change (For example if you are install zls via vscode plugin).
-> {style="note"}
+> This generate `vscode/{launch.json,tasks.json,settings.json}`
+> that can read pluggins in NVim (ex.: overseer, nvim-dap, ..)
 
 1. Create vscode configs.
     <code-block lang="bash">
         # This generate vscode launch.json with predefined cases
         # create or update settings.json
         # and set zls path to locally builded
         zig build gen-ide -Dide=VSCode
-    </code-block>
-2. Install extension `ziglang.vscode-zig` (or install all recommended)
+    </code-block> 
 
 ## Idea
 
@@ -73,6 +70,19 @@ Need [zigbrains](https://plugins.jetbrains.com/plugin/22456-zigbrains)
         zig build gen-ide -Dide=IDEA
     </code-block>
 
+## VSCode
+
+> Repository contain recommended extension.
+
+1. Create vscode configs.
+    <code-block lang="bash">
+        # This generate vscode launch.json with predefined cases
+        # create or update settings.json
+        # and set zls path to locally builded
+        zig build gen-ide -Dide=VSCode
+    </code-block>
+2. Install extension `ziglang.vscode-zig` (or install all recommended)
+
 ## Build
 
 <tabs>
@@ -132,27 +142,6 @@ Need [zigbrains](https://plugins.jetbrains.com/plugin/22456-zigbrains)
 | `--test-ui-speed`        | `fast`, `normal`,  `cinematic`                        | `fast`          | UI test speed.                              |
 | `--test-ui-junit`        | `str`                                                 | `null`          | UI test JUnit result filename.              |
 
-## ZLS
-
-CETech provide ZLS as submodule, but you must build it.
-
-<tabs>
-    <tab title="MacOS/Linux">
-        <code-block lang="bash">
-            git submodule update --init externals/shared/repo/zls
-            cd externals/shared/repo/zls
-            zig build -Doptimize=ReleaseFast
-        </code-block>
-    </tab>
-    <tab title="Windows">
-        <code-block lang="bash">
-            git submodule update --init externals/shared/repo/zls
-            cd externals/shared/repo/zls
-            zig.exe build -Doptimize=ReleaseFast
-        </code-block>
-    </tab>
-</tabs>
-
 ## Tracy profiler
 
 CETech1 has builtin support for tracy profiler and provide Tracy as submodule, but you must build it first.

externals/shared/lib/zbgfx/README.md

@@ -9,26 +9,22 @@ When [zig](https://codeberg.org/ziglang/zig) meets [bgfx](https://github.com/bka
 - [x] Zig api.
 - [x] Compile as standard zig library.
 - [x] `shaderc` as build artifact.
-- [x] Shader compile in `build.zig` to `*.bin.h`.
-- [x] Shader compile in `build.zig` and embed as zig module. (this is zig equivalent of `*.bin.h`)
 - [x] Shader compile from runtime via `shaderc` as child process.
+- [x] Shader compile in `build.zig` and embed as zig module.
 - [x] Binding for [DebugDraw API](https://github.com/bkaradzic/bgfx/tree/master/examples/common/debugdraw)
 - [x] `imgui` render backend. Use build option `imgui_include` to enable. ex. for
   zgui: `.imgui_include = zgui.path("libs").getPath(b),`
 - [ ] Zig based allocator.
 
-> [!IMPORTANT]  
+> [!IMPORTANT]
+>
 > - This is only zig binding. For BGFX stuff goto [bgfx](https://github.com/bkaradzic/bgfx).
 > - Github repository is only mirror. Development continues [here](https://codeberg.org/cyberegoorg/zbgfx)
 
 > [!WARNING]
+>
 > - `shaderc` need some time to compile.
 
-> [!NOTE]
-> - If you build shaders/app and see something like `run shaderc (shader.bin.h) stderr`.
-    This is not "true" error (build success), but only in debug build shader print some stuff to stderr and zig
-    build catch it.
-
 ## License
 
 Folders `libs`, `shaders` is copy&paste from [bgfx](https://github.com/bkaradzic/bgfx) for more sell-contained
@@ -42,9 +38,9 @@ Minimal is `0.15.1`. But you know try your version and believe.
 
 ## Bgfx version
 
-- [BX](https://github.com/bkaradzic/bx//compare/ce31b1445475ecd4b090471144c4c30a1cbdd871...master)
-- [BImg](https://github.com/bkaradzic/bimg/compare/bf10ffbb3df1f9f12ad7a9105e5e96e11a9c5a0c...master)
-- [BGFX](https://github.com/bkaradzic/bgfx/compare/56eb016280731451c3b7f18433dc114df035d52a...master)
+- [BX](https://github.com/bkaradzic/bx/compare/cac72f6cfa0893393ea12692ebfacb4495f8c826...master)
+- [BImg](https://github.com/bkaradzic/bimg/compare/9114b47f532ce59cd0c6c9f8932df2c48888d4c1...master)
+- [BGFX](https://github.com/bkaradzic/bgfx/compare/a7016487e5970c5299bb837f1af42dcb24909a67...master)
 
 ## Getting started
 
@@ -93,39 +89,39 @@ cd examples
 zig build
 ```
 
-### [00-Minimal](examples/00-minimal/)
+### [Minimal GLFW](examples/minimal-glfw/)
 
 Minimal setup with GLFW for window and input.
 
 ```sh
-examples/zig-out/bin/00-minimal
+examples/zig-out/bin/minimal-glfw
 ```
 
 | Key | Description  |
 |-----|--------------|
 | `v` | Vsync on/off |
 | `d` | Debug on/off |
 
-### [01-ZGui](examples/01-zgui/)
+### [Shader embed](examples/shader-embed/)
 
-Minimal setup for zgui/ImGui.
+Basic usage of shaders compiled in build and embed to zig module.
 
 ```sh
-examples/zig-out/bin/01-zgui
+examples/zig-out/bin/shader-embed
 ```
 
 | Key | Description  |
 |-----|--------------|
 | `v` | Vsync on/off |
 | `d` | Debug on/off |
 
-### [02-Runtime shaderc](examples/02-runtime-shaderc/)
+### [Shader runtime](examples/shader-runtime/)
 
 Basic usage of shader compile in runtime.
 Try edit shaders in `zig-out/bin/shaders` and hit `r` to recompile.
 
 ```sh
-examples/zig-out/bin/02-runtime-shaderc
+examples/zig-out/bin/shader-runtime
 ```
 
 | Key | Description                 |
@@ -134,12 +130,25 @@ examples/zig-out/bin/02-runtime-shaderc
 | `d` | Debug on/off                |
 | `r` | Recompile shaders form file |
 
-### [03-debugdraw](examples/03-debugdraw/)
+### [ZGui](examples/zgui/)
+
+Minimal setup for zgui/ImGui.
+
+```sh
+examples/zig-out/bin/zgui
+```
+
+| Key | Description  |
+|-----|--------------|
+| `v` | Vsync on/off |
+| `d` | Debug on/off |
+
+### [debugdraw](examples/debugdraw/)
 
 DebugDraw api usage example.
 
 ```sh
-examples/zig-out/bin/03-debugdraw
+examples/zig-out/bin/debugdraw
 ```
 
 | Key | Description  |