Restore Native Tools

ShadowDusk's in-memory OpenGL/WebGL path is self-contained from NuGet — you do not need to run a restore script to compile for OpenGL:

  • DXC (HLSL → SPIR-V) comes from the Vortice.Dxc NuGet package.
  • SPIRV-Cross (SPIR-V → GLSL) ships transitively via the Silk.NET.SPIRV.Cross.Native NuGet package.

Both are pulled in by dotnet restore and live in the NuGet package cache.

When you do need the restore script

The restore script provisions native artifacts that are not committed to the repo — it is for building ShadowDusk itself from source (and CI). Consumers never run it: everything below ships inside the published NuGet packages.

Artifact Used by Notes
vkd3d-shader the cross-platform DirectX DXBC backend (DxbcBackend.Vkd3d) and the FNA fx_2_0 target Downloaded (SHA-256-pinned) from the hosted native-vkd3d-1.17 release for all four desktop RIDs (win-x64, linux-x64, osx-x64, osx-arm64) and packed under runtimes/<rid>/native — self-contained in the NuGet. vkd3d-shader is the default, cross-platform DX backend; the opt-in d3dcompiler_47 oracle is Windows-only and doesn't need it.
libdxcompiler.dylib (macOS DXC) the OpenGL/WebGL pipeline frontend on macOS Vortice.Dxc ships no macOS native, so this is ShadowDusk's own build of the exact pinned DXC commit. Downloaded (SHA-256-pinned) from the hosted native-dxc-1.7.2212.40 release for both osx-x64 and osx-arm64 into tools/dxc/osx-*/ and packed under runtimes/osx-*/native — without it, every CompileAsync on a Mac would fail to load DXC.
dxcompiler.wasm the in-browser ShadowDusk.Wasm frontend (OpenGL/WebGL) Copied from the committed source-of-truth in .wasm-build/ into the package's wwwroot/dxc/.
vkd3d-shader.{js,wasm} the in-browser ShadowDusk.Wasm DirectX/FNA export backend Downloaded (SHA-256-pinned) from the hosted release into the package's wwwroot/vkd3d/; a local .wasm-build/vkd3d-wasm-out/ build takes precedence. See DirectX & FNA in the Browser.

Running it

./tools/restore.sh        # Linux / macOS

.\tools\restore.ps1       # Windows

The script is download-tolerant, not failure-silent: every artifact is downloaded from a fixed, SHA-256-pinned GitHub release, and an offline/failed download prints a warning and continues (the affected backends then fail loudly at compile time — SD0211 for the desktop vkd3d native, SD1902 for the browser module). A genuine script error exits non-zero. CI runs the same script and then hard-gates on the result: post-restore existence checks in the CI/release workflows fail red when a pinned asset is missing, and the release pack gates verify the vkd3d natives (all four RIDs), both macOS DXC dylibs, and the browser vkd3d module are inside the packages before anything publishes. (See the Contributing Guide.)

What lands where

  • tools/dxc/osx-{x64,arm64}/ — the load-bearing macOS DXC restore target: ShadowDusk's own pinned libdxcompiler.dylib builds, packed into the NuGet as the macOS DXC native (desktop DXC on Windows/Linux comes from the Vortice.Dxc NuGet instead).
  • tools/spirv-cross/ — optional; the SPIRV-Cross native normally ships transitively via the Silk.NET.SPIRV.Cross.Native NuGet, so this stays empty unless you deliberately provide a local copy.
  • tools/vkd3d/ — the vkd3d-shader native for the cross-platform DXBC backend (headers kept for binding reference; only the binary is git-ignored).

See DirectX DXBC (vkd3d) Path and WASM In-Browser Frontend for how each artifact is consumed.

Edit this page