move instance extras

Author: Vipitis

examples/cube.py

@@ -14,6 +14,8 @@
 
 import wgpu
 import numpy as np
+from wgpu.backends.wgpu_native.extras import set_instance_extras
+
 
 from rendercanvas.auto import RenderCanvas, loop
 
@@ -455,6 +457,11 @@ async def draw_frame_async():
 uniform_data = np.zeros((), dtype=uniform_dtype)
 
 
+# TODO: remove testing code
+set_instance_extras(
+    backends=1 << 3  # DX12 only
+)
+
 print("Available adapters on this system:")
 for a in wgpu.gpu.enumerate_adapters_sync():
     print(a.summary)

wgpu/backends/wgpu_native/_api.py

@@ -315,30 +315,6 @@ def check_struct(struct_name, d):
         raise ValueError(f"Invalid keys in {struct_name}: {invalid_keys}")
 
 
-# forcing in the dynamic dx12 compiler to see if it works...
-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"
-
-# H: chain: WGPUChainedStruct, backends: WGPUInstanceBackend/int, flags: WGPUInstanceFlag/int, dx12ShaderCompiler: WGPUDx12Compiler, gles3MinorVersion: WGPUGles3MinorVersion, glFenceBehaviour: WGPUGLFenceBehaviour, dxilPath: WGPUStringView, dxcPath: WGPUStringView, dxcMaxShaderModel: WGPUDxcMaxShaderModel
-_instance_extras = new_struct_p(
-    "WGPUInstanceExtras *",
-    backends=8,  # lib.WGPUInstanceBackend_DX12, #TODO: this isn't evaluated for importing or available in flags.py
-    dx12ShaderCompiler=lib.WGPUDx12Compiler_Dxc,
-    dxilPath=to_c_string_view(dxil_path),
-    dxcPath=to_c_string_view(dxc_path),
-    dxcMaxShaderModel=lib.WGPUDxcMaxShaderModel_V6_7,
-    flags=3,  # lib.WGPUInstanceFlag_Debug, # figure out if this works or not.
-    # not used: chain
-    # not used: gles3MinorVersion
-    # not used: glFenceBehaviour
-)
-_instance_extras.chain.sType = lib.WGPUSType_InstanceExtras
-
-
-def get_wgpu_instance_dx12():
-    return get_wgpu_instance(extras=_instance_extras)
-
-
 def _get_limits(id: int, device: bool = False, adapter: bool = False):
     """Gets the limits for a device or an adapter"""
     assert device + adapter == 1  # exactly one is set
@@ -1290,6 +1266,7 @@ def device_lost_callback(c_device, c_reason, c_message, userdata1, userdata2):
         def uncaptured_error_callback(
             c_device, c_type, c_message, userdata1, userdata2
         ):
+            # TODO: does this always raise an exception? retest the loop cases!
             error_type = enum_int2str["ErrorType"].get(c_type, "Unknown")
             msg = from_c_string_view(c_message)
             msg = "\n".join(line.rstrip() for line in msg.splitlines())

wgpu/backends/wgpu_native/extras.py

@@ -2,8 +2,17 @@
 from typing import List
 
 from . import GPUCommandEncoder, GPUComputePassEncoder, GPURenderPassEncoder
-from ._api import Dict, GPUBindGroupLayout, enums, logger, structs
+from ._api import (
+    Dict,
+    GPUBindGroupLayout,
+    enums,
+    logger,
+    structs,
+    new_struct_p,
+    to_c_string_view,
+)
 from ...enums import Enum
+from ._helpers import get_wgpu_instance
 
 
 # NOTE: these functions represent backend-specific extra API.
@@ -172,3 +181,48 @@ def write_timestamp(encoder, query_set, query_index):
         encoder, (GPURenderPassEncoder, GPUComputePassEncoder, GPUCommandEncoder)
     )
     encoder._write_timestamp(query_set, query_index)
+
+
+def set_instance_extras(
+    backends=0,  # default all
+    flags=0,
+    dx12_compiler="fxc",  # default, alternative "dxc"
+    gles3_minor_version=0,
+    fence_behavior=0,
+    dxil_path: os.PathLike | None = None,
+    dxc_path: os.PathLike | None = None,
+    dxc_max_shader_model: float = 6.5,
+):
+    """
+    Sets the global instance with 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"?
+    # the rust conv layer does all the checking, so fallbacks are handled there.
+
+    # 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.
+        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,
+    )
+
+    c_extras.chain.sType = (
+        0x00030006  # lib.WGPUSType_InstanceExtras (but we don't import lib here?)
+    )
+    get_wgpu_instance(extras=c_extras)  # this sets a global