From 0864829c0a03f70e4ca50a55351bd5b8117e1016 Mon Sep 17 00:00:00 2001 From: Uli Schlachter Date: Mon, 22 Jan 2018 11:22:05 +0100 Subject: [PATCH] Add some introductionary documentation to gears.wallpaper Related-to: https://github.com/awesomeWM/awesome/issues/1373 Signed-off-by: Uli Schlachter --- lib/gears/wallpaper.lua | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/lib/gears/wallpaper.lua b/lib/gears/wallpaper.lua index 01f70f6c..f238b475 100644 --- a/lib/gears/wallpaper.lua +++ b/lib/gears/wallpaper.lua @@ -1,4 +1,23 @@ --------------------------------------------------------------------------- +-- Functions for setting the wallpaper. +-- +-- There are two levels of functionality provided by this module: +-- +-- The low-level functionality consists of two functions. +-- @{set} an already-prepared wallpaper on all screens and @{prepare_context} +-- prepares things to draw a new wallpaper. +-- +-- The low-level API can for example be used to set solid red as a wallpaper +-- (see @{gears.color} for details on the supported syntax): +-- +-- gears.wallpaper.set("#ff0000") +-- +-- Ontop of these low-level functions, the remaining functions implement more +-- useful functionality. For example, given a screen object `s`, an image can be +-- set as the wallpaper as follows: +-- +-- gears.wallpaper.maximized("path/to/image.png", s) +-- -- @author Uli Schlachter -- @copyright 2012 Uli Schlachter -- @module gears.wallpaper