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

#501 in Web programming

Download history 237/week @ 2024-12-16 135/week @ 2024-12-23 99/week @ 2024-12-30 222/week @ 2025-01-06 282/week @ 2025-01-13 263/week @ 2025-01-20 100/week @ 2025-01-27 284/week @ 2025-02-03 326/week @ 2025-02-10 131/week @ 2025-02-17 260/week @ 2025-02-24 120/week @ 2025-03-03 310/week @ 2025-03-10 239/week @ 2025-03-17 242/week @ 2025-03-24 134/week @ 2025-03-31

939 downloads per month
Used in 15 crates (14 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.2–12MB
~145K SLoC