Enum DeviceKind 

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

Selector for the more flexible backends whose device handle is a tagged enum (e.g. WGPU, which can target a discrete/integrated/virtual GPU, a CPU adapter, an externally-created wgpu setup, or just “best available”).

The variants mirror WgpuDeviceKind from cubecl so the mapping is direct, but it is kept as a burn-owned enum so callers don’t have to depend on cubecl.

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.

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.

Notes

This identifies an already registered runtime. To register an application’s setup, use Device::wgpu_options().setup(setup).init() and retain the returned device. Clone that device to share it; do not invent an existing ID.

Trait Implementations

impl Clone for DeviceKind

fn clone(&self) -> DeviceKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceKind

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

Formats the value using the given formatter.

impl Default for DeviceKind

fn default() -> DeviceKind

Returns the “default value” for a type.

impl Eq for DeviceKind

impl Hash for DeviceKind

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

where __H: Hasher,

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 DeviceKind

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DeviceKind