wallpaper

package module

v0.0.0-...-7dd872c Latest Latest Go to latest Published: Nov 29, 2022 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

gitea.s1.thoxy.xyz/thoxy/wallpaper

Links

Open Source Insights

README ¶

wallpaper

A KDE Golang library for getting and setting the desktop background.

Installation

go get gitea.s1.thoxy.xyz/thoxy/wallpaper

Example

package main

import (
	"fmt"

	"gitea.s1.thoxy.xyz/thoxy/wallpaper"
)

func main() {
	backgrounds, err := wallpaper.Get()

	if err != nil {
		panic(err)
	}

	fmt.Println("Current wallpaper:", backgrounds)

	err = wallpaper.SetFromFile("/usr/share/backgrounds/gnome/adwaita-day.jpg", 1)
	if err != nil {
		panic(err)
	}

	err = wallpaper.SetFromURL("https://i.imgur.com/pIwrYeM.jpg", 0)
	if err != nil {
		fmt.Println(err.Error())
		panic(err)
	}
	err = wallpaper.SetFromURL("https://i.imgur.com/pIwrYeM.jpg", 1)
	if err != nil {
		panic(err)
	}
}

Supported desktops

KDE

Documentation ¶

Rendered for

Index ¶

Variables
func Get() ([]string, error)
func SetFromFile(file string, screen int) error
func SetFromURL(url string, screen int) error
func SetMode(mode Mode, screen int) 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.

Functions ¶

func Get ¶

func Get() ([]string, error)

Get returns the current wallpaper.

func SetFromFile ¶

func SetFromFile(file string, screen int) error

SetFromFile sets wallpaper from a file path.

func SetFromURL ¶

func SetFromURL(url string, screen int) error

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

func SetMode ¶

func SetMode(mode Mode, screen int) 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