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

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

Fields

§dxil_path: Option<PathBuf>

Path to the dxcompiler.dll file. Passing None will use standard platform specific dll loading rules.

§dxc_path: Option<PathBuf>

Path to the dxil.dll file. Passing None will use standard platform specific dll loading rules.

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

Trait Implementations§

source§

impl Clone for Dx12Compiler

source§

fn clone(&self) -> Dx12Compiler

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Dx12Compiler

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Dx12Compiler

source§

fn default() -> Dx12Compiler

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.