Yet more function documentation

git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@571 0fc631ac-6414-0410-93d0-97cfa31319b6
This commit is contained in:
twanvl
2007-07-14 00:29:25 +00:00
parent 6467ff9909
commit 689def7325
53 changed files with 174 additions and 8 deletions
+28
View File
@@ -0,0 +1,28 @@
Function: linear_blend
--Usage--
> linear_blend(
> image1: image, image2: image,
> x1: coordinate, y1: coordinate,
> x2: coordinate, y2: coordinate,
> )
Blend two images together using a linear gradient.
The images must have the same size.
--Parameters--
! Parameter Type Description
| @image1@ [[type:image]] First image to blend
| @image2@ [[type:image]] Second image to blend
| @x1@,@y1@ [[type:double]] Coordinates where the gradient begins, and the first image is shown for 100%
| @x2@,@y2@ [[type:double]] Coordinates where the gradient ends, and the second image is shown for 100%
--Examples--
This gives a vertical gradient:
> linear_blend(image1: "image1.png", image2: "image2.png", x1:0, y1:0, x2:1, y2:1) == [[Image]]
<pre style="padding-top:2px;padding-bottom:2px;"> linear_blend(image1: <img src="image1.png" alt='"image1.png"' style="border:1px solid black;vertical-align:middle;" />, image2: <img src="image2.png" alt='"image2.png"' style="border:1px solid black;vertical-align:middle;" />, x1:0, y1:0, x2:1, y2:1) == <img src="image_linear_blend.png" alt='"image_linear_blend.png"' style="border:1px solid black;vertical-align:middle;" /></pre>
--See also--
| [[fun:masked_blend]] Blend two images together using a third mask image.
| [[fun:combine_blend]] Blend two images together using a given [[type:combine|combining mode]].