ruda-driver-wgpu 0.1.107

WGPU driver backend for Ruda
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

/// The basic trait to specify which graphics API to use as Backend.
///
/// Options are:
///   - [Vulkan](Vulkan)
///   - [Metal](Metal)
///   - [OpenGL](OpenGl)
///   - [DirectX 12](Dx12)
///   - [WebGpu](WebGpu)
pub trait GraphicsApi: Send + Sync + core::fmt::Debug + Default + Clone + 'static {
    /// The wgpu backend.
    fn backend() -> wgpu::Backend;

    fn backend_for(_device: &crate::WgpuDevice) -> crate::WgpuBackend {
        match Self::backend() {
            wgpu::Backend::Vulkan => crate::WgpuBackend::Vulkan,
            wgpu::Backend::Metal => crate::WgpuBackend::Metal,
            wgpu::Backend::Dx12 => crate::WgpuBackend::Dx12,
            wgpu::Backend::Gl => crate::WgpuBackend::Gl,
            wgpu::Backend::BrowserWebGpu => crate::WgpuBackend::WebGpu,
            wgpu::Backend::Noop => panic!("The noop backend cannot execute Wgpu kernels"),
        }
    }
}

/// Vulkan graphics API.
#[derive(Default, Debug, Clone)]
pub struct Vulkan;

/// Metal graphics API.
#[derive(Default, Debug, Clone)]
pub struct Metal;

/// OpenGL graphics API.
#[derive(Default, Debug, Clone)]
pub struct OpenGl;

/// DirectX 12 graphics API.
#[derive(Default, Debug, Clone)]
pub struct Dx12;

/// `WebGpu` graphics API.
#[derive(Default, Debug, Clone)]
pub struct WebGpu;

/// Automatic graphics API based on OS.
#[derive(Default, Debug, Clone)]
pub struct AutoGraphicsApi;

impl GraphicsApi for Vulkan {
    fn backend() -> wgpu::Backend {
        wgpu::Backend::Vulkan
    }
}

impl GraphicsApi for Metal {
    fn backend() -> wgpu::Backend {
        wgpu::Backend::Metal
    }
}

impl GraphicsApi for OpenGl {
    fn backend() -> wgpu::Backend {
        wgpu::Backend::Gl
    }
}

impl GraphicsApi for Dx12 {
    fn backend() -> wgpu::Backend {
        wgpu::Backend::Dx12
    }
}

impl GraphicsApi for WebGpu {
    fn backend() -> wgpu::Backend {
        wgpu::Backend::BrowserWebGpu
    }
}

impl AutoGraphicsApi {
    pub fn chain() -> Vec<wgpu::Backend> {
        // Allow overriding AutoGraphicsApi backend with ENV var in std test environments
        #[cfg(feature = "std")]
        #[cfg(test)]
        if let Ok(backend_str) = std::env::var("AUTO_GRAPHICS_BACKEND") {
            match backend_str.to_lowercase().as_str() {
                "metal" => return vec![wgpu::Backend::Metal],
                "vulkan" => return vec![wgpu::Backend::Vulkan],
                "dx12" => return vec![wgpu::Backend::Dx12],
                "opengl" => return vec![wgpu::Backend::Gl],
                "webgpu" => return vec![wgpu::Backend::BrowserWebGpu],
                _ => {
                    eprintln!(
                        "Invalid graphics backend specified in GRAPHICS_BACKEND environment \
                         variable"
                    );
                    std::process::exit(1);
                }
            }
        }

        // In a no_std environment or if the environment variable is not set
        cfg_if::cfg_if! {
            if #[cfg(target_family = "wasm")] {
                vec![wgpu::Backend::BrowserWebGpu]
            } else if #[cfg(target_os = "macos")] {
                 vec![wgpu::Backend::Metal]
            } else {
                vec![wgpu::Backend::Vulkan, wgpu::Backend::Dx12, wgpu::Backend::Gl]
            }
        }
    }
}

impl GraphicsApi for AutoGraphicsApi {
    fn backend() -> wgpu::Backend {
        crate::runtime::adapters::resolve_backend(crate::WgpuBackend::Auto)
    }

    fn backend_for(device: &crate::WgpuDevice) -> crate::WgpuBackend {
        device.backend()
    }
}