8 stable releases

3.2.0 Jul 9, 2021
3.1.1 Jul 6, 2021
3.1.0 Jun 30, 2021
2.0.1 Jan 31, 2019
1.0.0 Jul 18, 2018

#20 in #background

Download history 196/week @ 2024-04-03 143/week @ 2024-04-10 173/week @ 2024-04-17 193/week @ 2024-04-24 167/week @ 2024-05-01 170/week @ 2024-05-08 161/week @ 2024-05-15 181/week @ 2024-05-22 193/week @ 2024-05-29 155/week @ 2024-06-05 131/week @ 2024-06-12 165/week @ 2024-06-19 146/week @ 2024-06-26 22/week @ 2024-07-03 110/week @ 2024-07-10 124/week @ 2024-07-17

424 downloads per month
Used in 12 crates (11 directly)

Unlicense

21KB
528 lines

wallpaper crate docs

This Rust library gets and sets the desktop wallpaper/background.

The supported desktops are:

  • Windows
  • macOS
  • GNOME
  • KDE
  • Cinnamon
  • Unity
  • Budgie
  • XFCE
  • LXDE
  • MATE
  • Deepin
  • Most Wayland compositors (set only, requires swaybg)
  • i3 (set only, requires feh)

Examples

use wallpaper;

fn main() {
    // Returns the wallpaper of the current desktop.
    println!("{:?}", wallpaper::get());
    // Sets the wallpaper for the current desktop from a file path.
    wallpaper::set_from_path("/usr/share/backgrounds/gnome/adwaita-day.png").unwrap();
    // Sets the wallpaper style.
    wallpaper::set_mode(wallpaper::Mode::Crop).unwrap();
    // Returns the wallpaper of the current desktop.
    println!("{:?}", wallpaper::get());
}

If you want to set an image as background via an URL, make sure you activated the from_url feature of the wallpaper crate on Cargo.toml:

[dependencies]
wallpaper = { version = "3", features = ["from_url"] }

Then, on your main.rs:

use wallpaper;

fn main() {
    // Returns the wallpaper of the current desktop.
    println!("{:?}", wallpaper::get());
    // Sets the wallpaper for the current desktop from a URL.
    wallpaper::set_from_url("https://source.unsplash.com/random").unwrap();
    // Returns the wallpaper of the current desktop.
    println!("{:?}", wallpaper::get());
}

Dependencies

~0.3–12MB
~144K SLoC