Enum burn::backend::wgpu::WgpuDevice

pub enum WgpuDevice {
    DiscreteGpu(usize),
    IntegratedGpu(usize),
    VirtualGpu(usize),
    Cpu,
    BestAvailable,
    Existing(Id<Device>),
}

The device struct when using the wgpu backend.

Note that you need to provide the device index when using a GPU backend.

Example

use cubecl_wgpu::WgpuDevice;

let device_gpu_1 = WgpuDevice::DiscreteGpu(0); // First discrete GPU found.
let device_gpu_2 = WgpuDevice::DiscreteGpu(1);  // Second discrete GPU found.

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.

BestAvailable

The best available device found with the current graphics API.

Priority

1. DiscreteGpu
2. IntegratedGpu
3. VirtualGpu
4. Cpu

Notes

A device might be identified as Other by wgpu, in this case, we chose this device over IntegratedGpu since it’s often a discrete GPU.

Existing(Id<Device>)

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 device is indexed by the global wgpu adapter ID.

Trait Implementations

impl Clone for WgpuDevice

fn clone(&self) -> WgpuDevice

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WgpuDevice

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

Formats the value using the given formatter.

impl Default for WgpuDevice

fn default() -> WgpuDevice

Returns the “default value” for a type.

impl DeviceOps for WgpuDevice

fn id(&self) -> DeviceId

Return the device id.

impl Hash for WgpuDevice

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 WgpuDevice

fn eq(&self, other: &WgpuDevice) -> 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 Eq for WgpuDevice

impl StructuralPartialEq for WgpuDevice