https://github.com/reujab/wallpaper.rs

A cross-platform Rust library for getting and setting desktop wallpapers
https://github.com/reujab/wallpaper.rs

Last synced: about 2 months ago
JSON representation

A cross-platform Rust library for getting and setting desktop wallpapers

• Host: GitHub
• URL: https://github.com/reujab/wallpaper.rs
• Owner: reujab
• License: unlicense
• Created: 2018-01-21T01:11:43.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-02-20T10:15:59.000Z (7 months ago)
• Last Synced: 2024-06-21T18:52:58.704Z (3 months ago)
• Language: Rust
• Homepage:
• Size: 56.6 KB
• Stars: 90
• Watchers: 4
• Forks: 22
• Open Issues: 12
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# wallpaper [![crate](https://img.shields.io/crates/v/wallpaper.svg)](https://crates.io/crates/wallpaper) [![docs](https://docs.rs/wallpaper/badge.svg)](https://docs.rs/wallpaper)

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

```rust

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:

```toml

[dependencies]

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

```

Then, on your main.rs:

```rust

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());

}

```