wallpaper

package module

v0.0.0-...-0e57d69 Latest Latest Go to latest Published: Aug 10, 2024 License: Unlicense Imports: 14 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/edwindvinas/wallpaper

Links

Open Source Insights

README ¶

wallpaper

A cross-platform (Linux, Windows, and macOS) Golang library for getting and setting the desktop background.

Installation

go get github.com/reujab/wallpaper

Example

package main

import (
	"fmt"

	"github.com/reujab/wallpaper"
)

func main() {
	background, err := wallpaper.Get()
	check(err)
	fmt.Println("Current wallpaper:", background)

	err = wallpaper.SetFromFile("/usr/share/backgrounds/gnome/adwaita-day.jpg")
	check(err)

	err = wallpaper.SetFromURL("https://i.imgur.com/pIwrYeM.jpg")
	check(err)

	err = wallpaper.SetMode(wallpaper.Crop)
	check(err)
}

Supported desktops

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

Documentation ¶

Rendered for

Index ¶

Variables
func CheckAndSetFromFile(file string) error
func Get() (string, error)
func SetFromFile(file string) error
func SetFromURL(url string) error
func SetMode(mode Mode) error
type Mode

Constants ¶

This section is empty.

Variables ¶

View Source

var Desktop = os.Getenv("XDG_CURRENT_DESKTOP")

Desktop contains the current desktop environment on Linux. Empty string on all other operating systems.

View Source

var DesktopSession = os.Getenv("DESKTOP_SESSION")

DesktopSession is used by LXDE on Linux.

View Source

var ErrUnsupportedDE = errors.New("your desktop environment is not supported")

ErrUnsupportedDE is thrown when Desktop is not a supported desktop environment.

Functions ¶

func CheckAndSetFromFile ¶

func CheckAndSetFromFile(file string) error

func Get ¶

func Get() (string, error)

Get returns the current wallpaper.

func SetFromFile ¶

func SetFromFile(file string) error

SetFromFile sets wallpaper from a file path.

func SetFromURL ¶

func SetFromURL(url string) error

SetFromURL downloads the image to a cache directory and calls SetFromFile.

func SetMode ¶

func SetMode(mode Mode) error

SetMode sets the wallpaper mode.

Types ¶

type Mode ¶

type Mode int

const (
	Center Mode = iota
	Crop
	Fit
	Span
	Stretch
	Tile
)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
example

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL