gfxinfo 0.1.1

Rust library for querying GPU information
Documentation 
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
54
55
56
57
58
59
60
61
62

#![doc = include_str!("../README.md")]

use std::{error::Error, fmt::Debug};

// The library we use for Nvidia is cross-platform
#[cfg(all(feature = "nvidia", not(target_os = "macos")))]
mod nvidia;

#[cfg(target_os = "linux")]
mod linux;
#[cfg(target_os = "linux")]
mod platform {
  pub use crate::linux::*;
}

#[cfg(target_os = "windows")]
mod windows;
#[cfg(target_os = "windows")]
mod platform {
  pub use crate::windows::*;
}

#[cfg(target_os = "macos")]
mod macos;
#[cfg(target_os = "macos")]
mod platform {
  pub use crate::macos::*;
}

mod util;

pub trait Gpu: Debug {
  /// Get the GPU vendor (ie. AMD, Nvidia).
  fn vendor(&self) -> &str;
  // Get the GPU model (ie. Radeon RX 6800, GeForce RTX 3070).
  fn model(&self) -> &str;
  /// Get the GPU family (ie. Vega, Navi).
  fn family(&self) -> &str;
  /// Get the GPU device ID.
  fn device_id(&self) -> &u32;

  #[cfg(feature = "gpu_info")]
  fn info(&self) -> Box<dyn GpuInfo>;
}

/// Trait for providing GPU information. If any numbers return 0, they are likely unsupported or otherwise not available.
#[cfg(feature = "gpu_info")]
pub trait GpuInfo {
  /// Get the total amount of VRAM in bytes.
  fn total_vram(&self) -> u64;
  /// Get the amount of used VRAM in bytes.
  fn used_vram(&self) -> u64;
  /// Get the load percentage.
  fn load_pct(&self) -> u32;
  /// Get the GPU temperature in degrees mcelsius.
  fn temperature(&self) -> u32;
}

/// Attempts to get the currently active GPU, using vendor-specific methods.
pub fn active_gpu() -> Result<Box<dyn Gpu>, Box<dyn Error>> {
  platform::active_gpu()
}