Struct Gpu 

pub struct Gpu { /* private fields */ }

Type containing GPU information.

It is returned by Gpus.

use sysinfo::Gpus;

if let Ok(gpus) = Gpus::new_with_refreshed_list() {
    for gpu in &gpus {
        println!("{gpu:?}");
    }
}

Implementations

impl Gpu

pub fn pci(&self) -> &PCI

Returns the PCI of this GPU. Can be used as ID as it’s unique to this GPU.

Returns an invalid PCI Address, ffffffff:ff:ff.255, for Apple M Series GPUs.

pub fn vendor(&self) -> Option<&str>

Returns the name of the vendor of this GPU. Returns None if the information cannot be retrieved.

pub fn model(&self) -> Option<&str>

Returns the model of this GPU. Returns None if the information cannot be retrieved.

pub fn usage(&self) -> Option<f32>

Returns the % usage of this GPU.

On Linux, it’s generally very tricky to get this information, as such, only some GPUs like NVIDIA’s or AMD’s provide this information.

On macOS, the information should always be available.

On Windows, the first time you query this information, it’ll return None as it is time-diff based.

pub fn total_memory(&self) -> Option<u64>

Returns the total VRAM of this GPU in bytes.

⚠️ It does not take into account the GPU memory that is shared with the system’s RAM.

On macOS, GPUs share memory with the system, it always returns None.

Returns None if the information cannot be retrieved.

pub fn used_memory(&self) -> Option<u64>

Returns the used VRAM of this GPU in bytes.

⚠️ It does not take into account the GPU memory that is shared with the system’s RAM.

On macOS, GPUs share memory with the system, it always returns None.

Returns None if the information cannot be retrieved.

Trait Implementations

impl Debug for Gpu

Available on crate feature gpu only.

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

Formats the value using the given formatter.

impl Eq for Gpu

impl Ord for Gpu

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Gpu

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Gpu

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.