doc: document imageScalingMode options (#709)

Document the imageScalingMode options according to swaybg, which should
be mostly universal.

Link: https://github.com/danth/stylix/pull/709

Reviewed-by: NAHO <90870942+trueNAHO@users.noreply.github.com>
This commit is contained in:
hazel 2024-12-31 09:05:32 -08:00 committed by GitHub
parent a4ed4168fb
commit f48cab39ba
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -48,10 +48,22 @@ in {
type = lib.types.enum [ "stretch" "fill" "fit" "center" "tile" ];
default = "fill";
description = ''
Wallpaper scaling mode;
Scaling mode for the wallpaper image.
This is the scaling mode your wallpaper image will use assuming it
doesnt fix your monitor perfectly
`stretch`
: Stretch the image to cover the screen.
`fill`
: Scale the image to fill the screen, potentially cropping it.
`fit`
: Scale the image to fit the screen without being cropped.
`center`
: Center the image without resizing it.
`tile`
: Tile the image to cover the screen.
'';
};