Log of autodoc.git/autodoc.xml

1999-08-12

1999-08-12 14:01:33 by Mirar (Pontus Hagland) <pike@sort.mirar.org>

d71ce35686a8d0e4d363c591dabedfb3b6d47ff5 (478 lines) (+469/-9) ^{[

Show
| Annotate

]}
Branch: 8.0

moved MMX back to layers_oper

Rev: src/modules/Image/layer_oper.h:1.6
Rev: src/modules/Image/layers.c:1.36

2158: </arguments> </method><method name='load_layer'> <returntype> - <object>Image.Layer</object></returntype> + <object resolved='predef::Image.Layer'>Image.Layer</object></returntype> <arguments> </arguments> </method><method name='load_layer'> <returntype> - <object>Image.Layer</object></returntype> + <object resolved='predef::Image.Layer'>Image.Layer</object></returntype> <arguments><argument name='file'><type><object resolved='predef::Image.load'/></type></argument> </arguments> </method><method name='load_layer'> <returntype> - <object>Image.Layer</object></returntype> + <object resolved='predef::Image.Layer'>Image.Layer</object></returntype> <arguments><argument name='filename'><type><string/></type></argument> </arguments>
2204: </doc> </docgroup> + <docgroup homogen-name='lay' homogen-type='method'> + <method name='lay'> + <returntype> + <object resolved='predef::Image.Layer'>Image.Layer </object></returntype> + <arguments><argument><value>array(Image.Layer|mapping)</value></argument> + </arguments> + </method><method name='lay'> + <returntype> + <object resolved='predef::Image.Layer'>Image.Layer </object></returntype> + <arguments><argument><value>array(Image.Layer|mapping)</value></argument><argument name='xoffset'><type><int/></type></argument> + <argument name='yoffset'><type><int/></type></argument> + <argument name='xsize'><type><int/></type></argument> + <argument name='ysize'><type><int/></type></argument> + + </arguments> + </method><doc> + <text> + Combine layers. + </text> + <group><returns/><text> + a new layer object. + </text></group> + <group><seealso/><text> + <ref resolved='predef::Image.Layer'>Image.Layer</ref></text></group> + + </doc> + </docgroup> <module name='ANY'> <doc> <text>
5425: It isn't possible to do a modulo 256 either. (why?) </text></group> <group><seealso/><text> - <ref resolved='predef::Image.Image.`-'>`-</ref>, <ref resolved='predef::Image.Image.`+'>`+</ref>, <ref resolved='predef::Image.Image.`|'>`|</ref>, <ref resolved='predef::Image.Image.`&'>`&amp;</ref>, <ref resolved='predef::Image.Image.`*'>`*</ref>, <ref>Image.Layer</ref></text></group> + <ref resolved='predef::Image.Image.`-'>`-</ref>, <ref resolved='predef::Image.Image.`+'>`+</ref>, <ref resolved='predef::Image.Image.`|'>`|</ref>, <ref resolved='predef::Image.Image.`&'>`&amp;</ref>, <ref resolved='predef::Image.Image.`*'>`*</ref>, <ref resolved='predef::Image.Layer'>Image.Layer</ref></text></group> </doc> </docgroup>
5469: the new image object </text></group> <group><seealso/><text> - <ref resolved='predef::Image.Image.`-'>`-</ref>, <ref resolved='predef::Image.Image.`+'>`+</ref>, <ref resolved='predef::Image.Image.`|'>`|</ref>, <ref resolved='predef::Image.Image.`*'>`*</ref>, <ref>Image.Layer</ref></text></group> + <ref resolved='predef::Image.Image.`-'>`-</ref>, <ref resolved='predef::Image.Image.`+'>`+</ref>, <ref resolved='predef::Image.Image.`|'>`|</ref>, <ref resolved='predef::Image.Image.`*'>`*</ref>, <ref resolved='predef::Image.Layer'>Image.Layer</ref></text></group> </doc> </docgroup>
5518: the new image object </text></group> <group><seealso/><text> - <ref resolved='predef::Image.Image.`-'>`-</ref>, <ref resolved='predef::Image.Image.`+'>`+</ref>, <ref resolved='predef::Image.Image.`|'>`|</ref>, <ref resolved='predef::Image.Image.`&'>`&amp;</ref>, <ref>Image.Layer</ref></text></group> + <ref resolved='predef::Image.Image.`-'>`-</ref>, <ref resolved='predef::Image.Image.`+'>`+</ref>, <ref resolved='predef::Image.Image.`|'>`|</ref>, <ref resolved='predef::Image.Image.`&'>`&amp;</ref>, <ref resolved='predef::Image.Layer'>Image.Layer</ref></text></group> </doc> </docgroup>
5560: the new image object </text></group> <group><seealso/><text> - <ref resolved='predef::Image.Image.`-'>`-</ref>, <ref resolved='predef::Image.Image.`|'>`|</ref>, <ref resolved='predef::Image.Image.`&'>`&amp;</ref>, <ref resolved='predef::Image.Image.`*'>`*</ref>, <ref>Image.Layer</ref></text></group> + <ref resolved='predef::Image.Image.`-'>`-</ref>, <ref resolved='predef::Image.Image.`|'>`|</ref>, <ref resolved='predef::Image.Image.`&'>`&amp;</ref>, <ref resolved='predef::Image.Image.`*'>`*</ref>, <ref resolved='predef::Image.Layer'>Image.Layer</ref></text></group> </doc> </docgroup>
5603: the new image object </text></group> <group><seealso/><text> - <ref resolved='predef::Image.Image.`+'>`+</ref>, <ref resolved='predef::Image.Image.`|'>`|</ref>, <ref resolved='predef::Image.Image.`&'>`&amp;</ref>, <ref resolved='predef::Image.Image.`*'>`*</ref>, <ref>Image.Layer</ref>, <ref resolved='predef::Image.Image.min'>min</ref>, <ref resolved='predef::Image.Image.max'>max</ref>, <ref resolved='predef::Image.Image.`=='>`==</ref></text></group> + <ref resolved='predef::Image.Image.`+'>`+</ref>, <ref resolved='predef::Image.Image.`|'>`|</ref>, <ref resolved='predef::Image.Image.`&'>`&amp;</ref>, <ref resolved='predef::Image.Image.`*'>`*</ref>, <ref resolved='predef::Image.Layer'>Image.Layer</ref>, <ref resolved='predef::Image.Image.min'>min</ref>, <ref resolved='predef::Image.Image.max'>max</ref>, <ref resolved='predef::Image.Image.`=='>`==</ref></text></group> </doc> </docgroup>
5747: the new image object </text></group> <group><seealso/><text> - <ref resolved='predef::Image.Image.`-'>`-</ref>, <ref resolved='predef::Image.Image.`+'>`+</ref>, <ref resolved='predef::Image.Image.`&'>`&amp;</ref>, <ref resolved='predef::Image.Image.`*'>`*</ref>, <ref>Image.Layer</ref></text></group> + <ref resolved='predef::Image.Image.`-'>`-</ref>, <ref resolved='predef::Image.Image.`+'>`+</ref>, <ref resolved='predef::Image.Image.`&'>`&amp;</ref>, <ref resolved='predef::Image.Image.`*'>`*</ref>, <ref resolved='predef::Image.Layer'>Image.Layer</ref></text></group> </doc> </docgroup>
9040: </doc> </docgroup> </module> + <class name='Layer'> + <doc> + <text> + + + + <add_appendix name='layers' title='image.layer modes'> + <dl compact='compact'> + <dt>The variables in the expression: + </dt><dt>L</dt><dd>The active layer + </dd><dt>S</dt><dd>The source layer (the sum of the layers below) + </dd><dt>D</dt><dd>The destintion layer (the result) + </dd><dt>Xrgb</dt><dd>Layer red (Xr), green (Xg) or blue channel (Xb) + </dd><dt>Xhsv</dt><dd>Layer hue (Xh), saturation (Xs) or value channel (Xv) (virtual channels) + </dd><dt>aX</dt><dd>Layer alpha, channel in layer alpha + </dd></dl> + All channels are calculated separately, if nothing else is specified. + <table><tr><td align='right' valign='center'>top layer</td><td align='right'><image file='predef.Image.Layer.1.png' height='80' width='560'>layers.c.0.png</image></td><td align='left' valign='center'/></tr><tr><td align='right' valign='center'>bottom layer</td><td align='right'><image file='predef.Image.Layer.2.png' height='80' width='560'>layers.c.1.png</image></td><td align='left' valign='center'/></tr></table><table><tr><td> </td></tr><tr><td align='right' valign='center'>normal</td><td align='right'><image file='predef.Image.Layer.3.png' height='80' width='560'>layers.c.2.png</image></td><td align='left' valign='center'>D=L applied with alpha: D=(L*aL+S*(1-aL)*aS) / (aL+(1-aL)*aS), aD=(aL+(1-aL)*aS)</td></tr><tr><td> </td></tr><tr><td align='right' valign='center'>add</td><td align='right'><image file='predef.Image.Layer.4.png' height='80' width='560'>layers.c.3.png</image></td><td align='left' valign='center'>D=L+S applied with alpha, aD=aS</td></tr><tr><td align='right' valign='center'>subtract</td><td align='right'><image file='predef.Image.Layer.5.png' height='80' width='560'>layers.c.4.png</image></td><td align='left' valign='center'>D=S-L applied with alpha, aD=aS</td></tr><tr><td align='right' valign='center'>multiply</td><td align='right'><image file='predef.Image.Layer.6.png' height='80' width='560'>layers.c.5.png</image></td><td align='left' valign='center'>D=S*L applied with alpha, aD=aS</td></tr><tr><td align='right' valign='center'>divide</td><td align='right'><image file='predef.Image.Layer.7.png' height='80' width='560'>layers.c.6.png</image></td><td align='left' valign='center'>D=S/L applied with alpha, aD=aS</td></tr><tr><td align='right' valign='center'>negdivide</td><td align='right'><image file='predef.Image.Layer.8.png' height='80' width='560'>layers.c.7.png</image></td><td align='left' valign='center'>D=1.0-S/L applied with alpha, aD=aS</td></tr><tr><td align='right' valign='center'>modulo</td><td align='right'><image file='predef.Image.Layer.9.png' height='80' width='560'>layers.c.8.png</image></td><td align='left' valign='center'>D=S%L applied with alpha, aD=aS</td></tr><tr><td align='right' valign='center'>invsubtract</td><td align='right'><image file='predef.Image.Layer.10.png' height='80' width='560'>layers.c.9.png</image></td><td align='left' valign='center'>D=L-S applied with alpha, aD=aS</td></tr><tr><td align='right' valign='center'>invdivide</td><td align='right'><image file='predef.Image.Layer.11.png' height='80' width='560'>layers.c.10.png</image></td><td align='left' valign='center'>D=L/S applied with alpha, aD=aS</td></tr><tr><td align='right' valign='center'>invmodulo</td><td align='right'><image file='predef.Image.Layer.12.png' height='80' width='560'>layers.c.11.png</image></td><td align='left' valign='center'>D=L%S applied with alpha, aD=aS</td></tr><tr><td align='right' valign='center'>imultiply</td><td align='right'><image file='predef.Image.Layer.13.png' height='80' width='560'>layers.c.12.png</image></td><td align='left' valign='center'>D=(1-L)*S applied with alpha, aD=aS</td></tr><tr><td align='right' valign='center'>idivide</td><td align='right'><image file='predef.Image.Layer.14.png' height='80' width='560'>layers.c.13.png</image></td><td align='left' valign='center'>D=S/(1-L) applied with alpha, aD=aS</td></tr><tr><td align='right' valign='center'>invidivide</td><td align='right'><image file='predef.Image.Layer.15.png' height='80' width='560'>layers.c.14.png</image></td><td align='left' valign='center'>D=L/(1-S) applied with alpha, aD=aS</td></tr><tr><td align='right' valign='center'>difference</td><td align='right'><image file='predef.Image.Layer.16.png' height='80' width='560'>layers.c.15.png</image></td><td align='left' valign='center'>D=abs(L-S) applied with alpha, aD=aS</td></tr><tr><td align='right' valign='center'>max</td><td align='right'><image file='predef.Image.Layer.17.png' height='80' width='560'>layers.c.16.png</image></td><td align='left' valign='center'>D=max(L,S) applied with alpha, aD=aS</td></tr><tr><td align='right' valign='center'>min</td><td align='right'><image file='predef.Image.Layer.18.png' height='80' width='560'>layers.c.17.png</image></td><td align='left' valign='center'>D=min(L,S) applied with alpha, aD=aS</td></tr><tr><td align='right' valign='center'>bitwise_and</td><td align='right'><image file='predef.Image.Layer.19.png' height='80' width='560'>layers.c.18.png</image></td><td align='left' valign='center'>D=L&amp;S applied with alpha, aD=aS</td></tr><tr><td align='right' valign='center'>bitwise_or</td><td align='right'><image file='predef.Image.Layer.20.png' height='80' width='560'>layers.c.19.png</image></td><td align='left' valign='center'>D=L|S applied with alpha, aD=aS</td></tr><tr><td align='right' valign='center'>bitwise_xor</td><td align='right'><image file='predef.Image.Layer.21.png' height='80' width='560'>layers.c.20.png</image></td><td align='left' valign='center'>D=L^S applied with alpha, aD=aS</td></tr><tr><td> </td></tr><tr><td align='right' valign='center'>replace</td><td align='right'><image file='predef.Image.Layer.22.png' height='80' width='560'>layers.c.21.png</image></td><td align='left' valign='center'>D=(L*aL+S*(1-aL)*aS) / (aL+(1-aL)*aS), aD=aS</td></tr><tr><td align='right' valign='center'>red</td><td align='right'><image file='predef.Image.Layer.23.png' height='80' width='560'>layers.c.22.png</image></td><td align='left' valign='center'>Dr=(Lr*aLr+Sr*(1-aLr)*aSr) / (aLr+(1-aLr)*aSr), Dgb=Sgb, aD=aS</td></tr><tr><td align='right' valign='center'>green</td><td align='right'><image file='predef.Image.Layer.24.png' height='80' width='560'>layers.c.23.png</image></td><td align='left' valign='center'>Dg=(Lg*aLg+Sg*(1-aLg)*aSg) / (aLg+(1-aLg)*aSg), Drb=Srb, aD=aS</td></tr><tr><td align='right' valign='center'>blue</td><td align='right'><image file='predef.Image.Layer.25.png' height='80' width='560'>layers.c.24.png</image></td><td align='left' valign='center'>Db=(Lb*aLb+Sb*(1-aLb)*aSb) / (aLb+(1-aLb)*aSb), Drg=Srg, aD=aS</td></tr><tr><td align='right' valign='center'>hardlight</td><td align='right'><image file='predef.Image.Layer.26.png' height='80' width='560'>layers.c.25.png</image></td><td align='left' valign='center'>Like photoshop hardlight layer mode, aD=aS</td></tr><tr><td> </td></tr><tr><td align='right' valign='center'>replace_hsv</td><td align='right'><image file='predef.Image.Layer.27.png' height='80' width='560'>layers.c.26.png</image></td><td align='left' valign='center'>Dhsv=Lhsv apply with alpha, aD=aS</td></tr><tr><td align='right' valign='center'>hue</td><td align='right'><image file='predef.Image.Layer.28.png' height='80' width='560'>layers.c.27.png</image></td><td align='left' valign='center'>Dh=Lh apply with alpha, Dsv=Lsv, aD=aS</td></tr><tr><td align='right' valign='center'>saturation</td><td align='right'><image file='predef.Image.Layer.29.png' height='80' width='560'>layers.c.28.png</image></td><td align='left' valign='center'>Ds=Ls apply with alpha, Dhv=Lhv, aD=aS</td></tr><tr><td align='right' valign='center'>value</td><td align='right'><image file='predef.Image.Layer.30.png' height='80' width='560'>layers.c.29.png</image></td><td align='left' valign='center'>Dv=Lv apply with alpha, Dhs=Lhs, aD=aS</td></tr><tr><td align='right' valign='center'>color</td><td align='right'><image file='predef.Image.Layer.31.png' height='80' width='560'>layers.c.30.png</image></td><td align='left' valign='center'>Dhs=Lhs apply with alpha, Dv=Lv, aD=aS</td></tr><tr><td align='right' valign='center'>value_mul</td><td align='right'><image file='predef.Image.Layer.32.png' height='80' width='560'>layers.c.31.png</image></td><td align='left' valign='center'>Dv=Lv*Sv apply with alpha, Dhs=Lhs, aD=aS</td></tr><tr><td> </td></tr><tr><td align='right' valign='center'>darken</td><td align='right'><image file='predef.Image.Layer.33.png' height='80' width='560'>layers.c.32.png</image></td><td align='left' valign='center'>Dv=min(Lv,Sv) apply with alpha, Dhs=Lhs, aD=aS</td></tr><tr><td align='right' valign='center'>lighten</td><td align='right'><image file='predef.Image.Layer.34.png' height='80' width='560'>layers.c.33.png</image></td><td align='left' valign='center'>Dv=max(Lv,Sv) apply with alpha, Dhs=Lhs, aD=aS</td></tr><tr><td align='right' valign='center'>saturate</td><td align='right'><image file='predef.Image.Layer.35.png' height='80' width='560'>layers.c.34.png</image></td><td align='left' valign='center'>Ds=max(Ls,Ss) apply with alpha, Dhv=Lhv, aD=aS</td></tr><tr><td align='right' valign='center'>desaturate</td><td align='right'><image file='predef.Image.Layer.36.png' height='80' width='560'>layers.c.35.png</image></td><td align='left' valign='center'>Ds=min(Ls,Ss) apply with alpha, Dhv=Lhv, aD=aS</td></tr><tr><td align='right' valign='center'>hls_replace</td><td align='right'><image file='predef.Image.Layer.37.png' height='80' width='560'>layers.c.36.png</image></td><td align='left' valign='center'>Dhls=Lhls apply with alpha, aD=aS</td></tr><tr><td align='right' valign='center'>hls_hue</td><td align='right'><image file='predef.Image.Layer.38.png' height='80' width='560'>layers.c.37.png</image></td><td align='left' valign='center'>Dh=Lh apply with alpha, Dsv=Lsv, aD=aS</td></tr><tr><td align='right' valign='center'>hls_saturation</td><td align='right'><image file='predef.Image.Layer.39.png' height='80' width='560'>layers.c.38.png</image></td><td align='left' valign='center'>Ds=Ls apply with alpha, Dhv=Lhv, aD=aS</td></tr><tr><td align='right' valign='center'>hls_lightness</td><td align='right'><image file='predef.Image.Layer.40.png' height='80' width='560'>layers.c.39.png</image></td><td align='left' valign='center'>Dl=Ll apply with alpha, Dhs=Lhs, aD=aS</td></tr><tr><td align='right' valign='center'>hls_color</td><td align='right'><image file='predef.Image.Layer.41.png' height='80' width='560'>layers.c.40.png</image></td><td align='left' valign='center'>Dhs=Lhs apply with alpha, Dl=Ll, aD=aS</td></tr><tr><td align='right' valign='center'>hls_lightness_mul</td><td align='right'><image file='predef.Image.Layer.42.png' height='80' width='560'>layers.c.41.png</image></td><td align='left' valign='center'>Dl=Ll*Sl apply with alpha, Dhs=Lhs, aD=aS</td></tr><tr><td align='right' valign='center'>hls_darken</td><td align='right'><image file='predef.Image.Layer.43.png' height='80' width='560'>layers.c.42.png</image></td><td align='left' valign='center'>Dl=min(Ll,Sl) apply with alpha, Dhs=Lhs, aD=aS</td></tr><tr><td align='right' valign='center'>hls_lighten</td><td align='right'><image file='predef.Image.Layer.44.png' height='80' width='560'>layers.c.43.png</image></td><td align='left' valign='center'>Dl=max(Ll,Sl) apply with alpha, Dhs=Lhs, aD=aS</td></tr><tr><td align='right' valign='center'>hls_saturate</td><td align='right'><image file='predef.Image.Layer.45.png' height='80' width='560'>layers.c.44.png</image></td><td align='left' valign='center'>Ds=max(Ls,Ss) apply with alpha, Dhl=Lhl, aD=aS</td></tr><tr><td align='right' valign='center'>hls_desaturate</td><td align='right'><image file='predef.Image.Layer.46.png' height='80' width='560'>layers.c.45.png</image></td><td align='left' valign='center'>Ds=min(Ls,Ss) apply with alpha, Dhl=Lhl, aD=aS</td></tr><tr><td> </td></tr><tr><td align='right' valign='center'>dissolve</td><td align='right'><image file='predef.Image.Layer.47.png' height='80' width='560'>layers.c.46.png</image></td><td align='left' valign='center'>i=random 0 or 1, D=i?L:S, aD=i+aS</td></tr><tr><td align='right' valign='center'>behind</td><td align='right'><image file='predef.Image.Layer.48.png' height='80' width='560'>layers.c.47.png</image></td><td align='left' valign='center'>D=(S*aS+L*(1-aS)*aL) / (aS+(1-aS)*aL), aD=(aS+(1-aS)*aL); simply swap S and L</td></tr><tr><td align='right' valign='center'>erase</td><td align='right'><image file='predef.Image.Layer.49.png' height='80' width='560'>layers.c.48.png</image></td><td align='left' valign='center'>D=S, aD=aS*(1-aL)</td></tr><tr><td> </td></tr><tr><td align='right' valign='center'>screen</td><td align='right'><image file='predef.Image.Layer.50.png' height='80' width='560'>layers.c.49.png</image></td><td align='left' valign='center'>1-(1-S)*(1-L) applied with alpha, aD=aS</td></tr><tr><td align='right' valign='center'>overlay</td><td align='right'><image file='predef.Image.Layer.51.png' height='80' width='560'>layers.c.50.png</image></td><td align='left' valign='center'>(1-(1-a)*(1-b)-a*b)*a+a*b applied with alpha, aD=aS</td></tr><tr><td align='right' valign='center'>burn_alpha</td><td align='right'><image file='predef.Image.Layer.52.png' height='80' width='560'>layers.c.51.png</image></td><td align='left' valign='center'>aD=aL+aS applied with alpha, D=L+S; experimental, may change or be removed</td></tr><tr><td> </td></tr><tr><td align='right' valign='center'>equal</td><td align='right'><image file='predef.Image.Layer.53.png' height='80' width='560'>layers.c.52.png</image></td><td align='left' valign='center'>each channel D=max if L==S, 0 otherwise, apply with alpha</td></tr><tr><td align='right' valign='center'>not_equal</td><td align='right'><image file='predef.Image.Layer.54.png' height='80' width='560'>layers.c.53.png</image></td><td align='left' valign='center'>each channel D=max if L!=S, 0 otherwise, apply with alpha</td></tr><tr><td align='right' valign='center'>less</td><td align='right'><image file='predef.Image.Layer.55.png' height='80' width='560'>layers.c.54.png</image></td><td align='left' valign='center'>each channel D=max if L<S, 0 otherwise, apply with alpha</td></tr><tr><td align='right' valign='center'>more</td><td align='right'><image file='predef.Image.Layer.56.png' height='80' width='560'>layers.c.55.png</image></td><td align='left' valign='center'>each channel D=max if L>S, 0 otherwise, apply with alpha</td></tr><tr><td align='right' valign='center'>less_or_equal</td><td align='right'><image file='predef.Image.Layer.57.png' height='80' width='560'>layers.c.56.png</image></td><td align='left' valign='center'>each channel D=max if L<=S, 0 otherwise, apply with alpha</td></tr><tr><td align='right' valign='center'>more_or_equal</td><td align='right'><image file='predef.Image.Layer.58.png' height='80' width='560'>layers.c.57.png</image></td><td align='left' valign='center'>each channel D=max if L>=S, 0 otherwise, apply with alpha</td></tr><tr><td> </td></tr><tr><td align='right' valign='center'>logic_equal</td><td align='right'><image file='predef.Image.Layer.59.png' height='80' width='560'>layers.c.58.png</image></td><td align='left' valign='center'>logic: D=white and opaque if L==S, black and transparent otherwise</td></tr><tr><td align='right' valign='center'>logic_not_equal</td><td align='right'><image file='predef.Image.Layer.60.png' height='80' width='560'>layers.c.59.png</image></td><td align='left' valign='center'>logic: D=white and opaque if any L!=S, black and transparent otherwise</td></tr><tr><td align='right' valign='center'>logic_strict_less</td><td align='right'><image file='predef.Image.Layer.61.png' height='80' width='560'>layers.c.60.png</image></td><td align='left' valign='center'>logic: D=white and opaque if all L<S, black and transparent otherwise</td></tr><tr><td align='right' valign='center'>logic_strict_more</td><td align='right'><image file='predef.Image.Layer.62.png' height='80' width='560'>layers.c.61.png</image></td><td align='left' valign='center'>logic: D=white and opaque if all L>S, black and transparent otherwise</td></tr><tr><td align='right' valign='center'>logic_strict_less_equal</td><td align='right'><image file='predef.Image.Layer.63.png' height='80' width='560'>layers.c.62.png</image></td><td align='left' valign='center'>logic: D=white and opaque if all L<=L, black and transparent otherwise</td></tr><tr><td align='right' valign='center'>logic_strict_more_equal</td><td align='right'><image file='predef.Image.Layer.64.png' height='80' width='560'>layers.c.63.png</image></td><td align='left' valign='center'>logic: D=white and opaque if all L>=L, black and transparent otherwise</td></tr></table> + </add_appendix> + </text> + <group><seealso/><text> + <ref>layers</ref></text></group> + + </doc> + <docgroup homogen-type='method'> + <method name='set_image'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='image'><type> + <object resolved='predef::Image.Image'>Image.Image</object></type></argument> + + </arguments> + </method><method name='set_image'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='image'><type> + <object resolved='predef::Image.Image'>Image.Image</object></type></argument> + <argument name='alpha_channel'><type> + <object resolved='predef::Image.Image'>Image.Image</object></type></argument> + + </arguments> + </method><method name='image'> + <returntype> + <or><object resolved='predef::Image.Layer.set_image'/><int><min>0</min></int></or></returntype> + <arguments> + </arguments> + </method><method name='alpha'> + <returntype> + <or><object resolved='predef::Image.Layer.set_image'/><int><min>0</min></int></or></returntype> + <arguments> + </arguments> + </method><doc> + <text> + Set/change/get image and alpha channel for the layer. + You could also cancel the channels giving 0 + instead of an image object. + </text> + <group><note/><text> + image and alpha channel must be of the same size, + or canceled. + </text></group> + + </doc> + </docgroup> + <docgroup homogen-type='method'> + <method name='set_alpha_value'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='value'><type><float/></type></argument> + + </arguments> + </method><method name='alpha_value'> + <returntype> + <object>double </object></returntype> + <arguments> + </arguments> + </method><doc> + <text> + Set/get the general alpha value of this layer. + This is a float value between 0 and 1, + and is multiplied with the alpha channel. + </text> + + </doc> + </docgroup> + <docgroup homogen-type='method'> + <method name='autocrop'> + <returntype> + <object>object </object></returntype> + <arguments> + </arguments> + </method><method name='autocrop'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='left'><type> + <int><min>0</min><max>1</max></int></type></argument> + <argument name='right'><type> + <int><min>0</min><max>1</max></int></type></argument> + <argument name='top'><type> + <int><min>0</min><max>1</max></int></type></argument> + <argument name='bottom'><type> + <int><min>0</min><max>1</max></int></type></argument> + + </arguments> + </method><method name='find_autocrop'> + <returntype> + <array><valuetype><int/></valuetype></array></returntype> + <arguments> + </arguments> + </method><method name='find_autocrop'> + <returntype> + <array><valuetype><int/></valuetype></array></returntype> + <arguments><argument name='left'><type> + <int><min>0</min><max>1</max></int></type></argument> + <argument name='right'><type> + <int><min>0</min><max>1</max></int></type></argument> + <argument name='top'><type> + <int><min>0</min><max>1</max></int></type></argument> + <argument name='bottom'><type> + <int><min>0</min><max>1</max></int></type></argument> + + </arguments> + </method><doc> + <text> + This crops (of finds) a suitable crop, non-destructive crop. + The layer alpha channel is checked, and edges that is + transparent is removed. + + (What really happens is that the image and alpha channel is checked, + and edges equal the fill setup is cropped away.) + + <ref resolved='predef::Image.Layer.find_autocrop'>find_autocrop</ref>() returns an array of xoff,yoff,xsize,ysize, + which can be fed to <ref resolved='predef::Image.Layer.crop'>crop</ref>(). + + </text> + <group><note/><text> + A tiled image will not be cropped at all. + + <tt>left</tt>...<tt>bottom</tt> arguments can be used + to tell what sides cropping are ok on. + + </text></group> + <group><seealso/><text> + <ref resolved='predef::Image.Layer.crop'>crop</ref>, <ref resolved='predef::Image.Image.autocrop'>Image.Image->autocrop</ref></text></group> + + </doc> + </docgroup> + <docgroup homogen-type='method'> + <method name='set_mode'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='mode'><type><string/></type></argument> + + </arguments> + </method><method name='mode'> + <returntype> + <object>string </object></returntype> + <arguments> + </arguments> + </method><method name='available_modes'> + <returntype> + <array><valuetype><string/></valuetype></array></returntype> + <arguments> + </arguments> + </method><doc> + <text> + Set/get layer mode. Mode is one of these: + + "normal", + "add", + "subtract", + "multiply", + "divide", + "modulo", + "invsubtract", + "invdivide", + "invmodulo", + "difference", + "max", + "min", + "bitwise_and", + "bitwise_or", + "bitwise_xor", + + "replace", + "red", + "green", + "blue", + + "replace_hsv", + "hue", + "saturation", + "value", + "color", + + "darken", + "lighten", + + "dissolve", + "behind", + "erase", + + <ref resolved='predef::Image.Layer.available_modes'>available_modes</ref>() simply gives an array + containing the names of these modes. + + </text> + <group><note/><text> + image and alpha channel must be of the same size, + or canceled. + </text></group> + + </doc> + </docgroup> + <docgroup homogen-name='create' homogen-type='method'> + <method name='create'> + <returntype> + <object>void </object></returntype> + <arguments><argument name='image'><type><object resolved='predef::Image.Layer.create'/></type></argument> + <argument name='alpha'><type><object resolved='predef::Image.Layer.create'/></type></argument> + <argument name='mode'><type><string/></type></argument> + + </arguments> + </method><method name='create'> + <returntype> + <object>void </object></returntype> + <arguments><argument name='info'><type><mapping/></type></argument> + + </arguments> + </method><method name='create'> + <returntype> + <object>void </object></returntype> + <arguments> + </arguments> + </method><method name='create'> + <returntype> + <object>void </object></returntype> + <arguments><argument name='xsize'><type><int/></type></argument> + <argument name='ysize'><type><int/></type></argument> + <argument name='color'><type><object resolved='predef::Image.Layer.create'/></type></argument> + + </arguments> + </method><method name='create'> + <returntype> + <object>void </object></returntype> + <arguments><argument name='color'><type><object resolved='predef::Image.Layer.create'/></type></argument> + + </arguments> + </method><doc> + <text> + The Layer construct either three arguments, + the image object, alpha channel and mode, or + a mapping with optional elements: + <pre> + "image":image, + // default: black + + "alpha":alpha, + // alpha channel object + // default: full opaque + + "mode":string mode, + // layer mode, see <ref>mode</ref>. + // default: "normal" + + "alpha_value":float(0.0-1.0), + // layer general alpha value + // default is 1.0; this is multiplied + // with the alpha channel. + + "xoffset":int, + "yoffset":int, + // offset of this layer + + "fill":Color, + "fill_alpha":Color, + // fill color, ie what color is used + // "outside" the image. default: black + // and black (full transparency). + + "tiled":int(0|1), + // select tiling; if 1, the image + // will be tiled. deafult: 0, off + </pre> + The layer can also be created "empty", + either giving a size and color - + this will give a filled opaque square, + or a color, which will set the "fill" + values and fill the whole layer with an + opaque color. + + All values can be modified after object creation. + + </text> + <group><note/><text> + image and alpha channel must be of the same size. + + </text></group> + + </doc> + </docgroup> + <docgroup homogen-name='crop' homogen-type='method'> + <method name='crop'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='xoff'><type><int/></type></argument> + <argument name='yoff'><type><int/></type></argument> + <argument name='xsize'><type><int/></type></argument> + <argument name='ysize'><type><int/></type></argument> + + </arguments> + </method><doc> + <text> + Crops this layer at this offset and size. + Offset is not relative the layer offset, so this + can be used to crop a number of layers simuntaneously. + + The <ref resolved='predef::Image.Layer.fill'>fill</ref> values are used if the layer is + enlarged. + </text> + <group><returns/><text> + a new layer object + </text></group> + <group><note/><text> + The new layer object may have the same image object, + if there was no cropping to be done. + </text></group> + + </doc> + </docgroup> + <docgroup homogen-type='method'> + <method name='set_fill'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='color'><type> + <object resolved='predef::Image.Color'>Color</object></type></argument> + + </arguments> + </method><method name='set_fill'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='color'><type> + <object resolved='predef::Image.Color'>Color</object></type></argument> + <argument name='alpha'><type> + <object resolved='predef::Image.Color'>Color</object></type></argument> + + </arguments> + </method><method name='fill'> + <returntype> + <object>object </object></returntype> + <arguments> + </arguments> + </method><method name='fill_alpha'> + <returntype> + <object>object </object></returntype> + <arguments> + </arguments> + </method><doc> + <text> + Set/query fill color and alpha, ie the color used "outside" the + image. This is mostly useful if you want to "frame" + a layer. + </text> + + </doc> + </docgroup> + <docgroup homogen-type='method'> + <method name='set_offset'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='x'><type><int/></type></argument> + <argument name='y'><type><int/></type></argument> + + </arguments> + </method><method name='xoffset'> + <returntype> + <object>int </object></returntype> + <arguments> + </arguments> + </method><method name='yoffset'> + <returntype> + <object>int </object></returntype> + <arguments> + </arguments> + </method><doc> + <text> + Set/query layer offset. + + </text> + + </doc> + </docgroup> + <docgroup homogen-type='method'> + <method name='set_tiled'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='yes'><type><int/></type></argument> + + </arguments> + </method><method name='tiled'> + <returntype> + <object>int </object></returntype> + <arguments> + </arguments> + </method><doc> + <text> + Set/query tiled flag. If set, the + image and alpha channel will be tiled rather + then framed by the <ref resolved='predef::Image.Layer.fill'>fill</ref> values. + </text> + + </doc> + </docgroup> + <docgroup homogen-type='method'> + <method name='xsize'> + <returntype> + <object>int </object></returntype> + <arguments> + </arguments> + </method><method name='ysize'> + <returntype> + <object>int </object></returntype> + <arguments> + </arguments> + </method><doc> + <text> + Query layer offset. This is the same as layer + image/alpha image size. + </text> + + </doc> + </docgroup> + </class> <module name='PCX'> <docgroup homogen-name='_decode' homogen-type='method'> <method name='_decode'>

autodoc.git/ autodoc.xml

1999-08-12

1999-08-12 14:01:33 by Mirar (Pontus Hagland) <pike@sort.mirar.org>