Enum Dx12Compiler

pub enum Dx12Compiler {
    Fxc,
    Dxc {
        dxil_path: Option<PathBuf>,
        dxc_path: Option<PathBuf>,
    },
}

Selects which DX12 shader compiler to use.

If the wgpu-hal/dx12-shader-compiler feature isn’t enabled then this will fall back to the Fxc compiler at runtime and log an error. This feature is always enabled when using wgpu.

If the Dxc option is selected, but dxcompiler.dll and dxil.dll files aren’t found, then this will fall back to the Fxc compiler at runtime and log an error.

wgpu::utils::init::dx12_shader_compiler_from_env can be used to set the compiler from the WGPU_DX12_SHADER_COMPILER environment variable, but this should only be used for testing.

Variants

Fxc

The Fxc compiler (default) is old, slow and unmaintained.

However, it doesn’t require any additional .dlls to be shipped with the application.

Dxc

The Dxc compiler is new, fast and maintained.

However, it requires both dxcompiler.dll and dxil.dll to be shipped with the application. These files can be downloaded from https://github.com/microsoft/DirectXShaderCompiler/releases.

Fields

dxil_path: Option<PathBuf>

Path to the dxil.dll file, or path to the directory containing dxil.dll file. Passing None will use standard platform specific dll loading rules.

dxc_path: Option<PathBuf>

Path to the dxcompiler.dll file, or path to the directory containing dxcompiler.dll file. Passing None will use standard platform specific dll loading rules.

Trait Implementations

impl Clone for Dx12Compiler

fn clone(&self) -> Dx12Compiler

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Dx12Compiler

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Dx12Compiler

fn default() -> Dx12Compiler

Returns the “default value” for a type.