Module: gears.wallpaper
Functions for setting the wallpaper.
This module is deprecated, please use awful.wallpaper.
Info:
- Copyright: 2012 Uli Schlachter
-
Originally authored by: Uli Schlachter
(Full contributors list available on our github project)
Deprecated functions
| gears.wallpaper.prepare_context [deprecated] | Prepare the needed state for setting a wallpaper. | |
| gears.wallpaper.set [deprecated] | Set the current wallpaper. | |
| gears.wallpaper.centered [deprecated] | Set a centered wallpaper. | |
| gears.wallpaper.tiled [deprecated] | Set a tiled wallpaper. | |
| gears.wallpaper.maximized [deprecated] | Set a maximized wallpaper. | |
| gears.wallpaper.fit [deprecated] | Set a fitting wallpaper. | |
Deprecated functions
- gears.wallpaper.prepare_context [deprecated]
-
Prepare the needed state for setting a wallpaper.
This function returns a cairo context through which a wallpaper can be drawn.
The context is only valid for a short time and should not be saved in a
global variable.
Parameters:
- s The screen to set the wallpaper on or nil for all screens
Returns:
- The available geometry (table with entries width and height)
- A cairo context that the wallpaper should be drawn to.
- gears.wallpaper.set [deprecated]
-
Set the current wallpaper.
Parameters:
- pattern The wallpaper that should be set. This can be a cairo surface, a description for gears.color or a cairo pattern.
See also:
- gears.wallpaper.centered [deprecated]
-
Set a centered wallpaper.
Parameters:
- surf The wallpaper to center. Either a cairo surface or a file name.
- s The screen whose wallpaper should be set. Can be nil, in which case all screens are set.
- background The background color that should be used. Gets handled via gears.color. The default is black.
- scale The scale factor for the wallpaper. Default is 1 (original size).
See also:
- gears.wallpaper.tiled [deprecated]
-
Set a tiled wallpaper.
Parameters:
- surf The wallpaper to tile. Either a cairo surface or a file name.
- s The screen whose wallpaper should be set. Can be nil, in which case all screens are set.
- offset This can be set to a table with entries x and y.
- gears.wallpaper.maximized [deprecated]
-
Set a maximized wallpaper.
Parameters:
- surf The wallpaper to set. Either a cairo surface or a file name.
- s The screen whose wallpaper should be set. Can be nil, in which case all screens are set.
- ignore_aspect If this is true, the image's aspect ratio is ignored. The default is to honor the aspect ratio.
- offset This can be set to a table with entries x and y.
- gears.wallpaper.fit [deprecated]
-
Set a fitting wallpaper.
Parameters:
- surf The wallpaper to set. Either a cairo surface or a file name.
- s The screen whose wallpaper should be set. Can be nil, in which case all screens are set.
- background The background color that should be used. Gets handled via gears.color. The default is black.
See also: