Enum WgpuDeviceKind 

pub enum WgpuDeviceKind {
    DiscreteGpu(usize),
    IntegratedGpu(usize),
    VirtualGpu(usize),
    Cpu,
    DefaultDevice,
    Existing(u32),
    Other(usize),
}

Which of a machine’s wgpu devices, leaving the graphics API aside.

Variants

DiscreteGpu(usize)

Discrete GPU with the given index. The index is the index of the discrete GPU in the list of all discrete GPUs found on the system.

IntegratedGpu(usize)

Integrated GPU with the given index. The index is the index of the integrated GPU in the list of all integrated GPUs found on the system.

VirtualGpu(usize)

Virtual GPU with the given index. The index is the index of the virtual GPU in the list of all virtual GPUs found on the system.

Cpu

CPU — a software rasterizer such as lavapipe, llvmpipe or WARP.

DefaultDevice

The best available device found with the current graphics API.

This will prioritize GPUs wgpu recognizes as “high power”. Additionally, you can override this using the CUBECL_WGPU_DEFAULT_DEVICE environment variable. This variable is spelled as if i was a WgpuDevice, so for example CUBECL_WGPU_DEFAULT_DEVICE=IntegratedGpu(1) or CUBECL_WGPU_DEFAULT_DEVICE=Cpu

Existing(u32)

Use an externally created, existing, wgpu setup. This is helpful when using CubeCL in conjunction with some existing wgpu setup (eg. egui or bevy), as resources can be transferred in & out of CubeCL.

The graphics API came up with the setup, so pinning one on top of this means nothing and is not encoded.

Notes

This can be initialized with init_device in the wgpu runtime.

Other(usize)

An adapter wgpu recognizes but does not classify — what it reports as DeviceType::Other, which OpenGL drivers often do. Indexed among its own kind like the rest.

Implementations

impl WgpuDeviceKind

pub const MAX_INDEX: usize

The largest index that survives a round trip through a DeviceId.

The graphics API rides in the top three bits of the index, leaving thirteen — far more adapters of one kind than a machine has. A larger index is kept at this one rather than wrapped: wrapped, it lands on a device that exists; kept here, it names one no machine has, and naming it is refused.

Trait Implementations

impl Clone for WgpuDeviceKind

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WgpuDeviceKind

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

Formats the value using the given formatter.

impl Default for WgpuDeviceKind

fn default() -> Self

Returns the “default value” for a type.

impl Eq for WgpuDeviceKind

impl From<WgpuDeviceKind> for WgpuDevice

fn from(kind: WgpuDeviceKind) -> Self

Converts to this type from the input type.

impl Hash for WgpuDeviceKind

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for WgpuDeviceKind

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for WgpuDeviceKind