cartan-gpu 0.5.1

Portable GPU compute primitives for the cartan ecosystem: wgpu device/buffer/kernel abstractions plus VkFFT-backed FFT.
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

//! Error type for cartan-gpu. All fallible public APIs return `Result<_, GpuError>`.

use thiserror::Error;

#[derive(Debug, Error)]
pub enum GpuError {
    #[error("no adapter available for requested backend")]
    NoAdapter,

    #[error("requested Vulkan backend but adapter is {0:?}")]
    NotVulkan(wgpu::Backend),

    #[error("device creation failed: {0}")]
    DeviceCreation(#[from] wgpu::RequestDeviceError),

    #[error("buffer size mismatch: expected {expected} elements, got {got}")]
    BufferSize { expected: usize, got: usize },

    #[error("shader module creation failed: {msg}")]
    ShaderCompilation { msg: String },

    #[error("VkFFT error code {0}")]
    VkFftError(i32),

    #[error("feature `vkfft` not enabled at compile time")]
    VkFftDisabled,

    #[error("operation requires raw Vulkan handles; adapter is not Vulkan")]
    VulkanHandlesUnavailable,

    #[error("CUDA driver error: {0}")]
    CudaError(String),

    #[error("backend mismatch: the buffer was allocated for a different backend than the engine running it")]
    BackendMismatch,

    #[error("Vulkan and CUDA devices are not on the same physical GPU (vk={vk:02x?} cuda={cuda:02x?})")]
    GpuUuidMismatch { vk: [u8; 16], cuda: [u8; 16] },
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn error_displays() {
        let e = GpuError::BufferSize { expected: 10, got: 8 };
        assert_eq!(
            format!("{e}"),
            "buffer size mismatch: expected 10 elements, got 8"
        );
    }
}