mirror of
https://github.com/amyinspace/MagicSetEditor2.git
synced 2026-06-10 13:06:59 -04:00
GenevensiS
26 lines
1.6 KiB
Plaintext
26 lines
1.6 KiB
Plaintext
Function: saturate_image
|
|
|
|
DOC_MSE_VERSION: since 0.3.9
|
|
|
|
--Usage--
|
|
> saturate_image(input: image, amount: saturation amount)
|
|
|
|
Saturate or desaturate an image. Saturation makes the colors brighter, desaturation makes the image more grey.
|
|
|
|
To saturate use an amount between @0@ (no saturation) and @1@ (super crazy, too much saturation).
|
|
|
|
To desaturate use an amount between @0@ (no desaturation) and @-1@ (convert to greyscale).
|
|
|
|
--Parameters--
|
|
! Parameter Type Description
|
|
| @input@ [[type:image]] Image to (de)saturate.
|
|
| @alpha@ [[type:double]] Saturation factor.
|
|
|
|
--Examples--
|
|
> saturate_image("image5.png", amount: 0.5) == [[Image]]
|
|
>>> saturate_image(<img src="image5.png" alt='"image5.png"' style="border:1px solid black;vertical-align:middle;margin:1px;" />, amount: 0.5) == <img src="image_saturate1.png" alt='"image_saturate1.png"' style="border:1px solid black;vertical-align:middle;margin:1px;" />
|
|
> saturate_image("image5.png", amount: -0.5) == [[Image]]
|
|
>>> saturate_image(<img src="image5.png" alt='"image5.png"' style="border:1px solid black;vertical-align:middle;margin:1px;" />, amount: -0.5) == <img src="image_saturate2.png" alt='"image_saturate2.png"' style="border:1px solid black;vertical-align:middle;margin:1px;" />
|
|
> saturate_image("image_logo.png", amount: -1) == [[Image]]
|
|
>>> saturate_image(<img src="image_logo.png" alt='"image_logo.png"' style="border:1px solid black;vertical-align:middle;margin:1px;" />, amount: -1) == <img src="image_logo_desaturate.png" alt='"image_logo_desaturate.png"' style="border:1px solid black;vertical-align:middle;margin:1px;" />
|