add compiler enum

Author: Vipitis

codegen/wgpu_native_patcher.py

@@ -70,6 +70,7 @@ def write_mappings():
     idl = get_idl_parser()
     hp = get_h_parser()
 
+    # these are empty and have no use?
     name_map = {}
     name_map_i = {v: k for k, v in name_map.items()}
 
@@ -126,6 +127,7 @@ def write_mappings():
         ("BackendType", False),
         ("NativeFeature", True),
         ("PipelineStatisticName", True),
+        ("Dx12Compiler", False),
     ):
         pylines.append(f'    "{name}":' + " {")
         for key, val in hp.enums[name].items():

examples/cube.py

@@ -457,9 +457,13 @@ async def draw_frame_async():
 uniform_data = np.zeros((), dtype=uniform_dtype)
 
 
-# TODO: remove testing code
+# TODO: remove testing code, this is all needed to use the Dxc compiler
 set_instance_extras(
-    backends=1 << 3  # DX12 only
+    backends=1 << 3,  # DX12 only: notice how it lists fewer adapters below
+    dx12_compiler="dxc",
+    dxil_path=r"C:\Program Files (x86)\Windows Kits\10\bin\10.0.26100.0\x64\dxil.dll",
+    dxc_path=r"C:\Program Files (x86)\Windows Kits\10\bin\10.0.26100.0\x64\dxcompiler.dll",
+    dxc_max_shader_model=6.7,
 )
 
 print("Available adapters on this system:")

wgpu/backends/wgpu_native/_mappings.py

@@ -365,6 +365,11 @@
         "fragment-shader-invocations": 3,
         "compute-shader-invocations": 4,
     },
+    "Dx12Compiler": {
+        "Undefined": 0,
+        "Fxc": 1,
+        "Dxc": 2,
+    },
 }
 
 enum_int2str = {

wgpu/backends/wgpu_native/extras.py

@@ -10,6 +10,7 @@
     structs,
     new_struct_p,
     to_c_string_view,
+    enum_str2int,
 )
 from ...enums import Enum
 from ._helpers import get_wgpu_instance
@@ -198,28 +199,34 @@ def set_instance_extras(
     """
     # TODO document and explain, find reference for defaults
 
-    # maybe include wgpu.h enums and flags in our codegen? (especially make sure to evaluate the flags)
-    compiler_map = {
-        "undefined": 0,  # lib.WGPUDx12Compiler_Undefined
-        "fxc": 1,  # lib.WGPUDx12Compiler_Fxc
-        "dxc": 2,  # lib.WGPUDx12Compiler_Dxc
-    }
-    c_dx12_compiler = compiler_map.get(dx12_compiler, 0)  # default to "undefined"?
+    c_dx12_compiler = enum_str2int["Dx12Compiler"].get(
+        dx12_compiler.capitalize(), enum_str2int["Dx12Compiler"]["Undefined"]
+    )  # default to "undefined"?
     # the rust conv layer does all the checking, so fallbacks are handled there.
+    if (
+        c_dx12_compiler == enum_str2int["Dx12Compiler"]["Dxc"]
+        and not (dxil_path or dxc_path)
+    ):  # os.path.exists(dxil_path) or os.path.exists(dxc_path)): # this check errors with None as default. but we can't have empty strings.
+        # if dxc is specified but no paths are provided, there will be a panic about static-dxc, so maybe we check against that.
+        # TODO: warning maybe? - can we overwrite this ourself to force fxc instead?
+        c_dx12_compiler = enum_str2int["Dx12Compiler"]["Undefined"]
+
+    # hack as only version 6.0..6.7 are supported and enum mapping fits.
+    c_max_shader_model = int((dxc_max_shader_model - 6.0) * 1.0)
 
     # TODO: translate to C enums/flags
     # H: chain: WGPUChainedStruct, backends: WGPUInstanceBackend/int, flags: WGPUInstanceFlag/int, dx12ShaderCompiler: WGPUDx12Compiler, gles3MinorVersion: WGPUGles3MinorVersion, glFenceBehaviour: WGPUGLFenceBehaviour, dxilPath: WGPUStringView, dxcPath: WGPUStringView, dxcMaxShaderModel: WGPUDxcMaxShaderModel
     c_extras = new_struct_p(
         "WGPUInstanceExtras *",
         # not used: chain
         backends=backends,
-        flags=flags,  # lib.WGPUInstanceFlag_Debug, # figure out if this works or not.
+        flags=flags,
         dx12ShaderCompiler=c_dx12_compiler,
         gles3MinorVersion=gles3_minor_version,
         glFenceBehaviour=fence_behavior,
         dxilPath=to_c_string_view(dxil_path),
         dxcPath=to_c_string_view(dxc_path),
-        # dxcMaxShaderModel=lib.WGPUDxcMaxShaderModel_V6_5,
+        dxcMaxShaderModel=c_max_shader_model,
     )
 
     c_extras.chain.sType = (

wgpu/resources/codegen_report.md

@@ -31,4 +31,4 @@
 * Wrote 255 enum mappings and 47 struct-field mappings to wgpu_native/_mappings.py
 * Validated 151 C function calls
 * Not using 69 C functions
-* Validated 96 C structs
+* Validated 95 C structs