more-wallpapers 0.1.0

crossplatform library to set desktop wallpaper per screen
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
63
64
65
66
67
68
69
70
71
72

# more-wallpapers ![License: MIT OR Apache-2.0](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue) [![more-wallpapers on crates.io](https://img.shields.io/crates/v/more-wallpapers)](https://crates.io/crates/more-wallpapers) [![more-wallpapers on docs.rs](https://docs.rs/more-wallpapers/badge.svg)](https://docs.rs/more-wallpapers) [![Source Code Repository](https://img.shields.io/badge/Code-On%20github.com-blue)](https://github.com/LuckyTurtleDev/more-wallpapers) [![more-wallpapers on deps.rs](https://deps.rs/repo/github/LuckyTurtleDev/more-wallpapers/status.svg)](https://deps.rs/repo/github/LuckyTurtleDev/more-wallpapers)

Yet another wallpaper crate, which can set a wallpapers per screen.

The main feature over other crates like [wallpaper][__link0] or [wall][__link1] is the ability to set **different wallpapers** on different screens. Currently this feature is only implemented for some enviroments. Because of this you can enable the “wallpaper” feature, which uses the [wallpaper][__link2] crate as a fallback on unsupported environments. This means you can use the additonal features of this crate and still support the large amount of supported enviroments of the [wallpaper][__link3] crate.

Currently the following enviroments are supported:

| enviroment | set wallpaper | set wallpaper per screen | requirements |
| --- |:---:|:---:| --- |
| Windows | ✅ | ❌ | `features=["wallpaper"]` |
| MacOS | ✅ | ❌ | `features=["wallpaper"]` |
| X11 | ✅ | ✅ | [xwallpaper][__link4] |
| Budgie(wayland) | ✅ | ❌ | `features=["wallpaper"]` |
| Deepin(wayland) | ✅ | ❌ | `features=["wallpaper"]` |
| GNOME(wayland) | ✅ | ❌ | `features=["wallpaper"]` |
| KDE | ✅ | ✅ | [xrandr][__link5], [dbus][__link6] |
| Mate(wayland) | ✅ | ❌ | `features=["wallpaper"]` |
| Sway | ✅ | ❌ | `features=["wallpaper"]`, [swaybg][__link7] |
| some other wayland desktops | ✅ | ❌ | `features=["wallpaper"]`, [swaybg][__link8], dektop must support wlr-layer-shell protocol and wl_output version 4 |

The information about the currently supported features are also provided by [`Enviroment`][__link9].

<br/><br/> **QuickStart / Examples:**<br/> If you would like to set only a different wallpaper for each screen and don’t care which wallpaper is used on which screen, you can use [`set_wallpapers_from_vec()`][__link10] or [`set_random_wallpapers_from_vec()`][__link11]:


```rust
use more_wallpapers::Mode;

let images = vec!["/usr/share/wallpapers/1.jpg", "/usr/share/wallpapers/2.jpg"];
more_wallpapers::set_wallpapers_from_vec(images, Mode::Crop)?;
```

For advanced wallpaper settings you can use the [`WallpaperBuilder`][__link12]:


```rust
use more_wallpapers::{Mode, WallpaperBuilder};

let fallback_images = vec!["/usr/share/wallpapers/1.jpg", "/usr/share/wallpapers/2.jpg"];
WallpaperBuilder::new()?.set_wallapers(|i, screen| -> (String, Mode) {
	if i == 0 {
		return (
			"/usr/share/wallpapers/first.jpg".to_owned(),
			Mode::default(),
		);
	}
	if screen.name == "HDMI1" {
		return ("/usr/share/wallpapers/hdmi.jpg".to_owned(), Mode::Fit);
	}
	(
		fallback_images[i % fallback_images.len()].to_owned(),
		Mode::Tile,
	)
})?;
```


 [__cargo_doc2readme_dependencies_info]: ggGkYW0AYXSEG52uRQSwBdezG6GWW8ODAbr5G6KRmT_WpUB5G9hPmBcUiIp6YXKEG3EPptE75uGfG_7IeKD-Wc6FG5Bnb10r1o_JG6Z7TFIH7_lBYWSBg29tb3JlLXdhbGxwYXBlcnNlMC4xLjBvbW9yZV93YWxscGFwZXJz
 [__link0]: https://crates.io/crates/wallpaper
 [__link1]: https://crates.io/crates/wall
 [__link10]: https://docs.rs/more-wallpapers/0.1.0/more_wallpapers/?search=set_wallpapers_from_vec
 [__link11]: https://docs.rs/more-wallpapers/0.1.0/more_wallpapers/?search=set_random_wallpapers_from_vec
 [__link12]: https://docs.rs/more-wallpapers/0.1.0/more_wallpapers/?search=more_wallpapers::WallpaperBuilder
 [__link2]: https://crates.io/crates/wallpaper
 [__link3]: https://crates.io/crates/wallpaper
 [__link4]: https://github.com/stoeckmann/xwallpaper
 [__link5]: https://gitlab.freedesktop.org/xorg/app/xrandr
 [__link6]: https://gitlab.freedesktop.org/dbus/dbus
 [__link7]: https://github.com/swaywm/swaybg
 [__link8]: https://github.com/swaywm/swaybg
 [__link9]: https://docs.rs/more-wallpapers/0.1.0/more_wallpapers/?search=more_wallpapers::Enviroment