Log of autodoc.git/autodoc.xml

1999-04-13

1999-04-13 12:32:50 by Mirar (Pontus Hagland) <pike@sort.mirar.org>

3250c13c28abc475d8ac4995edc0e56c21a69a7f (11929 lines) (+5964/-5965) ^{[

Show
| Annotate

]}
Branch: 8.0

Image.image -> Image.Image
Image.colortable -> Image.Colortable
Image.color -> Image.Color
Image.font -> Image.Font

Rev: src/modules/Image/blit.c:1.30
Rev: src/modules/Image/blit_layer_include.h:1.6
Rev: src/modules/Image/colors.c:1.12
Rev: src/modules/Image/colortable.c:1.65
Rev: src/modules/Image/dct.c:1.12
Rev: src/modules/Image/doc-header:1.6
Rev: src/modules/Image/encodings/bmp.c:1.4
Rev: src/modules/Image/encodings/gif.c:1.47
Rev: src/modules/Image/encodings/ilbm.c:1.9
Rev: src/modules/Image/encodings/pnm.c:1.18
Rev: src/modules/Image/encodings/x.c:1.18
Rev: src/modules/Image/encodings/xcf.c:1.6
Rev: src/modules/Image/encodings/xwd.c:1.10
Rev: src/modules/Image/font.c:1.44
Rev: src/modules/Image/image.c:1.128
Rev: src/modules/Image/matrix.c:1.18
Rev: src/modules/Image/operator.c:1.20
Rev: src/modules/Image/orient.c:1.11
Rev: src/modules/Image/pattern.c:1.15
Rev: src/modules/Image/pnm_compat.c:1.2
Rev: src/modules/Image/polyfill.c:1.27
Rev: src/modules/Image/search.c:1.9
Rev: src/modules/Image/togif.c:1.33
Rev: src/modules/Image/x.c:1.21

2286:  </text> <group><seealso/><text> - <ref resolved='predef::Image.Image'>Image</ref>, <ref resolved='predef::Image.image'>Image.image</ref>, <ref>Image.colortable</ref></text></group> + <ref resolved='predef::Image.Image'>Image</ref>, <ref resolved='predef::Image.Image'>Image.Image</ref>, <ref resolved='predef::Image.Colortable'>Image.Colortable</ref></text></group> </doc> <docgroup homogen-type='method'>
2380: </doc> </docgroup> </module> + <module name='Color'> + <doc> + <text> + + This module keeps names and easy handling + for easy color support. It gives you an easy + way to get colors from names. + + A color is here an object, containing color + information and methods for conversion, see below. + + <ref resolved='predef::Image.Color'>Image.Color</ref> can be called to make a color object. + <ref resolved='predef::Image.Color'>Image.Color()</ref> takes the following arguments: + <pre> + Image.Color(string name) // "red" + Image.Color(string prefix_string) // "lightblue" + Image.Color(string hex_name) // "#ff00ff" + Image.Color(string cmyk_string) // "%17,42,0,19.4" + Image.Color(string hsv_string) // "%@327,90,32" + Image.Color(int red, int green, int blue) + </pre> + + The color names available can be listed by using indices + on Image.Color. The colors are available by name directly + as <tt>Image.Color.name</tt>, too: + <pre> + ...Image.Color.red... + ...Image.Color.green... + or, maybe + import Image.Color; + ...red... + ...green... + ...lightgreen... + </pre> + + Giving red, green and blue values is equal to calling + <ref resolved='predef::Image.Color.rgb'>Image.Color.rgb</ref>(). + + The prefix_string method is a form for getting modified + colors, it understands all modifiers + (<ref to='image.color.color.light'>light</ref>, + <ref to='image.color.color.dark'>dark</ref>, + <ref to='image.color.color.bright'>bright</ref>, + <ref to='image.color.color.dull'>dull</ref> and + <ref to='image.color.color.neon'>neon</ref>). Simply use + "method"+"color"; (as in <tt>lightgreen</tt>, + <tt>dullmagenta</tt>, <tt>lightdullorange</tt>). + + The <tt>hex_name</tt> form is a simple + <tt>#rrggbb</tt> form, as in HTML or X-program argument. + A shorter form (<tt>#rgb</tt>) is also accepted. This + is the inverse to the <ref resolved='predef::Image.Color.Color.hex'>Image.Color.Color->hex</ref>() + method. + + The <tt>cmyk_string</tt> is a string form of giving + cmyk (cyan, magenta, yellow, black) color. These + values are floats representing percent. + + The <tt>hsv_string</tt> is another hue, saturation, value + representation, but in floats; hue is in degree range (0..360), + and saturation and value is given in percent. This is not + the same as returned or given to the <ref resolved='predef::Image.Color.hsv'>hsv</ref>() methods! + + + + </text> + <group><note/><text> + <tt>Image.Color["something"]</tt> will never(!) generate an error, + but a zero_type 0, if the color is unknown. This is enough + to give the error "not present in module", if used + as <tt>Image.Color.something</tt>, though. + + If you are using colors from for instance a webpage, you might + want to create the color from <ref resolved='predef::Image.Color.guess'>Image.Color.guess</ref>(), + since that method is more tolerant for mistakes and errors. + + <tt>Image.Color</tt>() is case- and space-sensitive. + Use <ref resolved='predef::Image.Color.guess'>Image.Color.guess</ref>() to catch all variants. + + and subtract with a space (lower_case(x)-" ") to make + sure you get all variants. + + + </text></group> + <group><seealso/><text> + <ref resolved='predef::Image.Color.Color.name'>Image.Color.Color->name</ref>, <ref resolved='predef::Image.Color.Color.rgb'>Image.Color.Color->rgb</ref>, <ref resolved='predef::Image.Color.Color'>Image.Color.Color</ref>, <ref resolved='predef::Image.Color.guess'>Image.Color.guess</ref>, <ref resolved='predef::Image.Image'>Image</ref>, <ref resolved='predef::Image.Colortable'>Image.Colortable</ref></text></group> + + </doc> + <docgroup homogen-type='method'> + <method name='_indices'> + <returntype> + <array><valuetype><string/></valuetype></array></returntype> + <arguments> + </arguments> + </method><method name='_values'> + <returntype> + <array><valuetype><object resolved='predef::Image.Color._indices'/></valuetype></array></returntype> + <arguments> + </arguments> + </method><doc> + <text> + (ie as <tt>indices(Image.Color)</tt> or <tt>values(Image.Color)</tt>) + <tt>indices</tt> gives a list of all the known color names, + <tt>values</tt> gives there corresponding objects. + </text> + <group><seealso/><text> + <ref resolved='predef::Image.Color'>Image.Color</ref></text></group> + + </doc> + </docgroup> + <docgroup homogen-type='method'> + <method name='rgb'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='red'><type><int/></type></argument> + <argument name='intgreen'><type> + <object resolved='predef::Image.Color.rgb'/></type></argument> + <argument name='intblue'><type> + <object resolved='predef::Image.Color.rgb'/></type></argument> + + </arguments> + </method><method name='hsv'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='hue'><type><int/></type></argument> + <argument name='intsaturation'><type> + <object resolved='predef::Image.Color.rgb'/></type></argument> + <argument name='intvalue'><type> + <object resolved='predef::Image.Color.rgb'/></type></argument> + + </arguments> + </method><method name='cmyk'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='c'><type><float/></type></argument> + <argument name='m'><type><float/></type></argument> + <argument name='y'><type><float/></type></argument> + <argument name='k'><type><float/></type></argument> + + </arguments> + </method><method name='greylevel'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='level'><type><int/></type></argument> + + </arguments> + </method><method name='html'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='html_color'><type><string/></type></argument> + + </arguments> + </method><doc> + <text> + Creates a new color object from given red, green and blue, + hue, saturation and value, or greylevel, in color value range. + It could also be created from cmyk values in percent. + + The <ref resolved='predef::Image.Color.html'>html</ref>() method only understands the HTML color names, + or the <tt>#rrggbb</tt> form. It is case insensitive. + + </text> + <group><returns/><text> + the created object. + </text></group> + + </doc> + </docgroup> + <docgroup homogen-name='guess' homogen-type='method'> + <method name='guess'> + <returntype> + <object>object </object></returntype> + <arguments><argument><value>string</value></argument> + </arguments> + </method><doc> + <text> + This is equivalent to + <tt><ref resolved='predef::Image.Color'>Image.Color</ref>(lower_case(str)-" ")</tt>, + and tries the color with a prepending '#' if no + corresponding color is found. + + </text> + <group><returns/><text> + a color object or zero_type + </text></group> + + </doc> + </docgroup> + <class name='Color'> + <doc> + <text> + This is the color object. It has six readable variables, + <tt>r</tt>, <tt>g</tt>, <tt>b</tt>, for the red, + green and blue values, + and <tt>h</tt>, <tt>s</tt>, <tt>v</tt>, for + the hue, saturation anv value values. + </text> + + </doc> + <docgroup homogen-name='`==' homogen-type='method'> + <method name='`=='> + <returntype> + <object>int </object></returntype> + <arguments><argument name='other_color'><type><object resolved='predef::Image.Color.Color.`=='/></type></argument> + + </arguments> + </method><method name='`=='> + <returntype> + <object>int </object></returntype> + <arguments><argument name='rgb'><type> + <array><valuetype><int/></valuetype></array></type></argument> + + </arguments> + </method><method name='`=='> + <returntype> + <object>int </object></returntype> + <arguments><argument name='greylevel'><type><int/></type></argument> + + </arguments> + </method><method name='`=='> + <returntype> + <object>int </object></returntype> + <arguments><argument name='name'><type><string/></type></argument> + + </arguments> + </method><doc> + <text> + Compares this object to another color, + or color name. Example: + <pre> + object red=Image.Color.red; + object other=Image.Color. ...; + object black=Image.Color.black; + + if (red==other) ... + if (red==({255,0,0})) ... + if (black==0) ... + if (red=="red") ... + </pre> + + </text> + <group><returns/><text> + 1 or 0 + </text></group> + <group><note/><text> + The other datatype (not color object) must be to the right! + </text></group> + <group><seealso/><text> + <ref resolved='predef::Image.Color.Color.`==.rgb'>rgb</ref>, <ref resolved='predef::Image.Color.Color.grey'>grey</ref>, <ref resolved='predef::Image.Color.Color.`==.name'>name</ref></text></group> + + </doc> + </docgroup> + <docgroup homogen-type='method'> + <method name='light'> + <returntype> + <object>object </object></returntype> + <arguments> + </arguments> + </method><method name='dark'> + <returntype> + <object>object </object></returntype> + <arguments> + </arguments> + </method><method name='neon'> + <returntype> + <object>object </object></returntype> + <arguments> + </arguments> + </method><method name='bright'> + <returntype> + <object>object </object></returntype> + <arguments> + </arguments> + </method><method name='dull'> + <returntype> + <object>object </object></returntype> + <arguments> + </arguments> + </method><doc> + <text> + Color modification methods. These returns + a new color. + <table> + <tr><th>method</th><th width='50%'>effect</th> + <th>h</th><th>s</th><th>v</th><th>as</th></tr> + <tr><td>light </td><td>raise light level</td><td>±0</td><td> ±0</td><td>+50</td> + <td><image file='predef.Image.Color.Color.light.1.png' height='20' width='20'>colors.c0.png</image> + <image file='predef.Image.Color.Color.light.2.png' height='20' width='20'>colors.c1.png</image> + <image file='predef.Image.Color.Color.light.3.png' height='20' width='20'>colors.c2.png</image> + <image file='predef.Image.Color.Color.light.4.png' height='20' width='20'>colors.c3.png</image></td></tr> + + <tr><td>dark </td><td>lower light level</td><td>±0</td><td> ±0</td><td>-50</td> + <td><image file='predef.Image.Color.Color.light.5.png' height='20' width='20'>colors.c4.png</image> + <image file='predef.Image.Color.Color.light.6.png' height='20' width='20'>colors.c5.png</image> + <image file='predef.Image.Color.Color.light.7.png' height='20' width='20'>colors.c6.png</image> + <image file='predef.Image.Color.Color.light.8.png' height='20' width='20'>colors.c7.png</image></td></tr> + + <tr><td>bright</td><td>brighter color </td><td>±0</td><td>+50</td><td>+50</td> + <td><image file='predef.Image.Color.Color.light.9.png' height='20' width='20'>colors.c8.png</image> + <image file='predef.Image.Color.Color.light.10.png' height='20' width='20'>colors.c9.png</image> + <image file='predef.Image.Color.Color.light.11.png' height='20' width='20'>colors.c10.png</image> + <image file='predef.Image.Color.Color.light.12.png' height='20' width='20'>colors.c11.png</image></td></tr> + + <tr><td>dull </td><td>greyer color </td><td>±0</td><td>-50</td><td>-50</td> + <td><image file='predef.Image.Color.Color.light.13.png' height='20' width='20'>colors.c12.png</image> + <image file='predef.Image.Color.Color.light.14.png' height='20' width='20'>colors.c13.png</image> + <image file='predef.Image.Color.Color.light.15.png' height='20' width='20'>colors.c14.png</image> + <image file='predef.Image.Color.Color.light.16.png' height='20' width='20'>colors.c15.png</image></td></tr> + + <tr><td>neon </td><td>set to extreme </td><td>±0</td><td>max</td><td>max</td> + <td><image file='predef.Image.Color.Color.light.17.png' height='20' width='20'>colors.c16.png</image> + <image file='predef.Image.Color.Color.light.18.png' height='20' width='20'>colors.c17.png</image></td></tr> + + </table> + </text> + <group><returns/><text> + the new color object + </text></group> + <group><note/><text> + The opposites may not always take each other out. + The color is maximised at white and black levels, + so, for instance + <ref resolved='predef::Image.Color'>Image.Color</ref>.white-><ref resolved='predef::Image.Color.Color.light'>light</ref>()-><ref resolved='predef::Image.Color.Color.dark'>dark</ref>() + doesn't give the white color back, but the equal to + <ref resolved='predef::Image.Color'>Image.Color</ref>.white-><ref resolved='predef::Image.Color.Color.dark'>dark</ref>(), since + white can't get any <ref resolved='predef::Image.Color.Color.light'>light</ref>er. + </text></group> + + </doc> + </docgroup> + <docgroup homogen-name='cast' homogen-type='method'> + <method name='cast'> + <returntype> + <or><array/><object>string </object></or></returntype> + <arguments> + </arguments> + </method><doc> + <text> + cast the object to an array, representing red, green + and blue (equal to <tt>-><ref resolved='predef::Image.Color.Color.rgb'>rgb</ref>()</tt>), or + to a string, giving the name (equal to <tt>-><ref resolved='predef::Image.Color.Color.name'>name</ref>()</tt>). + </text> + <group><returns/><text> + the name as string or rgb as array + </text></group> + <group><seealso/><text> + <ref resolved='predef::Image.Color.Color.rgb'>rgb</ref>, <ref resolved='predef::Image.Color.Color.name'>name</ref></text></group> + + </doc> + </docgroup> + <docgroup homogen-type='method'> + <method name='rgb'> + <returntype> + <array><valuetype><int/></valuetype></array></returntype> + <arguments> + </arguments> + </method><method name='hsv'> + <returntype> + <array><valuetype><int/></valuetype></array></returntype> + <arguments> + </arguments> + </method><method name='cmyk'> + <returntype> + <array><valuetype><int/></valuetype></array></returntype> + <arguments> + </arguments> + </method><method name='greylevel'> + <returntype> + <object>int </object></returntype> + <arguments> + </arguments> + </method><method name='greylevel'> + <returntype> + <object>int </object></returntype> + <arguments><argument name='r'><type><int/></type></argument> + <argument name='intg'><type> + <object resolved='predef::Image.Color.Color.rgb'/></type></argument> + <argument name='intb'><type> + <object resolved='predef::Image.Color.Color.rgb'/></type></argument> + + </arguments> + </method><doc> + <text> + This is methods of getting information from an + <ref resolved='predef::Image.Color.Color'>Image.Color.Color</ref> object. + + They give an array of + red, green and blue (rgb) values (color value), + hue, saturation and value (hsv) values (range as color value), + cyan, magenta, yellow, black (cmyk) values (in percent) + or the greylevel value (range as color value). + + The greylevel is calculated by weighting red, green + and blue. Default weights are 87, 127 and 41, respective, + and could be given by argument. + + </text> + <group><returns/><text> + array(int) respective int + </text></group> + <group><seealso/><text> + <ref resolved='predef::Image.Color.Color'>Image.Color.Color</ref>, <ref resolved='predef::Image.Color.Color.grey'>grey</ref></text></group> + + </doc> + </docgroup> + <docgroup homogen-name='create' homogen-type='method'> + <method name='create'> + <returntype> + <object>void </object></returntype> + <arguments><argument name='r'><type><int/></type></argument> + <argument name='g'><type><int/></type></argument> + <argument name='b'><type><int/></type></argument> + + </arguments> + </method><doc> + <text> + This is the main <ref resolved='predef::Image.Color.Color'>Image.Color.Color</ref> creation + method, mostly for internal use. + + </text> + + </doc> + </docgroup> + <docgroup homogen-name='grey' homogen-type='method'> + <method name='grey'> + <returntype> + <object>object </object></returntype> + <arguments> + </arguments> + </method><method name='grey'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='red'><type><int/></type></argument> + <argument name='green'><type><int/></type></argument> + <argument name='blue'><type><int/></type></argument> + + </arguments> + </method><doc> + <text> + Gives a new color, containing a grey color, + which is calculated by the <ref resolved='predef::Image.Color.Color.greylevel'>greylevel</ref> method. + </text> + <group><returns/><text> + a new <ref resolved='predef::Image.Color.Color'>Image.Color.Color</ref> object + </text></group> + <group><seealso/><text> + <ref resolved='predef::Image.Color.Color.greylevel'>greylevel</ref></text></group> + + </doc> + </docgroup> + <docgroup homogen-type='method'> + <method name='hex'> + <returntype> + <object>string </object></returntype> + <arguments> + </arguments> + </method><method name='hex'> + <returntype> + <object>string </object></returntype> + <arguments><argument name='n'><type><int/></type></argument> + + </arguments> + </method><method name='name'> + <returntype> + <object>string </object></returntype> + <arguments> + </arguments> + </method><method name='html'> + <returntype> + <object>string </object></returntype> + <arguments> + </arguments> + </method><doc> + <text> + Information methods. + + <ref resolved='predef::Image.Color.Color.hex'>hex</ref>() simply gives a string on the <tt>#rrggbb</tt> + format. If <tt>n</tt> is given, the number of significant + digits is set to this number. + (Ie, <tt>n=3</tt> gives <tt>#rrrgggbbb</tt>.) + + <ref resolved='predef::Image.Color.Color.name'>name</ref>() is a simplified method; + if the color exists in the database, the name is returned, + per default is the <ref resolved='predef::Image.Color.Color.hex'>hex</ref>() method use. + + <ref resolved='predef::Image.Color.Color.html'>html</ref>() gives the <tt>HTML</tt> name of + the color, or the <ref resolved='predef::Image.Color.Color.hex'>hex</ref>(2) if it isn't one + of the 16 <tt>HTML</tt> colors. + + </text> + <group><returns/><text> + a new <ref resolved='predef::Image.Color.Color'>Image.Color.Color</ref> object + </text></group> + <group><seealso/><text> + <ref resolved='predef::Image.Color.Color.rgb'>rgb</ref>, <ref resolved='predef::Image.Color.Color.hsv'>hsv</ref>, <ref resolved='predef::Image.Color'>Image.Color</ref></text></group> + + </doc> + </docgroup> + </class> + </module> <class name='Colortable'> <doc> <text>
2392: </text> <group><seealso/><text> - <ref resolved='predef::Image.Image'>Image</ref>, <ref resolved='predef::Image.image'>Image.image</ref>, <ref resolved='predef::Image.font'>Image.font</ref>, <ref resolved='predef::Image.GIF'>Image.GIF</ref></text></group> + <ref resolved='predef::Image.Image'>Image</ref>, <ref resolved='predef::Image.Image'>Image.Image</ref>, <ref resolved='predef::Image.Font'>Image.Font</ref>, <ref resolved='predef::Image.GIF'>Image.GIF</ref></text></group> </doc> <docgroup homogen-type='method'>
2514: </text> <group> <param name='with'/> - <text><ref>colortable</ref> object with colors to add</text></group> + <text><ref resolved='predef::Image.Colortable'>Colortable</ref> object with colors to add</text></group> <group><returns/><text> - the resulting new <ref>colortable</ref> object + the resulting new <ref resolved='predef::Image.Colortable'>Colortable</ref> object </text></group> </doc>
2534: </text> <group> <param name='with'/> - <text><ref>colortable</ref> object with colors to subtract</text></group> + <text><ref resolved='predef::Image.Colortable'>Colortable</ref> object with colors to subtract</text></group> <group><returns/><text> - the resulting new <ref>colortable</ref> object + the resulting new <ref resolved='predef::Image.Colortable'>Colortable</ref> object </text></group> </doc>
2559: <returntype> <object>void </object></returntype> <arguments><argument name='image'><type> - <object resolved='predef::Image.image'>Image.image</object></type></argument> + <object resolved='predef::Image.Image'>Image.Image</object></type></argument> <argument name='number'><type><int/></type></argument> </arguments>
2567: <returntype> <object>void </object></returntype> <arguments><argument name='image'><type> - <object resolved='predef::Image.image'>Image.image</object></type></argument> + <object resolved='predef::Image.Image'>Image.Image</object></type></argument> <argument name='number'><type><int/></type></argument> <argument name='needed'><type> <array><valuetype>
2604: <returntype> <object>object </object></returntype> <arguments><argument name='image'><type> - <object resolved='predef::Image.image'>Image.image</object></type></argument> + <object resolved='predef::Image.Image'>Image.Image</object></type></argument> <argument name='number'><type><int/></type></argument> </arguments>
2612: <returntype> <object>object </object></returntype> <arguments><argument name='image'><type> - <object resolved='predef::Image.image'>Image.image</object></type></argument> + <object resolved='predef::Image.Image'>Image.Image</object></type></argument> <argument name='number'><type><int/></type></argument> <argument name='needed'><type> <array><valuetype>
2724: </method><doc> <text> cast the colortable to an array or mapping, - the array consists of <ref resolved='predef::Image.Image.color'>Image.color</ref> objects + the array consists of <ref resolved='predef::Image.Color'>Image.Color</ref> objects and are not in index order. The mapping consists of - index:<ref resolved='predef::Image.Image.color'>Image.color</ref> pairs, where index is + index:<ref resolved='predef::Image.Color'>Image.Color</ref> pairs, where index is the index (int) of that color. example: <tt>(mapping)Image.Colortable(img)</tt>
3052: <td><tt>ordered()</tt></td> <td><tt>ordered (42,42,42, 8,8, 0,0, 0,1, 1,0)</tt></td> </tr><tr valign='top'> - <td/> - <td/> - <td/> - <td/> + <td><image file='predef.Image.Colortable.ordered.5.png' height='115' width='80'>colortable.c31.png</image></td> + <td><image file='predef.Image.Colortable.ordered.6.png' height='115' width='80'>colortable.c32.png</image></td> + <td><image file='predef.Image.Colortable.ordered.7.png' height='115' width='80'>colortable.c33.png</image></td> + <td><image file='predef.Image.Colortable.ordered.8.png' height='115' width='80'>colortable.c34.png</image></td> </tr></table> </text>
3138: <td>randomcube()</td> <td>randomgrey()</td> </tr><tr valign='top'> - <td/> - <td/> - <td/> + <td><image file='predef.Image.Colortable.randomcube.4.png' height='115' width='80'>colortable.c38.png</image></td> + <td><image file='predef.Image.Colortable.randomcube.5.png' height='115' width='80'>colortable.c39.png</image></td> + <td><image file='predef.Image.Colortable.randomcube.6.png' height='115' width='80'>colortable.c40.png</image></td> </tr></table> </text>
3194: <text>target number of colors </text></group> <group><returns/><text> - the new <ref>colortable</ref> object + the new <ref resolved='predef::Image.Colortable'>Colortable</ref> object </text></group> <group><note/><text> this algorithm assumes all colors are different to
3269: in the colorspace and comparing grey levels. Default factors are 3, 4 and 1; blue is much - darker than green. Compare with <ref>Image.image->grey</ref>(). + darker than green. Compare with <ref resolved='predef::Image.Image.grey'>Image.Image->grey</ref>(). </text> <group><returns/><text>
3286: </doc> </docgroup> </class> + <class name='Font'> + <doc> + <text> + + </text> + <group><note/><text> + Short technical documentation on a font file: + This object adds the text-drawing and -creation + capabilities of the <ref resolved='predef::Image.Image'>Image</ref> module. + + For simple usage, see + <ref resolved='predef::Image.Font.write'>write</ref> and <ref resolved='predef::Image.Font.load'>load</ref>. + + other methods: <ref resolved='predef::Image.Font.baseline'>baseline</ref>, + <ref resolved='predef::Image.Font.height'>height</ref>, + <ref resolved='predef::Image.Font.set_xspacing_scale'>set_xspacing_scale</ref>, + <ref resolved='predef::Image.Font.set_yspacing_scale'>set_yspacing_scale</ref>, + <ref resolved='predef::Image.Font.text_extents'>text_extents</ref> + + <pre> + struct file_head + { + unsigned INT32 cookie; - 0x464f4e54 + unsigned INT32 version; - 1 + unsigned INT32 chars; - number of chars + unsigned INT32 height; - height of font + unsigned INT32 baseline; - font baseline + unsigned INT32 o[1]; - position of char_head's + } *fh; + struct char_head + { + unsigned INT32 width; - width of this character + unsigned INT32 spacing; - spacing to next character + unsigned char data[1]; - pixmap data (1byte/pixel) + } *ch; + + version 2: + + + On-disk syntax (everything in N.B.O), int is 4 bytes, a byte is 8 bits: + + pos + 0 int cookie = 'FONT'; or 0x464f4e54 + 4 int version = 2; 1 was the old version without the last four chars + 8 int numchars; Always 256 in this version of the dump program + 12 int height; in (whole) pixels + 16 int baseline; in (whole) pixels + 20 char direction; 1==right to left, 0 is left to right + 21 char format; Font format + 22 char colortablep; Colortable format + 23 char kerningtablep; Kerning table format + + 24 int offsets[numchars]; pointers into the data, realative to &cookie. + [colortable] + [kerningtable] + + At each offset: + + + 0 int width; in pixels + 4 int spacing; in 1/1000:th of a pixels + 8 char data[]; Enough data to plot width * font->height pixels + Please note that if width is 0, there is no data. + + Font formats: + id type + 0 Raw 8bit data + 1 RLE encoded data, char length, char data, 70% more compact than raw data + 2 ZLib compressed data 60% more compact than RLE + + Colortable types: + 0 No colortable (the data is an alpha channel) + 1 24bit RGB with alpha (index->color, 256*4 bytes, rgba) + 2 8bit Greyscale with alpha (index->color, 256*2 bytes) + + Kerningtable types: + 0 No kerning table + 1 numchars*numchars entries, each a signed char with the kerning value + 2 numchar entries, each with a list of kerning pairs, like this: + int len + len * (short char, short value) + **! </pre> + + </text></group> + <group><seealso/><text> + <ref resolved='predef::Image.Image'>Image</ref>, <ref resolved='predef::Image.Image'>Image.Image</ref></text></group> + + </doc> + <docgroup homogen-name='baseline' homogen-type='method'> + <method name='baseline'> + <returntype> + <object>int </object></returntype> + <arguments> + </arguments> + </method><doc> + <group><returns/><text> + font baseline (pixels from top) + </text></group> + <group><seealso/><text> + <ref resolved='predef::Image.Font.height'>height</ref>, <ref resolved='predef::Image.Font.text_extents'>text_extents</ref></text></group> + + </doc> + </docgroup> + <docgroup homogen-name='create' homogen-type='method'> + <method name='create'> + <returntype> + <object>void </object></returntype> + <arguments><argument name='filename'><type><string/></type></argument> + + </arguments> + </method><doc> + <text> + Loads a font file to this font object. + Similar to <ref resolved='predef::Image.Font.load'>load</ref>(). + </text> + + </doc> + </docgroup> + <docgroup homogen-type='method'> + <method name='height'> + <returntype> + <object>int </object></returntype> + <arguments> + </arguments> + </method><method name='text_extents'> + <returntype> + <array><valuetype><int/></valuetype></array></returntype> + <arguments><argument name='text'><type><string/></type></argument> + <argument><value>...</value></argument> + </arguments> + </method><doc> + <text> + Calculate extents of a text-image, + that would be created by calling <ref resolved='predef::Image.Font.write'>write</ref> + with the same arguments. + </text> + <group> + <param name='text, ...'/> + <text>One or more lines of text.</text></group> + <group><returns/><text> + an array of width and height + </text></group> + <group><seealso/><text> + <ref resolved='predef::Image.Font.baseline'>baseline</ref>, <ref resolved='predef::Image.Font.text_extents'>text_extents</ref>, <ref resolved='predef::Image.Font.write'>write</ref>, <ref resolved='predef::Image.Font.height'>height</ref>, <ref resolved='predef::Image.Font.baseline'>baseline</ref></text></group> + + </doc> + </docgroup> + <docgroup homogen-name='load' homogen-type='method'> + <method name='load'> + <returntype> + <or><object resolved='predef::Image.Font.load'/><object>int </object></or></returntype> + <arguments><argument name='filename'><type><string/></type></argument> + + </arguments> + </method><doc> + <text> + Loads a font file to this font object. + </text> + <group> + <param name='filename'/> + <text>Font file + </text></group> + <group><returns/><text> + zero upon failure, font object upon success + </text></group> + <group><seealso/><text> + <ref resolved='predef::Image.Font.write'>write</ref></text></group> + + </doc> + </docgroup> + <docgroup homogen-type='method'> + <method name='set_xspacing_scale'> + <returntype> + <object>void </object></returntype> + <arguments><argument name='scale'><type><float/></type></argument> + + </arguments> + </method><method name='set_yspacing_scale'> + <returntype> + <object>void </object></returntype> + <arguments><argument name='scale'><type><float/></type></argument> + + </arguments> + </method><doc> + <text> + Set spacing scale to write characters closer + or more far away. This does not change scale + of character, only the space between them. + </text> + <group> + <param name='scale'/> + <text>what scale to use</text></group> + + </doc> + </docgroup> + <docgroup homogen-name='write' homogen-type='method'> + <method name='write'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='text'><type><string/></type></argument> + <argument><value>...</value></argument> + </arguments> + </method><doc> + <text> + Writes some text; thus creating an image object + that can be used as mask or as a complete picture. + </text> + <group> + <param name='text, ...'/> + <text>One or more lines of text.</text></group> + <group><returns/><text> + an <ref resolved='predef::Image.Image'>Image.Image</ref> object + </text></group> + <group><seealso/><text> + <ref resolved='predef::Image.Font.text_extents'>text_extents</ref>, <ref resolved='predef::Image.Font.load'>load</ref>, <ref resolved='predef::Image.Image.paste_mask'>Image.Image->paste_mask</ref>, <ref resolved='predef::Image.Image.paste_alpha_color'>Image.Image->paste_alpha_color</ref></text></group> + + </doc> + </docgroup> + </class> <module name='GIF'> <doc> <text>
3309:  </text> <group><seealso/><text> - <ref resolved='predef::Image.Image'>Image</ref>, <ref resolved='predef::Image.image'>Image.image</ref>, <ref>Image.colortable</ref></text></group> + <ref resolved='predef::Image.Image'>Image</ref>, <ref resolved='predef::Image.Image'>Image.Image</ref>, <ref resolved='predef::Image.Colortable'>Image.Colortable</ref></text></group> </doc> <docgroup homogen-name='__decode' homogen-type='method'>
3630: <group><note/><text> This function may throw errors upon illegal GIF data. This function uses <ref resolved='predef::Image.GIF.__decode'>__decode</ref>, <ref resolved='predef::Image.GIF._decode'>_decode</ref>, - <ref resolved='predef::Image.image.paste'>Image.image->paste</ref> and - <ref resolved='predef::Image.image.paste_alpha'>Image.image->paste_alpha</ref> internally. + <ref resolved='predef::Image.Image.paste'>Image.Image->paste</ref> and + <ref resolved='predef::Image.Image.paste_alpha'>Image.Image->paste_alpha</ref> internally. </text></group> <group><seealso/><text>
3751: Example: <pre> - img=<ref>Image.image</ref>([...]); + img=<ref>Image.Image</ref>([...]); [...] // make your very-nice image write(<ref>Image.GIF.encode</ref>(img)); // write it as GIF on stdout </pre>
3773: color indicates transparency. GIF has only transparent or nontransparent (no real alpha channel). You can always dither a transparency channel: - <tt>Image.colortable(my_alpha, ({({0,0,0}),({255,255,255})})) + <tt>Image.Colortable(my_alpha, ({({0,0,0}),({255,255,255})})) ->full() ->floyd_steinberg() ->map(my_alpha)</tt></text></group> <group> <param name='tr_r'/>
4033: Example: <pre> - img1=<ref>Image.image</ref>([...]); - img2=<ref>Image.image</ref>([...]); + img1=<ref>Image.Image</ref>([...]); + img2=<ref>Image.Image</ref>([...]); [...] // make your very-nice images - nct=<ref>Image.colortable</ref>([...]); // make a nice colortable + nct=<ref>Image.Colortable</ref>([...]); // make a nice colortable write(<ref>Image.GIF.header_block</ref>(xsize,ysize,nct)); // write a GIF header write(<ref>Image.GIF.render_block</ref>(img1,nct,0,0,0,10)); // write a render block write(<ref>Image.GIF.render_block</ref>(img2,nct,0,0,0,10)); // write a render block
4175:  </text> <group><seealso/><text> - <ref resolved='predef::Image.Image'>Image</ref>, <ref resolved='predef::Image.image'>Image.image</ref>, <ref>Image.colortable</ref></text></group> + <ref resolved='predef::Image.Image'>Image</ref>, <ref resolved='predef::Image.Image'>Image.Image</ref>, <ref resolved='predef::Image.Colortable'>Image.Colortable</ref></text></group> </doc> <docgroup homogen-name='__decode' homogen-type='method'>
4333: <ref resolved='predef::Image.Image.setcolor'>setcolor</ref>, <ref resolved='predef::Image.Image.setpixel'>setpixel</ref>, <ref resolved='predef::Image.Image.threshold'>threshold</ref>, - <ref>polyfill</ref> + <ref resolved='predef::Image.Image.polyfill'>polyfill</ref> operators: - <ref>`&</ref>, - <ref>`*</ref>, - <ref>`+</ref>, - <ref>`-</ref>, - <ref>`==</ref>, - <ref>`></ref>, - <ref>`<</ref>, - <ref>`|</ref> + <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.Image.`=='>`==</ref>, + <ref resolved='predef::Image.Image.`>'>`></ref>, + <ref resolved='predef::Image.Image.`<'>`<</ref>, + <ref resolved='predef::Image.Image.`|'>`|</ref> pasting images, layers: - <ref>add_layers</ref>, - <ref>paste</ref>, - <ref>paste_alpha</ref>, - <ref>paste_alpha_color</ref>, - <ref>paste_mask</ref> + <ref resolved='predef::Image.Image.add_layers'>add_layers</ref>, + <ref resolved='predef::Image.Image.paste'>paste</ref>, + <ref resolved='predef::Image.Image.paste_alpha'>paste_alpha</ref>, + <ref resolved='predef::Image.Image.paste_alpha_color'>paste_alpha_color</ref>, + <ref resolved='predef::Image.Image.paste_mask'>paste_mask</ref> getting subimages, scaling, rotating: <ref resolved='predef::Image.Image.autocrop'>autocrop</ref>, <ref resolved='predef::Image.Image.clone'>clone</ref>, <ref resolved='predef::Image.Image.copy'>copy</ref>, - <ref>dct</ref>, - <ref>mirrorx</ref>, - <ref>rotate</ref>, - <ref>rotate_ccw</ref>, - <ref>rotate_cw</ref>, - <ref>rotate_expand</ref>, - <ref>scale</ref>, - <ref>skewx</ref>, - <ref>skewx_expand</ref>, - <ref>skewy</ref>, - <ref>skewy_expand</ref> + <ref resolved='predef::Image.Image.dct'>dct</ref>, + <ref resolved='predef::Image.Image.mirrorx'>mirrorx</ref>, + <ref resolved='predef::Image.Image.rotate'>rotate</ref>, + <ref resolved='predef::Image.Image.rotate_ccw'>rotate_ccw</ref>, + <ref resolved='predef::Image.Image.rotate_cw'>rotate_cw</ref>, + <ref resolved='predef::Image.Image.rotate_expand'>rotate_expand</ref>, + <ref resolved='predef::Image.Image.scale'>scale</ref>, + <ref resolved='predef::Image.Image.skewx'>skewx</ref>, + <ref resolved='predef::Image.Image.skewx_expand'>skewx_expand</ref>, + <ref resolved='predef::Image.Image.skewy'>skewy</ref>, + <ref resolved='predef::Image.Image.skewy_expand'>skewy_expand</ref> calculation by pixels: <ref resolved='predef::Image.Image.apply_matrix'>apply_matrix</ref>,
4381: <ref resolved='predef::Image.Image.rgb_to_hsv'>rgb_to_hsv</ref>, <ref resolved='predef::Image.Image.hsv_to_rgb'>hsv_to_rgb</ref>, - <ref>average</ref>, - <ref>max</ref>, - <ref>min</ref>, - <ref>sum</ref>, - <ref>sumf</ref>, - <ref>find_min</ref>, - <ref>find_max</ref> + <ref resolved='predef::Image.Image.average'>average</ref>, + <ref resolved='predef::Image.Image.max'>max</ref>, + <ref resolved='predef::Image.Image.min'>min</ref>, + <ref resolved='predef::Image.Image.sum'>sum</ref>, + <ref resolved='predef::Image.Image.sumf'>sumf</ref>, + <ref resolved='predef::Image.Image.find_min'>find_min</ref>, + <ref resolved='predef::Image.Image.find_max'>find_max</ref> special pattern drawing: - <ref>noise</ref>, - <ref>turbulence</ref>, + <ref resolved='predef::Image.Image.noise'>noise</ref>, + <ref resolved='predef::Image.Image.turbulence'>turbulence</ref>, <ref resolved='predef::Image.Image.test'>test</ref>, <ref resolved='predef::Image.Image.tuned_box'>tuned_box</ref>, <ref resolved='predef::Image.Image.gradients'>gradients</ref> </text> <group><seealso/><text> - <ref resolved='predef::Image.Image'>Image</ref>, <ref resolved='predef::Image.font'>Image.font</ref>, <ref>Image.colortable</ref>, <ref resolved='predef::Image.X'>Image.X</ref></text></group> + <ref resolved='predef::Image.Image'>Image</ref>, <ref resolved='predef::Image.Font'>Image.Font</ref>, <ref resolved='predef::Image.Colortable'>Image.Colortable</ref>, <ref resolved='predef::Image.X'>Image.X</ref></text></group> </doc> - + <docgroup homogen-type='method'> + <method name='gif_begin'> + <returntype> + <object>string </object></returntype> + <arguments> + </arguments> + </method><method name='gif_begin'> + <returntype> + <object>string </object></returntype> + <arguments><argument name='num_colors'><type><int/></type></argument> + + </arguments> + </method><method name='gif_begin'> + <returntype> + <object>string </object></returntype> + <arguments><argument name='colors'><type> + <array><valuetype> + <array><valuetype><int/></valuetype></array></valuetype></array></type></argument> + + </arguments> + </method><method name='gif_end'> + <returntype> + <object>string </object></returntype> + <arguments> + </arguments> + </method><method name='gif_netscape_loop'> + <returntype> + <object>string </object></returntype> + <arguments><argument name='loops'><type><int/></type></argument> + + </arguments> + </method><method name='togif'> + <returntype> + <object>string </object></returntype> + <arguments> + </arguments> + </method><method name='togif'> + <returntype> + <object>string </object></returntype> + <arguments><argument name='trans_r'><type><int/></type></argument> + <argument name='trans_g'><type><int/></type></argument> + <argument name='trans_b'><type><int/></type></argument> + + </arguments> + </method><method name='togif'> + <returntype> + <object>string </object></returntype> + <arguments><argument name='num_colors'><type><int/></type></argument> + <argument name='trans_r'><type><int/></type></argument> + <argument name='trans_g'><type><int/></type></argument> + <argument name='trans_b'><type><int/></type></argument> + + </arguments> + </method><method name='togif'> + <returntype> + <object>string </object></returntype> + <arguments><argument name='colors'><type> + <array><valuetype> + <array><valuetype><int/></valuetype></array></valuetype></array></type></argument> + <argument name='trans_r'><type><int/></type></argument> + <argument name='trans_g'><type><int/></type></argument> + <argument name='trans_b'><type><int/></type></argument> + + </arguments> + </method><method name='togif_fs'> + <returntype> + <object>string </object></returntype> + <arguments> + </arguments> + </method><method name='togif_fs'> + <returntype> + <object>string </object></returntype> + <arguments><argument name='trans_r'><type><int/></type></argument> + <argument name='trans_g'><type><int/></type></argument> + <argument name='trans_b'><type><int/></type></argument> + + </arguments> + </method><method name='togif_fs'> + <returntype> + <object>string </object></returntype> + <arguments><argument name='num_colors'><type><int/></type></argument> + <argument name='trans_r'><type><int/></type></argument> + <argument name='trans_g'><type><int/></type></argument> + <argument name='trans_b'><type><int/></type></argument> + + </arguments> + </method><method name='togif_fs'> + <returntype> + <object>string </object></returntype> + <arguments><argument name='colors'><type> + <array><valuetype> + <array><valuetype><int/></valuetype></array></valuetype></array></type></argument> + <argument name='trans_r'><type><int/></type></argument> + <argument name='trans_g'><type><int/></type></argument> + <argument name='trans_b'><type><int/></type></argument> + + </arguments> + </method><method name='gif_add'> + <returntype> + <object>string </object></returntype> + <arguments> + </arguments> + </method><method name='gif_add_fs'> + <returntype> + <object>string </object></returntype> + <arguments> + </arguments> + </method><method name='gif_add_nomap'> + <returntype> + <object>string </object></returntype> + <arguments> + </arguments> + </method><method name='gif_add_fs_nomap'> + <returntype> + <object>string </object></returntype> + <arguments> + </arguments> + </method><method name='*'> + <returntype> + <object>string gif_add</object></returntype> + <arguments><argument name='x'><type><int/></type></argument> + <argument name='y'><type><int/></type></argument> + + </arguments> + </method><method name='*'> + <returntype> + <object>string gif_add</object></returntype> + <arguments><argument name='x'><type><int/></type></argument> + <argument name='y'><type><int/></type></argument> + <argument name='delay_cs'><type><int/></type></argument> + + </arguments> + </method><method name='*'> + <returntype> + <object>string gif_add</object></returntype> + <arguments><argument name='x'><type><int/></type></argument> + <argument name='y'><type><int/></type></argument> + <argument name='num_colors'><type><int/></type></argument> + <argument name='delay_cs'><type><int/></type></argument> + + </arguments> + </method><method name='*'> + <returntype> + <object>string gif_add</object></returntype> + <arguments><argument name='x'><type><int/></type></argument> + <argument name='y'><type><int/></type></argument> + <argument name='colors'><type> + <array><valuetype> + <array><valuetype><int/></valuetype></array></valuetype></array></type></argument> + <argument name='delay_cs'><type><int/></type></argument> + + </arguments> + </method><doc> + <text> + old GIF API compatibility function. Don't use + in any new code. + + <table> + <tr><td/><td>is replaced by</td></tr> + <tr><td>gif_begin</td><td><ref resolved='predef::Image.GIF.header_block'>Image.GIF.header_block</ref></td></tr> + <tr><td>gif_end</td><td><ref resolved='predef::Image.GIF.end_block'>Image.GIF.end_block</ref></td></tr> + <tr><td>gif_netscape_loop</td><td><ref resolved='predef::Image.GIF.netscape_loop_block'>Image.GIF.netscape_loop_block</ref></td></tr> + <tr><td>togif</td><td><ref resolved='predef::Image.GIF.encode'>Image.GIF.encode</ref></td></tr> + <tr><td>togif_fs</td><td><ref resolved='predef::Image.GIF.encode'>Image.GIF.encode</ref>Â¹</td></tr> + <tr><td>gif_add</td><td><ref resolved='predef::Image.GIF.render_block'>Image.GIF.render_block</ref>Â¹Â²</td></tr> + <tr><td>gif_add_fs</td><td><ref resolved='predef::Image.GIF.render_block'>Image.GIF.render_block</ref>Â¹</td></tr> + <tr><td>gif_add_nomap</td><td><ref resolved='predef::Image.GIF.render_block'>Image.GIF.render_block</ref>Â²</td></tr> + <tr><td>gif_add_fs_nomap</td><td><ref resolved='predef::Image.GIF.render_block'>Image.GIF.render_block</ref>Â¹Â²</td></tr> + </table> + + Â¹ Use <ref resolved='predef::Image.Colortable'>Image.Colortable</ref> to get whatever dithering + you want. + + Â² local map toggle is sent as an argument + + </text> + <group><returns/><text> + GIF data. + </text></group> + + </doc> + </docgroup> + <docgroup homogen-name='`&' homogen-type='method'> + <method name='`&'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='operand'><type><object resolved='predef::Image.Image.`&'/></type></argument> + + </arguments> + </method><method name='`&'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='color'><type> + <array><valuetype><int/></valuetype></array></type></argument> + + </arguments> + </method><method name='`&'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='value'><type><int/></type></argument> + + </arguments> + </method><doc> + <text> + makes a new image out of the minimum pixels values + + </text> + <group> + <param name='operand'/> + <text>the other image to compare with; + the images must have the same size.</text></group> + <group> + <param name='color'/> + <text>an array in format ({r,g,b}), this is equal + to using an uniform-colored image.</text></group> + <group> + <param name='value'/> + <text>equal to ({value,value,value}).</text></group> + <group><returns/><text> + 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 resolved='predef::Image.Image.add_layers'>add_layers</ref></text></group> + + </doc> + </docgroup> + <docgroup homogen-name='`*' homogen-type='method'> + <method name='`*'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='operand'><type><object resolved='predef::Image.Image.`*'/></type></argument> + + </arguments> + </method><method name='`*'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='color'><type> + <array><valuetype><int/></valuetype></array></type></argument> + + </arguments> + </method><method name='`*'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='value'><type><int/></type></argument> + + </arguments> + </method><doc> + <text> + Multiplies pixel values and creates a new image. + This can be useful to lower the values of an image, + making it greyer, for instance: + + <pre>image=image*128+64;</pre> + + </text> + <group> + <param name='operand'/> + <text>the other image to multiply with; + the images must have the same size.</text></group> + <group> + <param name='color'/> + <text>an array in format ({r,g,b}), this is equal + to using an uniform-colored image.</text></group> + <group> + <param name='value'/> + <text>equal to ({value,value,value}). + </text></group> + <group><returns/><text> + 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 resolved='predef::Image.Image.add_layers'>add_layers</ref></text></group> + + </doc> + </docgroup> + <docgroup homogen-name='`+' homogen-type='method'> + <method name='`+'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='operand'><type><object resolved='predef::Image.Image.`+'/></type></argument> + + </arguments> + </method><method name='`+'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='color'><type> + <array><valuetype><int/></valuetype></array></type></argument> + + </arguments> + </method><method name='`+'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='value'><type><int/></type></argument> + + </arguments> + </method><doc> + <text> + adds two images; values are truncated at 255. + </text> + <group> + <param name='operand'/> + <text>the image which to add.</text></group> + <group> + <param name='color'/> + <text>an array in format ({r,g,b}), this is equal + to using an uniform-colored image.</text></group> + <group> + <param name='value'/> + <text>equal to ({value,value,value}).</text></group> + <group><returns/><text> + 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 resolved='predef::Image.Image.add_layers'>add_layers</ref></text></group> + + </doc> + </docgroup> + <docgroup homogen-name='`-' homogen-type='method'> + <method name='`-'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='operand'><type><object resolved='predef::Image.Image.`-'/></type></argument> + + </arguments> + </method><method name='`-'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='color'><type> + <array><valuetype><int/></valuetype></array></type></argument> + + </arguments> + </method><method name='`-'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='value'><type><int/></type></argument> + + </arguments> + </method><doc> + <text> + makes a new image out of the difference + </text> + <group> + <param name='operand'/> + <text>the other image to compare with; + the images must have the same size.</text></group> + <group> + <param name='color'/> + <text>an array in format ({r,g,b}), this is equal + to using an uniform-colored image.</text></group> + <group> + <param name='value'/> + <text>equal to ({value,value,value}).</text></group> + <group><returns/><text> + 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 resolved='predef::Image.Image.add_layers'>add_layers</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> + <docgroup homogen-type='method'> + <method name='`=='> + <returntype> + <object>int </object></returntype> + <arguments><argument name='operand'><type><object resolved='predef::Image.Image.`=='/></type></argument> + + </arguments> + </method><method name='`=='> + <returntype> + <object>int </object></returntype> + <arguments><argument name='color'><type> + <array><valuetype><int/></valuetype></array></type></argument> + + </arguments> + </method><method name='`=='> + <returntype> + <object>int </object></returntype> + <arguments><argument name='value'><type><int/></type></argument> + + </arguments> + </method><method name='`<'> + <returntype> + <object>int </object></returntype> + <arguments><argument name='operand'><type><object resolved='predef::Image.Image.`=='/></type></argument> + + </arguments> + </method><method name='`<'> + <returntype> + <object>int </object></returntype> + <arguments><argument name='color'><type> + <array><valuetype><int/></valuetype></array></type></argument> + + </arguments> + </method><method name='`<'> + <returntype> + <object>int </object></returntype> + <arguments><argument name='value'><type><int/></type></argument> + + </arguments> + </method><method name='`>'> + <returntype> + <object>int </object></returntype> + <arguments><argument name='operand'><type><object resolved='predef::Image.Image.`=='/></type></argument> + + </arguments> + </method><method name='`>'> + <returntype> + <object>int </object></returntype> + <arguments><argument name='color'><type> + <array><valuetype><int/></valuetype></array></type></argument> + + </arguments> + </method><method name='`>'> + <returntype> + <object>int </object></returntype> + <arguments><argument name='value'><type><int/></type></argument> + + </arguments> + </method><doc> + <text> + Compares an image with another image or a color. + + Comparision is strict and on pixel-by-pixel basis. + (Means if not all pixel r,g,b values are + correct compared with the corresponding + pixel values, 0 is returned.) + + </text> + <group> + <param name='operand'/> + <text>the other image to compare with; + the images must have the same size.</text></group> + <group> + <param name='color'/> + <text>an array in format ({r,g,b}), this is equal + to using an uniform-colored image.</text></group> + <group> + <param name='value'/> + <text>equal to ({value,value,value}). + + </text></group> + <group><returns/><text> + true (1) or false (0). + </text></group> + <group><note/><text> + `< or `> on empty ("no image") image objects or images + with different size will result in an error. + `== is always true on two empty image objects and + always false if one and only one of the image objects + is empty or the images differs in size. + + a>=b and a<=b between objects is equal to !(a<b) and !(a>b), + which may not be what you want (since both < and > can return + false, comparing the same images). + </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 resolved='predef::Image.Image.`&'>`&amp;</ref></text></group> + + </doc> + </docgroup> + <docgroup homogen-name='`|' homogen-type='method'> + <method name='`|'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='operand'><type><object resolved='predef::Image.Image.`|'/></type></argument> + + </arguments> + </method><method name='`|'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='color'><type> + <array><valuetype><int/></valuetype></array></type></argument> + + </arguments> + </method><method name='`|'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='value'><type><int/></type></argument> + + </arguments> + </method><doc> + <text> + makes a new image out of the maximum pixels values + + </text> + <group> + <param name='operand'/> + <text>the other image to compare with; + the images must have the same size.</text></group> + <group> + <param name='color'/> + <text>an array in format ({r,g,b}), this is equal + to using an uniform-colored image.</text></group> + <group> + <param name='value'/> + <text>equal to ({value,value,value}).</text></group> + <group><returns/><text> + 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 resolved='predef::Image.Image.add_layers'>add_layers</ref></text></group> + + </doc> + </docgroup> + <docgroup homogen-name='add_layers' homogen-type='method'> + <method name='add_layers'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='layer0'><type> + <array><valuetype> + <or><int/><object resolved='predef::Image.Image.add_layers'/></or></valuetype></array></type></argument> + <argument><value>...</value></argument> + </arguments> + </method><method name='add_layers'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='x1'><type><int/></type></argument> + <argument name='y1'><type><int/></type></argument> + <argument name='x2'><type><int/></type></argument> + <argument name='y2'><type><int/></type></argument> + <argument name='layer0'><type> + <array><valuetype> + <or><int/><object resolved='predef::Image.Image.add_layers'/></or></valuetype></array></type></argument> + <argument><value>...</value></argument> + </arguments> + </method><doc> + <text> + Using the called object as base, adds layers using masks, + opaque channel values and special methods. + + The destination image can also be cropped, thus + speeding up the process. + + Each array in the layers array is one of: + <pre> + ({object image,object|int mask}) + ({object image,object|int mask,int opaque_value}) + ({object image,object|int mask,int opaque_value,int method}) + </pre> + Given 0 as mask means the image is totally opaque. + + Default opaque value is 255, only using the mask. + + Methods for now are: + <pre> + 0 no operation (just paste with mask, default) + 1 maximum (`|) + 2 minimum (`&) + 3 multiply (`*) + 4 add (`+) + 5 diff (`-) + </pre> + The layer image and the current source are calculated + through the given method and then pasted using the mask + and the opaque channel value. + + All given images must be the same size. + + </text> + <group> + <param name='layer0'/> + <text>image to paste</text></group> + <group> + <param name='x1'/> + <param name='y1'/> + <param name='x2'/> + <param name='y2'/> + <text>rectangle for cropping + </text></group> + <group><returns/><text> + a new image object + </text></group> + <group><seealso/><text> + <ref resolved='predef::Image.Image.paste_mask'>paste_mask</ref>, <ref resolved='predef::Image.Image.paste_alpha'>paste_alpha</ref>, <ref resolved='predef::Image.Image.paste_alpha_color'>paste_alpha_color</ref>, <ref resolved='predef::Image.Image.`|'>`|</ref>, <ref resolved='predef::Image.Image.`&'>`&amp;</ref>, <ref resolved='predef::Image.Image.`*'>`*</ref>, <ref resolved='predef::Image.Image.`+'>`+</ref>, <ref resolved='predef::Image.Image.`-'>`-</ref></text></group> + + </doc> + </docgroup> <docgroup homogen-name='apply_matrix' homogen-type='method'> <method name='apply_matrix'> <returntype>
4532: </doc> </docgroup> + <docgroup homogen-name='apply_max' homogen-type='method'> + <method name='apply_max'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='matrix'><type> + <array><valuetype> + <array><valuetype> + <or><int/><array><valuetype><int/></valuetype></array></or></valuetype></array></valuetype></array></type></argument> + + </arguments> + </method><method name='apply_max'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='matrix'><type> + <array><valuetype> + <array><valuetype> + <or><int/><array><valuetype><int/></valuetype></array></or></valuetype></array></valuetype></array></type></argument> + <argument name='r'><type><int/></type></argument> + <argument name='g'><type><int/></type></argument> + <argument name='b'><type><int/></type></argument> + + </arguments> + </method><method name='apply_max'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='matrix'><type> + <array><valuetype> + <array><valuetype> + <or><int/><array><valuetype><int/></valuetype></array></or></valuetype></array></valuetype></array></type></argument> + <argument name='r'><type><int/></type></argument> + <argument name='g'><type><int/></type></argument> + <argument name='b'><type><int/></type></argument> + <argument name='div'><type> + <or><int/><float/></or></type></argument> + + </arguments> + </method><doc> + <text> + This is the same as apply_matrix, but it uses the maximum + instead. + + This function is not very fast. + + </text> + <group> + <param name='array'/> + <text>the matrix; innermost is a value or an array with red, green, blue + values for red, green, blue separation.</text></group> + <group> + <param name='r'/> + <param name='g'/> + <param name='b'/> + <text>base level of result, default is zero</text></group> + <group> + <param name='div'/> + <text>division factor, default is 1.0.</text></group> + <group><returns/><text> + the new image object + </text></group> + + </doc> + </docgroup> <docgroup homogen-name='autocrop' homogen-type='method'> <method name='autocrop'> <returntype>
4608: </doc> </docgroup> + <docgroup homogen-type='method'> + <method name='average'> + <returntype> + <array><valuetype><float/></valuetype></array></returntype> + <arguments> + </arguments> + </method><method name='min'> + <returntype> + <array><valuetype><int/></valuetype></array></returntype> + <arguments> + </arguments> + </method><method name='max'> + <returntype> + <array><valuetype><int/></valuetype></array></returntype> + <arguments> + </arguments> + </method><method name='sum'> + <returntype> + <array><valuetype><int/></valuetype></array></returntype> + <arguments> + </arguments> + </method><method name='sumf'> + <returntype> + <array><valuetype><float/></valuetype></array></returntype> + <arguments> + </arguments> + </method><doc> + <text> + Gives back the average, minimum, maximum color value, + and the sum of all pixel's color value. + + </text> + <group><note/><text> + sum() values can wrap! Most systems only have 31 bits + available for positive integers. (Meaning, be careful + with images that have more than 8425104 pixels.) + + average() and sumf() may also wrap, but on a line basis. + (Meaning, be careful with images that are wider + than 8425104 pixels.) These functions may have a precision + problem instead, during to limits in the 'double' C type and/or + 'float' Pike type. + </text></group> + + </doc> + </docgroup> <docgroup homogen-name='box' homogen-type='method'> <method name='box'> <returntype>
4687: <text> Cast the image to another datatype. Currently supported are string ("rgbrgbrgb...") and array (double array - of <ref resolved='predef::Image.Image.color'>Image.color</ref> objects). + of <ref resolved='predef::Image.Color'>Image.Color</ref> objects). </text> <group><seealso/><text> - <ref resolved='predef::Image.Image.color'>Image.color</ref>, <ref resolved='predef::Image.X'>Image.X</ref></text></group> + <ref resolved='predef::Image.Color'>Image.Color</ref>, <ref resolved='predef::Image.X'>Image.X</ref></text></group> </doc> </docgroup>
4719: <text> Changes one color (exakt match) to another. If non-exakt-match is preferred, check <ref resolved='predef::Image.Image.distancesq'>distancesq</ref> - and <ref>paste_alpha_color</ref>. + and <ref resolved='predef::Image.Image.paste_alpha_color'>paste_alpha_color</ref>. </text> <group> <param name='tor'/>
4982: the new image object </text></group> <group><seealso/><text> - <ref resolved='predef::Image.Image.grey'>grey</ref>, <ref>`*</ref>, <ref resolved='predef::Image.Image.modify_by_intensity'>modify_by_intensity</ref></text></group> + <ref resolved='predef::Image.Image.grey'>grey</ref>, <ref resolved='predef::Image.Image.`*'>`*</ref>, <ref resolved='predef::Image.Image.modify_by_intensity'>modify_by_intensity</ref></text></group> </doc> </docgroup>
5139: </doc> </docgroup> + <docgroup homogen-name='dct' homogen-type='method'> + <method name='dct'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='newx'><type><int/></type></argument> + <argument name='newy'><type><int/></type></argument> + + </arguments> + </method><doc> + <text> + Scales the image to a new size. + + Method for scaling is rather complex; + the image is transformed via a cosine transform, + and then resampled back. + + This gives a quality-conserving upscale, + but the algorithm used is n*n+n*m, where n + and m is pixels in the original and new image. + + Recommended wrapping algorithm is to scale + overlapping parts of the image-to-be-scaled. + + This functionality is actually added as an + true experiment, but works... + + </text> + <group> + <param name='newx'/> + <param name='newy'/> + <text>new image size in pixels + </text></group> + <group><returns/><text> + the new image object + </text></group> + <group><note/><text> + Do NOT use this function if you don't know what + you're dealing with! Read some signal theory first... + </text></group> + + </doc> + </docgroup> <docgroup homogen-name='distancesq' homogen-type='method'> <method name='distancesq'> <returntype>
5198: </doc> </docgroup> + <docgroup homogen-type='method'> + <method name='find_min'> + <returntype> + <array><valuetype><int/></valuetype></array></returntype> + <arguments> + </arguments> + </method><method name='find_max'> + <returntype> + <array><valuetype><int/></valuetype></array></returntype> + <arguments> + </arguments> + </method><method name='find_min'> + <returntype> + <array><valuetype><int/></valuetype></array></returntype> + <arguments><argument name='r'><type><int/></type></argument> + <argument name='g'><type><int/></type></argument> + <argument name='b'><type><int/></type></argument> + + </arguments> + </method><method name='find_max'> + <returntype> + <array><valuetype><int/></valuetype></array></returntype> + <arguments><argument name='r'><type><int/></type></argument> + <argument name='g'><type><int/></type></argument> + <argument name='b'><type><int/></type></argument> + + </arguments> + </method><doc> + <text> + Gives back the position of the minimum or maximum + pixel value, weighted to grey. + + </text> + <group> + <param name='r'/> + <param name='g'/> + <param name='b'/> + <text>weight of color, default is r=87,g=127,b=41, same + as the <ref resolved='predef::Image.Image.grey'>grey</ref>() method.</text></group> + + </doc> + </docgroup> + <docgroup homogen-type='method'> + <method name='frompnm'> + <returntype> + <or><object resolved='predef::Image.Image.frompnm'/><object>string </object></or></returntype> + <arguments><argument name='pnm'><type><string/></type></argument> + + </arguments> + </method><method name='fromppm'> + <returntype> + <or><object resolved='predef::Image.Image.frompnm'/><object>string </object></or></returntype> + <arguments><argument name='pnm'><type><string/></type></argument> + + </arguments> + </method><doc> + <text> + compability method - do not use in new programs. + + See <ref resolved='predef::Image.PNM.decode'>Image.PNM.decode</ref>(). + + </text> + <group> + <param name='pnm'/> + <text>pnm data, as a string</text></group> + <group><returns/><text> + the called object or a hint of what wronged. + </text></group> + + </doc> + </docgroup> <docgroup homogen-name='gamma' homogen-type='method'> <method name='gamma'> <returntype>
5236: a new image object </text></group> <group><seealso/><text> - <ref resolved='predef::Image.Image.grey'>grey</ref>, <ref>`*</ref>, <ref resolved='predef::Image.Image.color'>color</ref></text></group> + <ref resolved='predef::Image.Image.grey'>grey</ref>, <ref resolved='predef::Image.Image.`*'>`*</ref>, <ref resolved='predef::Image.Image.color'>color</ref></text></group> </doc> </docgroup>
5348: the new image object </text></group> <group><seealso/><text> - <ref resolved='predef::Image.Image.color'>color</ref>, <ref>`*</ref>, <ref resolved='predef::Image.Image.modify_by_intensity'>modify_by_intensity</ref></text></group> + <ref resolved='predef::Image.Image.color'>color</ref>, <ref resolved='predef::Image.Image.`*'>`*</ref>, <ref resolved='predef::Image.Image.modify_by_intensity'>modify_by_intensity</ref></text></group> </doc> </docgroup>
5516: </doc> </docgroup> + <docgroup homogen-name='make_ascii' homogen-type='method'> + <method name='make_ascii'> + <returntype> + <object>string </object></returntype> + <arguments><argument name='orient1'><type><object resolved='predef::Image.Image.make_ascii'/></type></argument> + <argument name='objectorient2'><type> + <object resolved='predef::Image.Image.make_ascii'/></type></argument> + <argument name='objectorient3'><type> + <object resolved='predef::Image.Image.make_ascii'/></type></argument> + <argument name='objectorient4'><type> + <object resolved='predef::Image.Image.make_ascii'/></type></argument> + <argument name='int|voidxsize'><type> + <object resolved='predef::Image.Image.make_ascii'/></type></argument> + <argument name='int|voidysize'><type> + <object resolved='predef::Image.Image.make_ascii'/></type></argument> + + </arguments> + </method><doc> + <text> + This method creates a string that looks like + the image. Example: + <pre> + //Stina is an image with a cat. + array(object) Stina4=Stina->orient4(); + Stina4[1]*=215; + Stina4[3]*=215; + string foo=Stina->make_ascii(@Stina4,40,4,8); + </pre> + + </text> + <group><returns/><text> + some nice acsii-art. + </text></group> + <group><note/><text> + Experimental. + <pre> | / - \ + hue= 0 64 128 192 (=red in an hsv image) + </pre> + </text></group> + <group><seealso/><text> + <ref resolved='predef::Image.Image.orient'>orient</ref>, <ref resolved='predef::Image.Image.orient4'>orient4</ref></text></group> + + </doc> + </docgroup> <docgroup homogen-type='method'> <method name='map_closest'> <returntype>
5556: Old code: <pre>img=map_fs(img->select_colors(200));</pre> New code: - <pre>img=Image.colortable(img,200)->floyd_steinberg()->map(img);</pre> + <pre>img=Image.Colortable(img,200)->floyd_steinberg()->map(img);</pre> Old code: <pre>img=map_closest(img->select_colors(17)+({({255,255,255}),({0,0,0})}));</pre> New code: - <pre>img=Image.colortable(img,19,({({255,255,255}),({0,0,0})}))->map(img);</pre> + <pre>img=Image.Colortable(img,19,({({255,255,255}),({0,0,0})}))->map(img);</pre> </text> </doc> </docgroup> - + <docgroup homogen-name='match' homogen-type='method'> + <method name='match'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='scale'><type> + <or><int/><float/></or></type></argument> + <argument name='objectneedle'><type> + <object resolved='predef::Image.Image.match'/></type></argument> + + </arguments> + </method><method name='match'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='scale'><type> + <or><int/><float/></or></type></argument> + <argument name='objectneedle'><type> + <object resolved='predef::Image.Image.match'/></type></argument> + <argument name='objecthaystack_cert'><type> + <object resolved='predef::Image.Image.match'/></type></argument> + <argument name='objectneedle_cert'><type> + <object resolved='predef::Image.Image.match'/></type></argument> + + </arguments> + </method><method name='match'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='scale'><type> + <or><int/><float/></or></type></argument> + <argument name='objectneedle'><type> + <object resolved='predef::Image.Image.match'/></type></argument> + <argument name='objecthaystack_avoid'><type> + <object resolved='predef::Image.Image.match'/></type></argument> + <argument name='intfoo'><type> + <object resolved='predef::Image.Image.match'/></type></argument> + + </arguments> + </method><method name='match'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='scale'><type> + <or><int/><float/></or></type></argument> + <argument name='objectneedle'><type> + <object resolved='predef::Image.Image.match'/></type></argument> + <argument name='objecthaystack_cert'><type> + <object resolved='predef::Image.Image.match'/></type></argument> + <argument name='objectneedle_cert'><type> + <object resolved='predef::Image.Image.match'/></type></argument> + <argument name='objecthaystack_avoid'><type> + <object resolved='predef::Image.Image.match'/></type></argument> + <argument name='intfoo'><type> + <object resolved='predef::Image.Image.match'/></type></argument> + + </arguments> + </method><doc> + <text> + This method creates an image that describes the + match in every pixel in the image and the + needle-Image. + + <pre> + new pixel value = + sum( abs(needle_pixel-haystack_pixel)) + </pre> + + The new image only have the red rgb-part set. + + + </text> + <group> + <param name='scale'/> + <text>Every pixel is divided with this value. + Note that a proper value here depends on + the size of the neadle. + </text></group> + <group> + <param name='needle'/> + <text>The image to use for the matching. + </text></group> + <group> + <param name='haystack_cert'/> + <text>This image should be the same size as + the image itselves. A non-white-part of the + haystack_cert-image modifies the output + by lowering it. + </text></group> + <group> + <param name='needle_cert'/> + <text>The same, but for the needle-image. + </text></group> + <group> + <param name='foo'/> + <param name='haystack_avoid'/> + <text>This image should be the same size as + the image itselves. If foo is less than the red + value in haystack_avoid the corresponding + matching-calculating is not calculated. The avoided parts + are drawn in the color 0,100,0. + </text></group> + <group><returns/><text> + the new image object + </text></group> + <group><note/><text> + Experimental. + </text></group> + <group><seealso/><text> + <ref resolved='predef::Image.Image.phasev'>phasev</ref>, <ref resolved='predef::Image.Image.phaseh'>phaseh</ref></text></group> + + </doc> + </docgroup> + <docgroup homogen-name='mirrorx' homogen-type='method'> + <method name='mirrorx'> + <returntype> + <object>object </object></returntype> + <arguments> + </arguments> + </method><doc> + <text> + mirrors an image: + <table><tr valign='center'> + <td><image file='predef.Image.Image.mirrorx.1.png' height='115' width='80'>matrix.c0.png</image></td> + <td><image file='predef.Image.Image.mirrorx.2.png' height='115' width='80'>matrix.c1.png</image></td> + </tr><tr valign='center'> + <td>original</td> + <td>->mirrorx();</td> + </tr></table> + </text> + <group><returns/><text> + the new image object + </text></group> + + </doc> + </docgroup> + <docgroup homogen-name='mirrory' homogen-type='method'> + <method name='mirrory'> + <returntype> + <object>object </object></returntype> + <arguments> + </arguments> + </method><doc> + <text> + mirrors an image: + <table><tr valign='center'> + <td><image file='predef.Image.Image.mirrory.1.png' height='115' width='80'>matrix.c2.png</image></td> + <td><image file='predef.Image.Image.mirrory.2.png' height='115' width='80'>matrix.c3.png</image></td> + </tr><tr valign='center'> + <td>original</td> + <td>->mirrory();</td> + </tr></table> + + </text> + + </doc> + </docgroup> <docgroup homogen-name='modify_by_intensity' homogen-type='method'> <method name='modify_by_intensity'> <returntype>
5613: the new image object </text></group> <group><seealso/><text> - <ref resolved='predef::Image.Image.grey'>grey</ref>, <ref>`*</ref>, <ref resolved='predef::Image.Image.color'>color</ref></text></group> + <ref resolved='predef::Image.Image.grey'>grey</ref>, <ref resolved='predef::Image.Image.`*'>`*</ref>, <ref resolved='predef::Image.Image.color'>color</ref></text></group> </doc> </docgroup> - + <docgroup homogen-name='noise' homogen-type='method'> + <method name='noise'> + <returntype> + <object>void </object></returntype> + <arguments><argument name='colorrange'><type> + <array><valuetype> + <or><float/><int/><array><valuetype><int/></valuetype></array></or></valuetype></array></type></argument> + + </arguments> + </method><method name='noise'> + <returntype> + <object>void </object></returntype> + <arguments><argument name='colorrange'><type> + <array><valuetype> + <or><float/><int/><array><valuetype><int/></valuetype></array></or></valuetype></array></type></argument> + <argument name='scale'><type><float/></type></argument> + <argument name='xdiff'><type><float/></type></argument> + <argument name='ydiff'><type><float/></type></argument> + <argument name='cscale'><type><float/></type></argument> + + </arguments> + </method><doc> + <text> + Gives a new image with the old image's size, + filled width a 'noise' pattern. + + The random seed may be different with each instance of pike. + + Example: + <tt>->noise( ({0,({255,0,0}), 0.3,({0,255,0}), 0.6,({0,0,255}), 0.8,({255,255,0})}), 0.2,0.0,0.0,1.0 );</tt> + <image file='predef.Image.Image.noise.1.png' height='100' width='200'>pattern.c0.png</image> + + </text> + <group> + <param name='colorrange'/> + <text>colorrange table</text></group> + <group> + <param name='scale'/> + <text>default value is 0.1</text></group> + <group> + <param name='xdiff'/> + <param name='ydiff'/> + <text>default value is 0,0</text></group> + <group> + <param name='cscale'/> + <text>default value is 1</text></group> + <group><seealso/><text> + <ref resolved='predef::Image.Image.turbulence'>turbulence</ref></text></group> + + </doc> + </docgroup> <docgroup homogen-type='method'> - + <method name='orient'> + <returntype> + <object>object </object></returntype> + <arguments><argument><value>void|array(object)</value></argument> + </arguments> + </method><method name='orient4'> + <returntype> + <array><valuetype><object resolved='predef::Image.Image.orient'/></valuetype></array></returntype> + <arguments> + </arguments> + </method><doc> + <text> + Draws images describing the orientation + of the current image. + + <tt>orient</tt> gives an HSV image + (run a <ref resolved='predef::Image.Image.hsv_to_rgb'>hsv_to_rgb</ref> pass on it + to get a viewable image). + corresponding to the angle of the + orientation: + <pre> | / - \ + hue= 0 64 128 192 (=red in an hsv image) + purple cyan green red + </pre> + Red, green and blue channels are added + and not compared separately. + + If you first use orient4 you can give its + output as input to this function. + + The <tt>orient4</tt> function gives back + 4 image objects, corresponding to the + amount of different directions, see above. + + </text> + <group><returns/><text> + an image or an array of the four new image objects + </text></group> + <group><note/><text> + experimental status; may not be exact the same + output in later versions + </text></group> + + </doc> + </docgroup> + <docgroup homogen-type='method'> <method name='outline'> <returntype> <object>object </object></returntype>
5759: </doc> </docgroup> + <docgroup homogen-name='paste' homogen-type='method'> + <method name='paste'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='image'><type><object resolved='predef::Image.Image.paste'/></type></argument> + + </arguments> + </method><method name='paste'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='image'><type><object resolved='predef::Image.Image.paste'/></type></argument> + <argument name='x'><type><int/></type></argument> + <argument name='y'><type><int/></type></argument> + + </arguments> + </method><doc> + <text> + Pastes a given image over the current image. + + </text> + <group> + <param name='image'/> + <text>image to paste (may be empty, needs to be an image object)</text></group> + <group> + <param name='x'/> + <param name='y'/> + <text>where to paste the image; default is 0,0 + </text></group> + <group><returns/><text> + the object called + </text></group> + <group><seealso/><text> + <ref resolved='predef::Image.Image.paste_mask'>paste_mask</ref>, <ref resolved='predef::Image.Image.paste_alpha'>paste_alpha</ref>, <ref resolved='predef::Image.Image.paste_alpha_color'>paste_alpha_color</ref></text></group> + + </doc> + </docgroup> + <docgroup homogen-name='paste_alpha' homogen-type='method'> + <method name='paste_alpha'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='image'><type><object resolved='predef::Image.Image.paste_alpha'/></type></argument> + <argument name='alpha'><type><int/></type></argument> + + </arguments> + </method><method name='paste_alpha'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='image'><type><object resolved='predef::Image.Image.paste_alpha'/></type></argument> + <argument name='alpha'><type><int/></type></argument> + <argument name='x'><type><int/></type></argument> + <argument name='y'><type><int/></type></argument> + + </arguments> + </method><doc> + <text> + Pastes a given image over the current image, with + the specified alpha channel value. + + An alpha channel value of 0 leaves nothing of the original + image in the paste area, 255 is meaningless and makes the + given image invisible. + + </text> + <group> + <param name='image'/> + <text>image to paste</text></group> + <group> + <param name='alpha'/> + <text>alpha channel value</text></group> + <group> + <param name='x'/> + <param name='y'/> + <text>where to paste the image; default is 0,0 + </text></group> + <group><returns/><text> + the object called + </text></group> + <group><seealso/><text> + <ref resolved='predef::Image.Image.paste_mask'>paste_mask</ref>, <ref resolved='predef::Image.Image.paste'>paste</ref>, <ref resolved='predef::Image.Image.paste_alpha_color'>paste_alpha_color</ref></text></group> + + </doc> + </docgroup> + <docgroup homogen-name='paste_alpha_color' homogen-type='method'> + <method name='paste_alpha_color'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='mask'><type><object resolved='predef::Image.Image.paste_alpha_color'/></type></argument> + + </arguments> + </method><method name='paste_alpha_color'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='mask'><type><object resolved='predef::Image.Image.paste_alpha_color'/></type></argument> + <argument name='x'><type><int/></type></argument> + <argument name='y'><type><int/></type></argument> + + </arguments> + </method><method name='paste_alpha_color'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='mask'><type><object resolved='predef::Image.Image.paste_alpha_color'/></type></argument> + <argument name='r'><type><int/></type></argument> + <argument name='g'><type><int/></type></argument> + <argument name='b'><type><int/></type></argument> + + </arguments> + </method><method name='paste_alpha_color'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='mask'><type><object resolved='predef::Image.Image.paste_alpha_color'/></type></argument> + <argument name='r'><type><int/></type></argument> + <argument name='g'><type><int/></type></argument> + <argument name='b'><type><int/></type></argument> + <argument name='x'><type><int/></type></argument> + <argument name='y'><type><int/></type></argument> + + </arguments> + </method><doc> + <text> + Pastes a given color over the current image, + using the given mask as opaque channel. + + A pixel value of 255 makes the result become the color given, + 0 doesn't change anything. + + The masks red, green and blue values are used separately. + If no color are given, the current is used. + + </text> + <group> + <param name='mask'/> + <text>mask image</text></group> + <group> + <param name='r'/> + <param name='g'/> + <param name='b'/> + <text>what color to paint with; default is current</text></group> + <group> + <param name='x'/> + <param name='y'/> + <text>where to paste the image; default is 0,0 + </text></group> + <group><returns/><text> + the object called + </text></group> + <group><seealso/><text> + <ref resolved='predef::Image.Image.paste_mask'>paste_mask</ref>, <ref resolved='predef::Image.Image.paste_alpha'>paste_alpha</ref>, <ref resolved='predef::Image.Image.paste_alpha_color'>paste_alpha_color</ref></text></group> + + </doc> + </docgroup> + <docgroup homogen-name='paste_mask' homogen-type='method'> + <method name='paste_mask'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='image'><type><object resolved='predef::Image.Image.paste_mask'/></type></argument> + <argument name='mask'><type><object resolved='predef::Image.Image.paste_mask'/></type></argument> + + </arguments> + </method><method name='paste_mask'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='image'><type><object resolved='predef::Image.Image.paste_mask'/></type></argument> + <argument name='mask'><type><object resolved='predef::Image.Image.paste_mask'/></type></argument> + <argument name='x'><type><int/></type></argument> + <argument name='y'><type><int/></type></argument> + + </arguments> + </method><doc> + <text> + Pastes a given image over the current image, + using the given mask as opaque channel. + + A pixel value of 255 makes the result become a pixel + from the given image, 0 doesn't change anything. + + The masks red, green and blue values are used separately. + + </text> + <group> + <param name='image'/> + <text>image to paste</text></group> + <group> + <param name='mask'/> + <text>mask image</text></group> + <group> + <param name='x'/> + <param name='y'/> + <text>where to paste the image; default is 0,0 + </text></group> + <group><returns/><text> + the object called + </text></group> + <group><seealso/><text> + <ref resolved='predef::Image.Image.paste'>paste</ref>, <ref resolved='predef::Image.Image.paste_alpha'>paste_alpha</ref>, <ref resolved='predef::Image.Image.paste_alpha_color'>paste_alpha_color</ref></text></group> + + </doc> + </docgroup> <docgroup homogen-type='method'> - + <method name='phaseh'> + <returntype> + <object>object </object></returntype> + <arguments> + </arguments> + </method><method name='phasev'> + <returntype> + <object>object </object></returntype> + <arguments> + </arguments> + </method><method name='phasevh'> + <returntype> + <object>object </object></returntype> + <arguments> + </arguments> + </method><method name='phasehv'> + <returntype> + <object>object </object></returntype> + <arguments> + </arguments> + </method><doc> + <text> + Draws images describing the phase + of the current image. phaseh gives the + horizontal phase and phasev the vertical + phase. + + <tt>phaseh</tt> gives an image + were + <pre> + max falling min rising + value= 0 64 128 192 + </pre> + + 0 is set if there is no way to determine + if it is rising or falling. This is done + for the every red, green and blue part of + the image. + + Phase images can be used to create ugly + effects or to find meta-information + in the orginal image. + + </text> + <group><returns/><text> + the new image object + </text></group> + <group><note/><text> + experimental status; may not be exact the same + output in later versions + </text></group> + <group><bugs/><text> + 0 should not be set as explained above. + </text></group> + + </doc> + </docgroup> + <docgroup homogen-name='polyfill' homogen-type='method'> + <method name='polyfill'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='curve'><type><varargs> + <array><valuetype> + <or><int/><float/></or></valuetype></array></varargs></type></argument> + + </arguments> + </method><doc> + <text> + fills an area with the current color + + </text> + <group> + <param name='curve'/> + <text>curve(s), <tt>({x1,y1,x2,y2,...,xn,yn})</tt>, + automatically closed. + + If any given curve is inside another, it + will make a hole. + </text></group> + <group><returns/><text> + the current object + </text></group> + <group><note/><text> + Lines in the polygon may not be crossed without + the crossing coordinate specified in both lines. + + </text></group> + <group><bugs/><text> + Inverted lines reported on Intel and Alpha processors. + + </text></group> + <group><seealso/><text> + <ref resolved='predef::Image.Image.setcolor'>setcolor</ref></text></group> + + </doc> + </docgroup> + <docgroup homogen-name='random' homogen-type='method'> + <method name='random'> + <returntype> + <object>object </object></returntype> + <arguments> + </arguments> + </method><method name='random'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='seed'><type><int/></type></argument> + + </arguments> + </method><doc> + <text> + Gives a randomized image; + <table><tr valign='center'> + <td><image file='predef.Image.Image.random.1.png' height='115' width='80'>pattern.c1.png</image></td> + <td><image file='predef.Image.Image.random.2.png' height='115' width='80'>pattern.c2.png</image></td> + <td><image file='predef.Image.Image.random.3.png' height='115' width='80'>pattern.c3.png</image></td> + <td><image file='predef.Image.Image.random.4.png' height='115' width='80'>pattern.c4.png</image></td> + <td><image file='predef.Image.Image.random.5.png' height='115' width='80'>pattern.c5.png</image></td> + <td><image file='predef.Image.Image.random.6.png' height='115' width='80'>pattern.c6.png</image></td> + </tr><tr> + <td>original</td> + <td>->random()</td> + <td>->random(17)</td> + <td>greyed (same again)</td> + <td>color(red) (same again)</td> + <td>...red channel </td> + </tr></table> + + Use with ->grey() or ->color() for one-color-results. + + </text> + <group><returns/><text> + a new image + </text></group> + + </doc> + </docgroup> + <docgroup homogen-type='method'> <method name='write_lsb_rgb'> <returntype> <object>object </object></returntype>
5801: </doc> </docgroup> + <docgroup homogen-type='method'> + <method name='rotate'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='angle'><type> + <or><int/><float/></or></type></argument> + + </arguments> + </method><method name='rotate'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='angle'><type> + <or><int/><float/></or></type></argument> + <argument name='r'><type><int/></type></argument> + <argument name='g'><type><int/></type></argument> + <argument name='b'><type><int/></type></argument> + + </arguments> + </method><method name='rotate_expand'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='angle'><type> + <or><int/><float/></or></type></argument> + + </arguments> + </method><method name='rotate_expand'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='angle'><type> + <or><int/><float/></or></type></argument> + <argument name='r'><type><int/></type></argument> + <argument name='g'><type><int/></type></argument> + <argument name='b'><type><int/></type></argument> + + </arguments> + </method><doc> + <text> + Rotates an image a certain amount of degrees (360° is + a complete rotation) counter-clockwise: + + <table><tr valign='center'> + <td><image file='predef.Image.Image.rotate.1.png' height='115' width='80'>matrix.c4.png</image></td> + <td><image file='predef.Image.Image.rotate.2.png' height='141' width='113'>matrix.c5.png</image></td> + <td><image file='predef.Image.Image.rotate.3.png' height='141' width='113'>matrix.c6.png</image></td> + </tr><tr valign='center'> + <td>original</td> + <td>->rotate(15,255,0,0);</td> + <td>->rotate_expand(15);</td> + </tr></table> + + The "expand" variant of functions stretches the + image border pixels rather then filling with + the given or current color. + + This rotate uses the <ref resolved='predef::Image.Image.skewx'>skewx</ref>() and <ref resolved='predef::Image.Image.skewy'>skewy</ref>() functions. + </text> + <group> + <param name='angle'/> + <text>the number of degrees to rotate</text></group> + <group> + <param name='r'/> + <param name='g'/> + <param name='b'/> + <text>color to fill with; default is current</text></group> + <group><returns/><text> + the new image object + </text></group> + + </doc> + </docgroup> + <docgroup homogen-name='rotate_ccw' homogen-type='method'> + <method name='rotate_ccw'> + <returntype> + <object>object </object></returntype> + <arguments> + </arguments> + </method><doc> + <text> + rotates an image counter-clockwise, 90 degrees. + + <table><tr valign='center'> + <td><image file='predef.Image.Image.rotate_ccw.1.png' height='115' width='80'>matrix.c7.png</image></td> + <td><image file='predef.Image.Image.rotate_ccw.2.png' height='80' width='115'>matrix.c8.png</image></td> + </tr><tr valign='center'> + <td>original</td> + <td>->rotate_ccw();</td> + </tr></table> + + </text> + <group><returns/><text> + the new image object + </text></group> + + </doc> + </docgroup> + <docgroup homogen-name='rotate_cw' homogen-type='method'> + <method name='rotate_cw'> + <returntype> + <object>object </object></returntype> + <arguments> + </arguments> + </method><doc> + <text> + rotates an image clockwise, 90 degrees. + + <table><tr valign='center'> + <td><image file='predef.Image.Image.rotate_cw.1.png' height='115' width='80'>matrix.c9.png</image></td> + <td><image file='predef.Image.Image.rotate_cw.2.png' height='80' width='115'>matrix.c10.png</image></td> + </tr><tr valign='center'> + <td>original</td> + <td>->rotate_cw();</td> + </tr></table> + </text> + <group><returns/><text> + the new image object + </text></group> + + </doc> + </docgroup> + <docgroup homogen-name='scale' homogen-type='method'> + <method name='scale'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='factor'><type><float/></type></argument> + + </arguments> + </method><method name='scale'> + <returntype> + <object>object </object></returntype> + <arguments><argument><value>0.5</value></argument> + </arguments> + </method><method name='scale'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='xfactor'><type><float/></type></argument> + <argument name='yfactor'><type><float/></type></argument> + + </arguments> + </method><doc> + <text> + scales the image with a factor, + 0.5 is an optimized case. + </text> + <group> + <param name='factor'/> + <text>factor to use for both x and y</text></group> + <group> + <param name='xfactor'/> + <param name='yfactor'/> + <text>separate factors for x and y + </text></group> + <group><returns/><text> + the new image object + </text></group> + + </doc> + </docgroup> + <docgroup homogen-name='scale' homogen-type='method'> + <method name='scale'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='newxsize'><type><int/></type></argument> + <argument name='newysize'><type><int/></type></argument> + + </arguments> + </method><method name='scale'> + <returntype> + <object>object </object></returntype> + <arguments><argument><value>0</value></argument><argument name='newysize'><type><int/></type></argument> + + </arguments> + </method><method name='scale'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='newxsize'><type><int/></type></argument> + <argument><value>0</value></argument> + </arguments> + </method><doc> + <text> + scales the image to a specified new size, + if one of newxsize or newysize is 0, + the image aspect ratio is preserved. + </text> + <group> + <param name='newxsize'/> + <param name='newysize'/> + <text>new image size in pixels + </text></group> + <group><returns/><text> + the new image object + </text></group> + <group><note/><text> + resulting image will be 1x1 pixels, at least + </text></group> + + </doc> + </docgroup> <docgroup homogen-name='select_from' homogen-type='method'> <method name='select_from'> <returntype>
5943: </doc> </docgroup> + <docgroup homogen-type='method'> + <method name='skewx'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='x'><type><int/></type></argument> + + </arguments> + </method><method name='skewx'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='yfactor'><type><int/></type></argument> + + </arguments> + </method><method name='skewx'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='x'><type><int/></type></argument> + <argument name='r'><type><int/></type></argument> + <argument name='g'><type><int/></type></argument> + <argument name='b'><type><int/></type></argument> + + </arguments> + </method><method name='skewx'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='yfactor'><type><int/></type></argument> + <argument name='r'><type><int/></type></argument> + <argument name='g'><type><int/></type></argument> + <argument name='b'><type><int/></type></argument> + + </arguments> + </method><method name='skewx_expand'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='x'><type><int/></type></argument> + + </arguments> + </method><method name='skewx_expand'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='yfactor'><type><int/></type></argument> + + </arguments> + </method><method name='skewx_expand'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='x'><type><int/></type></argument> + <argument name='r'><type><int/></type></argument> + <argument name='g'><type><int/></type></argument> + <argument name='b'><type><int/></type></argument> + + </arguments> + </method><method name='skewx_expand'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='yfactor'><type><int/></type></argument> + <argument name='r'><type><int/></type></argument> + <argument name='g'><type><int/></type></argument> + <argument name='b'><type><int/></type></argument> + + </arguments> + </method><doc> + <text> + Skews an image an amount of pixels or a factor; + a skew-x is a transformation: + + <table><tr valign='center'> + <td><image file='predef.Image.Image.skewx.1.png' height='115' width='80'>matrix.c11.png</image></td> + <td><image file='predef.Image.Image.skewx.2.png' height='115' width='95'>matrix.c12.png</image></td> + <td><image file='predef.Image.Image.skewx.3.png' height='115' width='95'>matrix.c13.png</image></td> + </tr><tr valign='center'> + <td>original</td> + <td>->skewx(15,255,0,0);</td> + <td>->skewx_expand(15);</td> + </tr></table> + + </text> + <group> + <param name='x'/> + <text>the number of pixels + The "expand" variant of functions stretches the + image border pixels rather then filling with + the given or current color.</text></group> + <group> + <param name='yfactor'/> + <text>best described as: x=yfactor*this->ysize()</text></group> + <group> + <param name='r'/> + <param name='g'/> + <param name='b'/> + <text>color to fill with; default is current</text></group> + <group><returns/><text> + the new image object + </text></group> + + </doc> + </docgroup> + <docgroup homogen-type='method'> + <method name='skewy'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='y'><type><int/></type></argument> + + </arguments> + </method><method name='skewy'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='xfactor'><type><int/></type></argument> + + </arguments> + </method><method name='skewy'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='y'><type><int/></type></argument> + <argument name='r'><type><int/></type></argument> + <argument name='g'><type><int/></type></argument> + <argument name='b'><type><int/></type></argument> + + </arguments> + </method><method name='skewy'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='xfactor'><type><int/></type></argument> + <argument name='r'><type><int/></type></argument> + <argument name='g'><type><int/></type></argument> + <argument name='b'><type><int/></type></argument> + + </arguments> + </method><method name='skewy_expand'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='y'><type><int/></type></argument> + + </arguments> + </method><method name='skewy_expand'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='xfactor'><type><int/></type></argument> + + </arguments> + </method><method name='skewy_expand'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='y'><type><int/></type></argument> + <argument name='r'><type><int/></type></argument> + <argument name='g'><type><int/></type></argument> + <argument name='b'><type><int/></type></argument> + + </arguments> + </method><method name='skewy_expand'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='xfactor'><type><int/></type></argument> + <argument name='r'><type><int/></type></argument> + <argument name='g'><type><int/></type></argument> + <argument name='b'><type><int/></type></argument> + + </arguments> + </method><doc> + <text> + Skews an image an amount of pixels or a factor; + a skew-y is a transformation: + + <table><tr valign='center'> + <td><image file='predef.Image.Image.skewy.1.png' height='115' width='80'>matrix.c14.png</image></td> + <td><image file='predef.Image.Image.skewy.2.png' height='130' width='80'>matrix.c15.png</image></td> + <td><image file='predef.Image.Image.skewy.3.png' height='130' width='80'>matrix.c16.png</image></td> + </tr><tr valign='center'> + <td>original</td> + <td>->skewy(15,255,0,0);</td> + <td>->skewy_expand(15);</td> + </tr></table> + + The "expand" variant of functions stretches the + image border pixels rather then filling with + the given or current color. + </text> + <group> + <param name='y'/> + <text>the number of pixels</text></group> + <group> + <param name='xfactor'/> + <text>best described as: t=xfactor*this->xsize()</text></group> + <group> + <param name='r'/> + <param name='g'/> + <param name='b'/> + <text>color to fill with; default is current</text></group> + <group><returns/><text> + the new image object + </text></group> + + </doc> + </docgroup> <docgroup homogen-name='test' homogen-type='method'> <method name='test'> <returntype>
6029: </doc> </docgroup> + <docgroup homogen-name='toppm' homogen-type='method'> + <method name='toppm'> + <returntype> + <object>string </object></returntype> + <arguments> + </arguments> + </method><doc> + <text> + compability method - do not use in new programs. + + See <ref resolved='predef::Image.PNM.encode'>Image.PNM.encode</ref>(). + + </text> + <group><returns/><text> + PPM data + </text></group> + + </doc> + </docgroup> <docgroup homogen-name='tuned_box' homogen-type='method'> <method name='tuned_box'> <returntype>
6087: </doc> </docgroup> + <docgroup homogen-name='turbulence' homogen-type='method'> + <method name='turbulence'> + <returntype> + <object>void </object></returntype> + <arguments><argument name='colorrange'><type> + <array><valuetype> + <or><float/><int/><array><valuetype><int/></valuetype></array></or></valuetype></array></type></argument> + + </arguments> + </method><method name='turbulence'> + <returntype> + <object>void </object></returntype> + <arguments><argument name='colorrange'><type> + <array><valuetype> + <or><float/><int/><array><valuetype><int/></valuetype></array></or></valuetype></array></type></argument> + <argument name='octaves'><type><int/></type></argument> + <argument name='scale'><type><float/></type></argument> + <argument name='xdiff'><type><float/></type></argument> + <argument name='ydiff'><type><float/></type></argument> + <argument name='cscale'><type><float/></type></argument> + + </arguments> + </method><doc> + <text> + gives a new image with the old image's size, + filled width a 'turbulence' pattern + + The random seed may be different with each instance of pike. + + Example: + <tt>->turbulence( ({0,({229,204,204}), 0.9,({229,20,20}), 0.9,Color.black}) );</tt> + <image file='predef.Image.Image.turbulence.1.png' height='100' width='200'>pattern.c7.png</image> + </text> + <group> + <param name='colorrange'/> + <text>colorrange table</text></group> + <group> + <param name='octaves'/> + <text>default value is 3</text></group> + <group> + <param name='scale'/> + <text>default value is 0.1</text></group> + <group> + <param name='xdiff'/> + <param name='ydiff'/> + <text>default value is 0,0</text></group> + <group> + <param name='cscale'/> + <text>default value is 1</text></group> + <group><seealso/><text> + <ref resolved='predef::Image.Image.noise'>noise</ref>, <ref resolved='predef::Image.Color'>Image.Color</ref></text></group> + + </doc> + </docgroup> <docgroup homogen-name='xsize' homogen-type='method'> <method name='xsize'> <returntype>
6671:  </text> <group><seealso/><text> - <ref resolved='predef::Image.Image'>Image</ref>, <ref resolved='predef::Image.image'>Image.image</ref>, <ref resolved='predef::Image.GIF'>Image.GIF</ref></text></group> + <ref resolved='predef::Image.Image'>Image</ref>, <ref resolved='predef::Image.Image'>Image.Image</ref>, <ref resolved='predef::Image.GIF'>Image.GIF</ref></text></group> </doc> <docgroup homogen-name='decode' homogen-type='method'>
6764: <ref resolved='predef::Image.PNM.encode_P1'>encode_P1</ref>/<ref resolved='predef::Image.PNM.encode_P4'>encode_P4</ref> assumes the image is black and white. Use - <ref>Image.image->threshold</ref>() or something like - <tt><ref>Image.colortable</ref>( ({({0,0,0}),({255,255,255})}) ) ->floyd_steinberg() ->map(my_image)</tt> + <ref resolved='predef::Image.Image.threshold'>Image.Image->threshold</ref>() or something like + <tt><ref resolved='predef::Image.Colortable'>Image.Colortable</ref>( ({({0,0,0}),({255,255,255})}) ) ->floyd_steinberg() ->map(my_image)</tt> to get a black and white image. <ref resolved='predef::Image.PNM.encode_P2'>encode_P2</ref>/<ref resolved='predef::Image.PNM.encode_P5'>encode_P5</ref> assumes the image is greyscale. Use - <ref>Image.image->grey</ref>() to get a greyscale image. + <ref resolved='predef::Image.Image.grey'>Image.Image->grey</ref>() to get a greyscale image. </text>
7162:  </text> <group><seealso/><text> - <ref resolved='predef::Image.Image'>Image</ref>, <ref resolved='predef::Image.image'>Image.image</ref>, <ref>Image.colortable</ref></text></group> + <ref resolved='predef::Image.Image'>Image</ref>, <ref resolved='predef::Image.Image'>Image.Image</ref>, <ref resolved='predef::Image.Colortable'>Image.Colortable</ref></text></group> </doc> <docgroup homogen-name='decode_pseudocolor' homogen-type='method'>
7612: float xres = 72.0; float yres = 72.0; int res_unit; - Image.colortable colormap; - Image.colortable meta_colormap; + Image.Colortable colormap; + Image.Colortable meta_colormap; array(Layer) layers = ({}); array(Channel) channels = ({}); array(Guide) guides = ({});
7656: !class Hierarchy { - Image.image img; - Image.image alpha; + Image.Image img; + Image.Image alpha; int width; int height; int bpp;
7718: <pre> Supported options ([ - "background":({r,g,b})||Image.color object + "background":({r,g,b})||Image.Color object "draw_all_layers":1, Draw invisible layers as well
7734: "mark_layers":1, Draw an outline around all (drawn) layers - "mark_layer_names":Image.font object, + "mark_layer_names":Image.Font object, Write the name of all layers using the font object, "mark_active_layer":1,
7890: </text> <group><seealso/><text> - <ref resolved='predef::Image.Image'>Image</ref>, <ref resolved='predef::Image.image'>Image.image</ref>, <ref resolved='predef::Image.PNM'>Image.PNM</ref>, <ref resolved='predef::Image.X'>Image.X</ref></text></group> + <ref resolved='predef::Image.Image'>Image</ref>, <ref resolved='predef::Image.Image'>Image.Image</ref>, <ref resolved='predef::Image.PNM'>Image.PNM</ref>, <ref resolved='predef::Image.X'>Image.X</ref></text></group> </doc> <docgroup homogen-name='_decode' homogen-type='method'>
7944: </doc> </docgroup> </module> - <module name='color'> - <doc> - <text> - - This module keeps names and easy handling - for easy color support. It gives you an easy - way to get colors from names. - - A color is here an object, containing color - information and methods for conversion, see below. - - <ref resolved='predef::Image.Image.color'>Image.color</ref> can be called to make a color object. - <ref resolved='predef::Image.Image.color'>Image.color()</ref> takes the following arguments: - <pre> - Image.color(string name) // "red" - Image.color(string prefix_string) // "lightblue" - Image.color(string hex_name) // "#ff00ff" - Image.color(string cmyk_string) // "%17,42,0,19.4" - Image.color(string hsv_string) // "%@327,90,32" - Image.color(int red, int green, int blue) - </pre> - - The color names available can be listed by using indices - on Image.color. The colors are available by name directly - as <tt>Image.color.name</tt>, too: - <pre> - ...Image.color.red... - ...Image.color.green... - or, maybe - import Image.color; - ...red... - ...green... - ...lightgreen... - </pre> - - Giving red, green and blue values is equal to calling - <ref resolved='predef::Image.color.rgb'>Image.color.rgb</ref>(). - - The prefix_string method is a form for getting modified - colors, it understands all modifiers - (<ref to='image.color.color.light'>light</ref>, - <ref to='image.color.color.dark'>dark</ref>, - <ref to='image.color.color.bright'>bright</ref>, - <ref to='image.color.color.dull'>dull</ref> and - <ref to='image.color.color.neon'>neon</ref>). Simply use - "method"+"color"; (as in <tt>lightgreen</tt>, - <tt>dullmagenta</tt>, <tt>lightdullorange</tt>). - - The <tt>hex_name</tt> form is a simple - <tt>#rrggbb</tt> form, as in HTML or X-program argument. - A shorter form (<tt>#rgb</tt>) is also accepted. This - is the inverse to the <ref resolved='predef::Image.color.color.hex'>Image.color.color->hex</ref>() - method. - - The <tt>cmyk_string</tt> is a string form of giving - cmyk (cyan, magenta, yellow, black) color. These - values are floats representing percent. - - The <tt>hsv_string</tt> is another hue, saturation, value - representation, but in floats; hue is in degree range (0..360), - and saturation and value is given in percent. This is not - the same as returned or given to the <ref resolved='predef::Image.color.hsv'>hsv</ref>() methods! - - - - </text> - <group><note/><text> - <tt>Image.color["something"]</tt> will never(!) generate an error, - but a zero_type 0, if the color is unknown. This is enough - to give the error "not present in module", if used - as <tt>Image.color.something</tt>, though. - - If you are using colors from for instance a webpage, you might - want to create the color from <ref resolved='predef::Image.color.guess'>Image.color.guess</ref>(), - since that method is more tolerant for mistakes and errors. - - <tt>Image.color</tt>() is case- and space-sensitive. - Use <ref resolved='predef::Image.color.guess'>Image.color.guess</ref>() to catch all variants. - - and subtract with a space (lower_case(x)-" ") to make - sure you get all variants. - - - </text></group> - <group><seealso/><text> - <ref resolved='predef::Image.color.color.name'>Image.color.color->name</ref>, <ref resolved='predef::Image.color.color.rgb'>Image.color.color->rgb</ref>, <ref resolved='predef::Image.color.color'>Image.color.color</ref>, <ref resolved='predef::Image.color.guess'>Image.color.guess</ref>, <ref resolved='predef::Image.Image'>Image</ref>, <ref>Image.colortable</ref></text></group> - - </doc> - <docgroup homogen-type='method'> - <method name='_indices'> - <returntype> - <array><valuetype><string/></valuetype></array></returntype> - <arguments> - </arguments> - </method><method name='_values'> - <returntype> - <array><valuetype><object resolved='predef::Image.color._indices'/></valuetype></array></returntype> - <arguments> - </arguments> - </method><doc> - <text> - (ie as <tt>indices(Image.color)</tt> or <tt>values(Image.color)</tt>) - <tt>indices</tt> gives a list of all the known color names, - <tt>values</tt> gives there corresponding objects. - </text> - <group><seealso/><text> - <ref resolved='predef::Image.Image.color'>Image.color</ref></text></group> - - </doc> - </docgroup> - <docgroup homogen-type='method'> - <method name='rgb'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='red'><type><int/></type></argument> - <argument name='intgreen'><type> - <object resolved='predef::Image.color.rgb'/></type></argument> - <argument name='intblue'><type> - <object resolved='predef::Image.color.rgb'/></type></argument> - - </arguments> - </method><method name='hsv'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='hue'><type><int/></type></argument> - <argument name='intsaturation'><type> - <object resolved='predef::Image.color.rgb'/></type></argument> - <argument name='intvalue'><type> - <object resolved='predef::Image.color.rgb'/></type></argument> - - </arguments> - </method><method name='cmyk'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='c'><type><float/></type></argument> - <argument name='m'><type><float/></type></argument> - <argument name='y'><type><float/></type></argument> - <argument name='k'><type><float/></type></argument> - - </arguments> - </method><method name='greylevel'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='level'><type><int/></type></argument> - - </arguments> - </method><method name='html'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='html_color'><type><string/></type></argument> - - </arguments> - </method><doc> - <text> - Creates a new color object from given red, green and blue, - hue, saturation and value, or greylevel, in color value range. - It could also be created from cmyk values in percent. - - The <ref resolved='predef::Image.color.html'>html</ref>() method only understands the HTML color names, - or the <tt>#rrggbb</tt> form. It is case insensitive. - - </text> - <group><returns/><text> - the created object. - </text></group> - - </doc> - </docgroup> - <docgroup homogen-name='guess' homogen-type='method'> - <method name='guess'> - <returntype> - <object>object </object></returntype> - <arguments><argument><value>string</value></argument> - </arguments> - </method><doc> - <text> - This is equivalent to - <tt><ref resolved='predef::Image.Image.color'>Image.color</ref>(lower_case(str)-" ")</tt>, - and tries the color with a prepending '#' if no - corresponding color is found. - - </text> - <group><returns/><text> - a color object or zero_type - </text></group> - - </doc> - </docgroup> - <class name='color'> - <doc> - <text> - This is the color object. It has six readable variables, - <tt>r</tt>, <tt>g</tt>, <tt>b</tt>, for the red, - green and blue values, - and <tt>h</tt>, <tt>s</tt>, <tt>v</tt>, for - the hue, saturation anv value values. - </text> - - </doc> - <docgroup homogen-name='`==' homogen-type='method'> - <method name='`=='> - <returntype> - <object>int </object></returntype> - <arguments><argument name='other_color'><type><object resolved='predef::Image.color.color.`=='/></type></argument> - - </arguments> - </method><method name='`=='> - <returntype> - <object>int </object></returntype> - <arguments><argument name='rgb'><type> - <array><valuetype><int/></valuetype></array></type></argument> - - </arguments> - </method><method name='`=='> - <returntype> - <object>int </object></returntype> - <arguments><argument name='greylevel'><type><int/></type></argument> - - </arguments> - </method><method name='`=='> - <returntype> - <object>int </object></returntype> - <arguments><argument name='name'><type><string/></type></argument> - - </arguments> - </method><doc> - <text> - Compares this object to another color, - or color name. Example: - <pre> - object red=Image.color.red; - object other=Image.color. ...; - object black=Image.color.black; - - if (red==other) ... - if (red==({255,0,0})) ... - if (black==0) ... - if (red=="red") ... - </pre> - - </text> - <group><returns/><text> - 1 or 0 - </text></group> - <group><note/><text> - The other datatype (not color object) must be to the right! - </text></group> - <group><seealso/><text> - <ref resolved='predef::Image.color.color.`==.rgb'>rgb</ref>, <ref resolved='predef::Image.color.color.grey'>grey</ref>, <ref resolved='predef::Image.color.color.`==.name'>name</ref></text></group> - - </doc> - </docgroup> - <docgroup homogen-type='method'> - <method name='light'> - <returntype> - <object>object </object></returntype> - <arguments> - </arguments> - </method><method name='dark'> - <returntype> - <object>object </object></returntype> - <arguments> - </arguments> - </method><method name='neon'> - <returntype> - <object>object </object></returntype> - <arguments> - </arguments> - </method><method name='bright'> - <returntype> - <object>object </object></returntype> - <arguments> - </arguments> - </method><method name='dull'> - <returntype> - <object>object </object></returntype> - <arguments> - </arguments> - </method><doc> - <text> - Color modification methods. These returns - a new color. - <table> - <tr><th>method</th><th width='50%'>effect</th> - <th>h</th><th>s</th><th>v</th><th>as</th></tr> - <tr><td>light </td><td>raise light level</td><td>Â±0</td><td> Â±0</td><td>+50</td> - <td> - - - </td></tr> - - <tr><td>dark </td><td>lower light level</td><td>Â±0</td><td> Â±0</td><td>-50</td> - <td> - - - </td></tr> - - <tr><td>bright</td><td>brighter color </td><td>Â±0</td><td>+50</td><td>+50</td> - <td> - - - </td></tr> - - <tr><td>dull </td><td>greyer color </td><td>Â±0</td><td>-50</td><td>-50</td> - <td> - - - </td></tr> - - <tr><td>neon </td><td>set to extreme </td><td>Â±0</td><td>max</td><td>max</td> - <td> - </td></tr> - - </table> - </text> - <group><returns/><text> - the new color object - </text></group> - <group><note/><text> - The opposites may not always take each other out. - The color is maximised at white and black levels, - so, for instance - <ref resolved='predef::Image.Image.color'>Image.color</ref>.white-><ref resolved='predef::Image.color.color.light'>light</ref>()-><ref resolved='predef::Image.color.color.dark'>dark</ref>() - doesn't give the white color back, but the equal to - <ref resolved='predef::Image.Image.color'>Image.color</ref>.white-><ref resolved='predef::Image.color.color.dark'>dark</ref>(), since - white can't get any <ref resolved='predef::Image.color.color.light'>light</ref>er. - </text></group> - - </doc> - </docgroup> - <docgroup homogen-name='cast' homogen-type='method'> - <method name='cast'> - <returntype> - <or><array/><object>string </object></or></returntype> - <arguments> - </arguments> - </method><doc> - <text> - cast the object to an array, representing red, green - and blue (equal to <tt>-><ref resolved='predef::Image.color.color.rgb'>rgb</ref>()</tt>), or - to a string, giving the name (equal to <tt>-><ref resolved='predef::Image.color.color.name'>name</ref>()</tt>). - </text> - <group><returns/><text> - the name as string or rgb as array - </text></group> - <group><seealso/><text> - <ref resolved='predef::Image.color.color.rgb'>rgb</ref>, <ref resolved='predef::Image.color.color.name'>name</ref></text></group> - - </doc> - </docgroup> - <docgroup homogen-type='method'> - <method name='rgb'> - <returntype> - <array><valuetype><int/></valuetype></array></returntype> - <arguments> - </arguments> - </method><method name='hsv'> - <returntype> - <array><valuetype><int/></valuetype></array></returntype> - <arguments> - </arguments> - </method><method name='cmyk'> - <returntype> - <array><valuetype><int/></valuetype></array></returntype> - <arguments> - </arguments> - </method><method name='greylevel'> - <returntype> - <object>int </object></returntype> - <arguments> - </arguments> - </method><method name='greylevel'> - <returntype> - <object>int </object></returntype> - <arguments><argument name='r'><type><int/></type></argument> - <argument name='intg'><type> - <object resolved='predef::Image.color.color.rgb'/></type></argument> - <argument name='intb'><type> - <object resolved='predef::Image.color.color.rgb'/></type></argument> - - </arguments> - </method><doc> - <text> - This is methods of getting information from an - <ref resolved='predef::Image.color.color'>Image.color.color</ref> object. - - They give an array of - red, green and blue (rgb) values (color value), - hue, saturation and value (hsv) values (range as color value), - cyan, magenta, yellow, black (cmyk) values (in percent) - or the greylevel value (range as color value). - - The greylevel is calculated by weighting red, green - and blue. Default weights are 87, 127 and 41, respective, - and could be given by argument. - - </text> - <group><returns/><text> - array(int) respective int - </text></group> - <group><seealso/><text> - <ref resolved='predef::Image.color.color'>Image.color.color</ref>, <ref resolved='predef::Image.color.color.grey'>grey</ref></text></group> - - </doc> - </docgroup> - <docgroup homogen-name='create' homogen-type='method'> - <method name='create'> - <returntype> - <object>void </object></returntype> - <arguments><argument name='r'><type><int/></type></argument> - <argument name='g'><type><int/></type></argument> - <argument name='b'><type><int/></type></argument> - - </arguments> - </method><doc> - <text> - This is the main <ref resolved='predef::Image.color.color'>Image.color.color</ref> creation - method, mostly for internal use. - - </text> - - </doc> - </docgroup> - <docgroup homogen-name='grey' homogen-type='method'> - <method name='grey'> - <returntype> - <object>object </object></returntype> - <arguments> - </arguments> - </method><method name='grey'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='red'><type><int/></type></argument> - <argument name='green'><type><int/></type></argument> - <argument name='blue'><type><int/></type></argument> - - </arguments> - </method><doc> - <text> - Gives a new color, containing a grey color, - which is calculated by the <ref resolved='predef::Image.color.color.greylevel'>greylevel</ref> method. - </text> - <group><returns/><text> - a new <ref resolved='predef::Image.color.color'>Image.color.color</ref> object - </text></group> - <group><seealso/><text> - <ref resolved='predef::Image.color.color.greylevel'>greylevel</ref></text></group> - - </doc> - </docgroup> - <docgroup homogen-type='method'> - <method name='hex'> - <returntype> - <object>string </object></returntype> - <arguments> - </arguments> - </method><method name='hex'> - <returntype> - <object>string </object></returntype> - <arguments><argument name='n'><type><int/></type></argument> - - </arguments> - </method><method name='name'> - <returntype> - <object>string </object></returntype> - <arguments> - </arguments> - </method><method name='html'> - <returntype> - <object>string </object></returntype> - <arguments> - </arguments> - </method><doc> - <text> - Information methods. - - <ref resolved='predef::Image.color.color.hex'>hex</ref>() simply gives a string on the <tt>#rrggbb</tt> - format. If <tt>n</tt> is given, the number of significant - digits is set to this number. - (Ie, <tt>n=3</tt> gives <tt>#rrrgggbbb</tt>.) - - <ref resolved='predef::Image.color.color.name'>name</ref>() is a simplified method; - if the color exists in the database, the name is returned, - per default is the <ref resolved='predef::Image.color.color.hex'>hex</ref>() method use. - - <ref resolved='predef::Image.color.color.html'>html</ref>() gives the <tt>HTML</tt> name of - the color, or the <ref resolved='predef::Image.color.color.hex'>hex</ref>(2) if it isn't one - of the 16 <tt>HTML</tt> colors. - - </text> - <group><returns/><text> - a new <ref resolved='predef::Image.color.color'>Image.color.color</ref> object - </text></group> - <group><seealso/><text> - <ref resolved='predef::Image.color.color.rgb'>rgb</ref>, <ref resolved='predef::Image.color.color.hsv'>hsv</ref>, <ref resolved='predef::Image.Image.color'>Image.color</ref></text></group> - - </doc> - </docgroup> - </class> + </module> - <class name='font'> - <doc> - <text> - - </text> - <group><note/><text> - Short technical documentation on a font file: - This object adds the text-drawing and -creation - capabilities of the <ref resolved='predef::Image.Image'>Image</ref> module. - - For simple usage, see - <ref resolved='predef::Image.font.write'>write</ref> and <ref resolved='predef::Image.font.load'>load</ref>. - - other methods: <ref resolved='predef::Image.font.baseline'>baseline</ref>, - <ref resolved='predef::Image.font.height'>height</ref>, - <ref resolved='predef::Image.font.set_xspacing_scale'>set_xspacing_scale</ref>, - <ref resolved='predef::Image.font.set_yspacing_scale'>set_yspacing_scale</ref>, - <ref resolved='predef::Image.font.text_extents'>text_extents</ref> - - <pre> - struct file_head - { - unsigned INT32 cookie; - 0x464f4e54 - unsigned INT32 version; - 1 - unsigned INT32 chars; - number of chars - unsigned INT32 height; - height of font - unsigned INT32 baseline; - font baseline - unsigned INT32 o[1]; - position of char_head's - } *fh; - struct char_head - { - unsigned INT32 width; - width of this character - unsigned INT32 spacing; - spacing to next character - unsigned char data[1]; - pixmap data (1byte/pixel) - } *ch; - - version 2: - - - On-disk syntax (everything in N.B.O), int is 4 bytes, a byte is 8 bits: - - pos - 0 int cookie = 'FONT'; or 0x464f4e54 - 4 int version = 2; 1 was the old version without the last four chars - 8 int numchars; Always 256 in this version of the dump program - 12 int height; in (whole) pixels - 16 int baseline; in (whole) pixels - 20 char direction; 1==right to left, 0 is left to right - 21 char format; Font format - 22 char colortablep; Colortable format - 23 char kerningtablep; Kerning table format - - 24 int offsets[numchars]; pointers into the data, realative to &cookie. - [colortable] - [kerningtable] - - At each offset: - - - 0 int width; in pixels - 4 int spacing; in 1/1000:th of a pixels - 8 char data[]; Enough data to plot width * font->height pixels - Please note that if width is 0, there is no data. - - Font formats: - id type - 0 Raw 8bit data - 1 RLE encoded data, char length, char data, 70% more compact than raw data - 2 ZLib compressed data 60% more compact than RLE - - Colortable types: - 0 No colortable (the data is an alpha channel) - 1 24bit RGB with alpha (index->color, 256*4 bytes, rgba) - 2 8bit Greyscale with alpha (index->color, 256*2 bytes) - - Kerningtable types: - 0 No kerning table - 1 numchars*numchars entries, each a signed char with the kerning value - 2 numchar entries, each with a list of kerning pairs, like this: - int len - len * (short char, short value) - **! </pre> - - </text></group> - <group><seealso/><text> - <ref resolved='predef::Image.Image'>Image</ref>, <ref resolved='predef::Image.image'>Image.image</ref></text></group> - - </doc> - <docgroup homogen-name='baseline' homogen-type='method'> - <method name='baseline'> - <returntype> - <object>int </object></returntype> - <arguments> - </arguments> - </method><doc> - <group><returns/><text> - font baseline (pixels from top) - </text></group> - <group><seealso/><text> - <ref resolved='predef::Image.font.height'>height</ref>, <ref resolved='predef::Image.font.text_extents'>text_extents</ref></text></group> - - </doc> - </docgroup> - <docgroup homogen-name='create' homogen-type='method'> - <method name='create'> - <returntype> - <object>void </object></returntype> - <arguments><argument name='filename'><type><string/></type></argument> - - </arguments> - </method><doc> - <text> - Loads a font file to this font object. - Similar to <ref resolved='predef::Image.font.load'>load</ref>(). - </text> - - </doc> - </docgroup> - <docgroup homogen-type='method'> - <method name='height'> - <returntype> - <object>int </object></returntype> - <arguments> - </arguments> - </method><method name='text_extents'> - <returntype> - <array><valuetype><int/></valuetype></array></returntype> - <arguments><argument name='text'><type><string/></type></argument> - <argument><value>...</value></argument> - </arguments> - </method><doc> - <text> - Calculate extents of a text-image, - that would be created by calling <ref resolved='predef::Image.font.write'>write</ref> - with the same arguments. - </text> - <group> - <param name='text, ...'/> - <text>One or more lines of text.</text></group> - <group><returns/><text> - an array of width and height - </text></group> - <group><seealso/><text> - <ref resolved='predef::Image.font.baseline'>baseline</ref>, <ref resolved='predef::Image.font.text_extents'>text_extents</ref>, <ref resolved='predef::Image.font.write'>write</ref>, <ref resolved='predef::Image.font.height'>height</ref>, <ref resolved='predef::Image.font.baseline'>baseline</ref></text></group> - - </doc> - </docgroup> - <docgroup homogen-name='load' homogen-type='method'> - <method name='load'> - <returntype> - <or><object resolved='predef::Image.font.load'/><object>int </object></or></returntype> - <arguments><argument name='filename'><type><string/></type></argument> - - </arguments> - </method><doc> - <text> - Loads a font file to this font object. - </text> - <group> - <param name='filename'/> - <text>Font file - </text></group> - <group><returns/><text> - zero upon failure, font object upon success - </text></group> - <group><seealso/><text> - <ref resolved='predef::Image.font.write'>write</ref></text></group> - - </doc> - </docgroup> - <docgroup homogen-type='method'> - <method name='set_xspacing_scale'> - <returntype> - <object>void </object></returntype> - <arguments><argument name='scale'><type><float/></type></argument> - - </arguments> - </method><method name='set_yspacing_scale'> - <returntype> - <object>void </object></returntype> - <arguments><argument name='scale'><type><float/></type></argument> - - </arguments> - </method><doc> - <text> - Set spacing scale to write characters closer - or more far away. This does not change scale - of character, only the space between them. - </text> - <group> - <param name='scale'/> - <text>what scale to use</text></group> - - </doc> - </docgroup> - <docgroup homogen-name='write' homogen-type='method'> - <method name='write'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='text'><type><string/></type></argument> - <argument><value>...</value></argument> - </arguments> - </method><doc> - <text> - Writes some text; thus creating an image object - that can be used as mask or as a complete picture. - </text> - <group> - <param name='text, ...'/> - <text>One or more lines of text.</text></group> - <group><returns/><text> - an <ref resolved='predef::Image.image'>Image.image</ref> object - </text></group> - <group><seealso/><text> - <ref resolved='predef::Image.font.text_extents'>text_extents</ref>, <ref resolved='predef::Image.font.load'>load</ref>, <ref resolved='predef::Image.image.paste_mask'>Image.image->paste_mask</ref>, <ref resolved='predef::Image.image.paste_alpha_color'>Image.image->paste_alpha_color</ref></text></group> - - </doc> - </docgroup> - </class> - <class name='image'> - <docgroup homogen-type='method'> - <method name='gif_begin'> - <returntype> - <object>string </object></returntype> - <arguments> - </arguments> - </method><method name='gif_begin'> - <returntype> - <object>string </object></returntype> - <arguments><argument name='num_colors'><type><int/></type></argument> - - </arguments> - </method><method name='gif_begin'> - <returntype> - <object>string </object></returntype> - <arguments><argument name='colors'><type> - <array><valuetype> - <array><valuetype><int/></valuetype></array></valuetype></array></type></argument> - - </arguments> - </method><method name='gif_end'> - <returntype> - <object>string </object></returntype> - <arguments> - </arguments> - </method><method name='gif_netscape_loop'> - <returntype> - <object>string </object></returntype> - <arguments><argument name='loops'><type><int/></type></argument> - - </arguments> - </method><method name='togif'> - <returntype> - <object>string </object></returntype> - <arguments> - </arguments> - </method><method name='togif'> - <returntype> - <object>string </object></returntype> - <arguments><argument name='trans_r'><type><int/></type></argument> - <argument name='trans_g'><type><int/></type></argument> - <argument name='trans_b'><type><int/></type></argument> - - </arguments> - </method><method name='togif'> - <returntype> - <object>string </object></returntype> - <arguments><argument name='num_colors'><type><int/></type></argument> - <argument name='trans_r'><type><int/></type></argument> - <argument name='trans_g'><type><int/></type></argument> - <argument name='trans_b'><type><int/></type></argument> - - </arguments> - </method><method name='togif'> - <returntype> - <object>string </object></returntype> - <arguments><argument name='colors'><type> - <array><valuetype> - <array><valuetype><int/></valuetype></array></valuetype></array></type></argument> - <argument name='trans_r'><type><int/></type></argument> - <argument name='trans_g'><type><int/></type></argument> - <argument name='trans_b'><type><int/></type></argument> - - </arguments> - </method><method name='togif_fs'> - <returntype> - <object>string </object></returntype> - <arguments> - </arguments> - </method><method name='togif_fs'> - <returntype> - <object>string </object></returntype> - <arguments><argument name='trans_r'><type><int/></type></argument> - <argument name='trans_g'><type><int/></type></argument> - <argument name='trans_b'><type><int/></type></argument> - - </arguments> - </method><method name='togif_fs'> - <returntype> - <object>string </object></returntype> - <arguments><argument name='num_colors'><type><int/></type></argument> - <argument name='trans_r'><type><int/></type></argument> - <argument name='trans_g'><type><int/></type></argument> - <argument name='trans_b'><type><int/></type></argument> - - </arguments> - </method><method name='togif_fs'> - <returntype> - <object>string </object></returntype> - <arguments><argument name='colors'><type> - <array><valuetype> - <array><valuetype><int/></valuetype></array></valuetype></array></type></argument> - <argument name='trans_r'><type><int/></type></argument> - <argument name='trans_g'><type><int/></type></argument> - <argument name='trans_b'><type><int/></type></argument> - - </arguments> - </method><method name='gif_add'> - <returntype> - <object>string </object></returntype> - <arguments> - </arguments> - </method><method name='gif_add_fs'> - <returntype> - <object>string </object></returntype> - <arguments> - </arguments> - </method><method name='gif_add_nomap'> - <returntype> - <object>string </object></returntype> - <arguments> - </arguments> - </method><method name='gif_add_fs_nomap'> - <returntype> - <object>string </object></returntype> - <arguments> - </arguments> - </method><method name='*'> - <returntype> - <object>string gif_add</object></returntype> - <arguments><argument name='x'><type><int/></type></argument> - <argument name='y'><type><int/></type></argument> - - </arguments> - </method><method name='*'> - <returntype> - <object>string gif_add</object></returntype> - <arguments><argument name='x'><type><int/></type></argument> - <argument name='y'><type><int/></type></argument> - <argument name='delay_cs'><type><int/></type></argument> - - </arguments> - </method><method name='*'> - <returntype> - <object>string gif_add</object></returntype> - <arguments><argument name='x'><type><int/></type></argument> - <argument name='y'><type><int/></type></argument> - <argument name='num_colors'><type><int/></type></argument> - <argument name='delay_cs'><type><int/></type></argument> - - </arguments> - </method><method name='*'> - <returntype> - <object>string gif_add</object></returntype> - <arguments><argument name='x'><type><int/></type></argument> - <argument name='y'><type><int/></type></argument> - <argument name='colors'><type> - <array><valuetype> - <array><valuetype><int/></valuetype></array></valuetype></array></type></argument> - <argument name='delay_cs'><type><int/></type></argument> - - </arguments> - </method><doc> - <text> - old GIF API compatibility function. Don't use - in any new code. - - <table> - <tr><td/><td>is replaced by</td></tr> - <tr><td>gif_begin</td><td><ref resolved='predef::Image.GIF.header_block'>Image.GIF.header_block</ref></td></tr> - <tr><td>gif_end</td><td><ref resolved='predef::Image.GIF.end_block'>Image.GIF.end_block</ref></td></tr> - <tr><td>gif_netscape_loop</td><td><ref resolved='predef::Image.GIF.netscape_loop_block'>Image.GIF.netscape_loop_block</ref></td></tr> - <tr><td>togif</td><td><ref resolved='predef::Image.GIF.encode'>Image.GIF.encode</ref></td></tr> - <tr><td>togif_fs</td><td><ref resolved='predef::Image.GIF.encode'>Image.GIF.encode</ref>Â¹</td></tr> - <tr><td>gif_add</td><td><ref resolved='predef::Image.GIF.render_block'>Image.GIF.render_block</ref>Â¹Â²</td></tr> - <tr><td>gif_add_fs</td><td><ref resolved='predef::Image.GIF.render_block'>Image.GIF.render_block</ref>Â¹</td></tr> - <tr><td>gif_add_nomap</td><td><ref resolved='predef::Image.GIF.render_block'>Image.GIF.render_block</ref>Â²</td></tr> - <tr><td>gif_add_fs_nomap</td><td><ref resolved='predef::Image.GIF.render_block'>Image.GIF.render_block</ref>Â¹Â²</td></tr> - </table> - - Â¹ Use <ref>Image.colortable</ref> to get whatever dithering - you want. - - Â² local map toggle is sent as an argument - - </text> - <group><returns/><text> - GIF data. - </text></group> - - </doc> - </docgroup> - <docgroup homogen-name='`&' homogen-type='method'> - <method name='`&'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='operand'><type><object resolved='predef::Image.image.`&'/></type></argument> - - </arguments> - </method><method name='`&'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='color'><type> - <array><valuetype><int/></valuetype></array></type></argument> - - </arguments> - </method><method name='`&'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='value'><type><int/></type></argument> - - </arguments> - </method><doc> - <text> - makes a new image out of the minimum pixels values - - </text> - <group> - <param name='operand'/> - <text>the other image to compare with; - the images must have the same size.</text></group> - <group> - <param name='color'/> - <text>an array in format ({r,g,b}), this is equal - to using an uniform-colored image.</text></group> - <group> - <param name='value'/> - <text>equal to ({value,value,value}).</text></group> - <group><returns/><text> - 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 resolved='predef::Image.image.add_layers'>add_layers</ref></text></group> - - </doc> - </docgroup> - <docgroup homogen-name='`*' homogen-type='method'> - <method name='`*'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='operand'><type><object resolved='predef::Image.image.`*'/></type></argument> - - </arguments> - </method><method name='`*'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='color'><type> - <array><valuetype><int/></valuetype></array></type></argument> - - </arguments> - </method><method name='`*'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='value'><type><int/></type></argument> - - </arguments> - </method><doc> - <text> - Multiplies pixel values and creates a new image. - This can be useful to lower the values of an image, - making it greyer, for instance: - - <pre>image=image*128+64;</pre> - - </text> - <group> - <param name='operand'/> - <text>the other image to multiply with; - the images must have the same size.</text></group> - <group> - <param name='color'/> - <text>an array in format ({r,g,b}), this is equal - to using an uniform-colored image.</text></group> - <group> - <param name='value'/> - <text>equal to ({value,value,value}). - </text></group> - <group><returns/><text> - 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 resolved='predef::Image.image.add_layers'>add_layers</ref></text></group> - - </doc> - </docgroup> - <docgroup homogen-name='`+' homogen-type='method'> - <method name='`+'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='operand'><type><object resolved='predef::Image.image.`+'/></type></argument> - - </arguments> - </method><method name='`+'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='color'><type> - <array><valuetype><int/></valuetype></array></type></argument> - - </arguments> - </method><method name='`+'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='value'><type><int/></type></argument> - - </arguments> - </method><doc> - <text> - adds two images; values are truncated at 255. - </text> - <group> - <param name='operand'/> - <text>the image which to add.</text></group> - <group> - <param name='color'/> - <text>an array in format ({r,g,b}), this is equal - to using an uniform-colored image.</text></group> - <group> - <param name='value'/> - <text>equal to ({value,value,value}).</text></group> - <group><returns/><text> - 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 resolved='predef::Image.image.add_layers'>add_layers</ref></text></group> - - </doc> - </docgroup> - <docgroup homogen-name='`-' homogen-type='method'> - <method name='`-'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='operand'><type><object resolved='predef::Image.image.`-'/></type></argument> - - </arguments> - </method><method name='`-'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='color'><type> - <array><valuetype><int/></valuetype></array></type></argument> - - </arguments> - </method><method name='`-'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='value'><type><int/></type></argument> - - </arguments> - </method><doc> - <text> - makes a new image out of the difference - </text> - <group> - <param name='operand'/> - <text>the other image to compare with; - the images must have the same size.</text></group> - <group> - <param name='color'/> - <text>an array in format ({r,g,b}), this is equal - to using an uniform-colored image.</text></group> - <group> - <param name='value'/> - <text>equal to ({value,value,value}).</text></group> - <group><returns/><text> - 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 resolved='predef::Image.image.add_layers'>add_layers</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> - <docgroup homogen-type='method'> - <method name='`=='> - <returntype> - <object>int </object></returntype> - <arguments><argument name='operand'><type><object resolved='predef::Image.image.`=='/></type></argument> - - </arguments> - </method><method name='`=='> - <returntype> - <object>int </object></returntype> - <arguments><argument name='color'><type> - <array><valuetype><int/></valuetype></array></type></argument> - - </arguments> - </method><method name='`=='> - <returntype> - <object>int </object></returntype> - <arguments><argument name='value'><type><int/></type></argument> - - </arguments> - </method><method name='`<'> - <returntype> - <object>int </object></returntype> - <arguments><argument name='operand'><type><object resolved='predef::Image.image.`=='/></type></argument> - - </arguments> - </method><method name='`<'> - <returntype> - <object>int </object></returntype> - <arguments><argument name='color'><type> - <array><valuetype><int/></valuetype></array></type></argument> - - </arguments> - </method><method name='`<'> - <returntype> - <object>int </object></returntype> - <arguments><argument name='value'><type><int/></type></argument> - - </arguments> - </method><method name='`>'> - <returntype> - <object>int </object></returntype> - <arguments><argument name='operand'><type><object resolved='predef::Image.image.`=='/></type></argument> - - </arguments> - </method><method name='`>'> - <returntype> - <object>int </object></returntype> - <arguments><argument name='color'><type> - <array><valuetype><int/></valuetype></array></type></argument> - - </arguments> - </method><method name='`>'> - <returntype> - <object>int </object></returntype> - <arguments><argument name='value'><type><int/></type></argument> - - </arguments> - </method><doc> - <text> - Compares an image with another image or a color. - - Comparision is strict and on pixel-by-pixel basis. - (Means if not all pixel r,g,b values are - correct compared with the corresponding - pixel values, 0 is returned.) - - </text> - <group> - <param name='operand'/> - <text>the other image to compare with; - the images must have the same size.</text></group> - <group> - <param name='color'/> - <text>an array in format ({r,g,b}), this is equal - to using an uniform-colored image.</text></group> - <group> - <param name='value'/> - <text>equal to ({value,value,value}). - - </text></group> - <group><returns/><text> - true (1) or false (0). - </text></group> - <group><note/><text> - `< or `> on empty ("no image") image objects or images - with different size will result in an error. - `== is always true on two empty image objects and - always false if one and only one of the image objects - is empty or the images differs in size. - - a>=b and a<=b between objects is equal to !(a<b) and !(a>b), - which may not be what you want (since both < and > can return - false, comparing the same images). - </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 resolved='predef::Image.image.`&'>`&amp;</ref></text></group> - - </doc> - </docgroup> - <docgroup homogen-name='`|' homogen-type='method'> - <method name='`|'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='operand'><type><object resolved='predef::Image.image.`|'/></type></argument> - - </arguments> - </method><method name='`|'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='color'><type> - <array><valuetype><int/></valuetype></array></type></argument> - - </arguments> - </method><method name='`|'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='value'><type><int/></type></argument> - - </arguments> - </method><doc> - <text> - makes a new image out of the maximum pixels values - - </text> - <group> - <param name='operand'/> - <text>the other image to compare with; - the images must have the same size.</text></group> - <group> - <param name='color'/> - <text>an array in format ({r,g,b}), this is equal - to using an uniform-colored image.</text></group> - <group> - <param name='value'/> - <text>equal to ({value,value,value}).</text></group> - <group><returns/><text> - 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 resolved='predef::Image.image.add_layers'>add_layers</ref></text></group> - - </doc> - </docgroup> - <docgroup homogen-name='add_layers' homogen-type='method'> - <method name='add_layers'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='layer0'><type> - <array><valuetype> - <or><int/><object resolved='predef::Image.image.add_layers'/></or></valuetype></array></type></argument> - <argument><value>...</value></argument> - </arguments> - </method><method name='add_layers'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='x1'><type><int/></type></argument> - <argument name='y1'><type><int/></type></argument> - <argument name='x2'><type><int/></type></argument> - <argument name='y2'><type><int/></type></argument> - <argument name='layer0'><type> - <array><valuetype> - <or><int/><object resolved='predef::Image.image.add_layers'/></or></valuetype></array></type></argument> - <argument><value>...</value></argument> - </arguments> - </method><doc> - <text> - Using the called object as base, adds layers using masks, - opaque channel values and special methods. - - The destination image can also be cropped, thus - speeding up the process. - - Each array in the layers array is one of: - <pre> - ({object image,object|int mask}) - ({object image,object|int mask,int opaque_value}) - ({object image,object|int mask,int opaque_value,int method}) - </pre> - Given 0 as mask means the image is totally opaque. - - Default opaque value is 255, only using the mask. - - Methods for now are: - <pre> - 0 no operation (just paste with mask, default) - 1 maximum (`|) - 2 minimum (`&) - 3 multiply (`*) - 4 add (`+) - 5 diff (`-) - </pre> - The layer image and the current source are calculated - through the given method and then pasted using the mask - and the opaque channel value. - - All given images must be the same size. - - </text> - <group> - <param name='layer0'/> - <text>image to paste</text></group> - <group> - <param name='x1'/> - <param name='y1'/> - <param name='x2'/> - <param name='y2'/> - <text>rectangle for cropping - </text></group> - <group><returns/><text> - a new image object - </text></group> - <group><seealso/><text> - <ref resolved='predef::Image.image.paste_mask'>paste_mask</ref>, <ref resolved='predef::Image.image.paste_alpha'>paste_alpha</ref>, <ref resolved='predef::Image.image.paste_alpha_color'>paste_alpha_color</ref>, <ref resolved='predef::Image.image.`|'>`|</ref>, <ref resolved='predef::Image.image.`&'>`&amp;</ref>, <ref resolved='predef::Image.image.`*'>`*</ref>, <ref resolved='predef::Image.image.`+'>`+</ref>, <ref resolved='predef::Image.image.`-'>`-</ref></text></group> - - </doc> - </docgroup> - <docgroup homogen-name='apply_max' homogen-type='method'> - <method name='apply_max'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='matrix'><type> - <array><valuetype> - <array><valuetype> - <or><int/><array><valuetype><int/></valuetype></array></or></valuetype></array></valuetype></array></type></argument> - - </arguments> - </method><method name='apply_max'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='matrix'><type> - <array><valuetype> - <array><valuetype> - <or><int/><array><valuetype><int/></valuetype></array></or></valuetype></array></valuetype></array></type></argument> - <argument name='r'><type><int/></type></argument> - <argument name='g'><type><int/></type></argument> - <argument name='b'><type><int/></type></argument> - - </arguments> - </method><method name='apply_max'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='matrix'><type> - <array><valuetype> - <array><valuetype> - <or><int/><array><valuetype><int/></valuetype></array></or></valuetype></array></valuetype></array></type></argument> - <argument name='r'><type><int/></type></argument> - <argument name='g'><type><int/></type></argument> - <argument name='b'><type><int/></type></argument> - <argument name='div'><type> - <or><int/><float/></or></type></argument> - - </arguments> - </method><doc> - <text> - This is the same as apply_matrix, but it uses the maximum - instead. - - This function is not very fast. - - </text> - <group> - <param name='array'/> - <text>the matrix; innermost is a value or an array with red, green, blue - values for red, green, blue separation.</text></group> - <group> - <param name='r'/> - <param name='g'/> - <param name='b'/> - <text>base level of result, default is zero</text></group> - <group> - <param name='div'/> - <text>division factor, default is 1.0.</text></group> - <group><returns/><text> - the new image object - </text></group> - - </doc> - </docgroup> - <docgroup homogen-type='method'> - <method name='average'> - <returntype> - <array><valuetype><float/></valuetype></array></returntype> - <arguments> - </arguments> - </method><method name='min'> - <returntype> - <array><valuetype><int/></valuetype></array></returntype> - <arguments> - </arguments> - </method><method name='max'> - <returntype> - <array><valuetype><int/></valuetype></array></returntype> - <arguments> - </arguments> - </method><method name='sum'> - <returntype> - <array><valuetype><int/></valuetype></array></returntype> - <arguments> - </arguments> - </method><method name='sumf'> - <returntype> - <array><valuetype><float/></valuetype></array></returntype> - <arguments> - </arguments> - </method><doc> - <text> - Gives back the average, minimum, maximum color value, - and the sum of all pixel's color value. - - </text> - <group><note/><text> - sum() values can wrap! Most systems only have 31 bits - available for positive integers. (Meaning, be careful - with images that have more than 8425104 pixels.) - - average() and sumf() may also wrap, but on a line basis. - (Meaning, be careful with images that are wider - than 8425104 pixels.) These functions may have a precision - problem instead, during to limits in the 'double' C type and/or - 'float' Pike type. - </text></group> - - </doc> - </docgroup> - <docgroup homogen-name='dct' homogen-type='method'> - <method name='dct'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='newx'><type><int/></type></argument> - <argument name='newy'><type><int/></type></argument> - - </arguments> - </method><doc> - <text> - Scales the image to a new size. - - Method for scaling is rather complex; - the image is transformed via a cosine transform, - and then resampled back. - - This gives a quality-conserving upscale, - but the algorithm used is n*n+n*m, where n - and m is pixels in the original and new image. - - Recommended wrapping algorithm is to scale - overlapping parts of the image-to-be-scaled. - - This functionality is actually added as an - true experiment, but works... - - </text> - <group> - <param name='newx'/> - <param name='newy'/> - <text>new image size in pixels - </text></group> - <group><returns/><text> - the new image object - </text></group> - <group><note/><text> - Do NOT use this function if you don't know what - you're dealing with! Read some signal theory first... - </text></group> - - </doc> - </docgroup> - <docgroup homogen-type='method'> - <method name='find_min'> - <returntype> - <array><valuetype><int/></valuetype></array></returntype> - <arguments> - </arguments> - </method><method name='find_max'> - <returntype> - <array><valuetype><int/></valuetype></array></returntype> - <arguments> - </arguments> - </method><method name='find_min'> - <returntype> - <array><valuetype><int/></valuetype></array></returntype> - <arguments><argument name='r'><type><int/></type></argument> - <argument name='g'><type><int/></type></argument> - <argument name='b'><type><int/></type></argument> - - </arguments> - </method><method name='find_max'> - <returntype> - <array><valuetype><int/></valuetype></array></returntype> - <arguments><argument name='r'><type><int/></type></argument> - <argument name='g'><type><int/></type></argument> - <argument name='b'><type><int/></type></argument> - - </arguments> - </method><doc> - <text> - Gives back the position of the minimum or maximum - pixel value, weighted to grey. - - </text> - <group> - <param name='r'/> - <param name='g'/> - <param name='b'/> - <text>weight of color, default is r=87,g=127,b=41, same - as the <ref>grey</ref>() method.</text></group> - - </doc> - </docgroup> - <docgroup homogen-type='method'> - <method name='frompnm'> - <returntype> - <or><object resolved='predef::Image.image.frompnm'/><object>string </object></or></returntype> - <arguments><argument name='pnm'><type><string/></type></argument> - - </arguments> - </method><method name='fromppm'> - <returntype> - <or><object resolved='predef::Image.image.frompnm'/><object>string </object></or></returntype> - <arguments><argument name='pnm'><type><string/></type></argument> - - </arguments> - </method><doc> - <text> - compability method - do not use in new programs. - - See <ref resolved='predef::Image.PNM.decode'>Image.PNM.decode</ref>(). - - </text> - <group> - <param name='pnm'/> - <text>pnm data, as a string</text></group> - <group><returns/><text> - the called object or a hint of what wronged. - </text></group> - - </doc> - </docgroup> - <docgroup homogen-name='make_ascii' homogen-type='method'> - <method name='make_ascii'> - <returntype> - <object>string </object></returntype> - <arguments><argument name='orient1'><type><object resolved='predef::Image.image.make_ascii'/></type></argument> - <argument name='objectorient2'><type> - <object resolved='predef::Image.image.make_ascii'/></type></argument> - <argument name='objectorient3'><type> - <object resolved='predef::Image.image.make_ascii'/></type></argument> - <argument name='objectorient4'><type> - <object resolved='predef::Image.image.make_ascii'/></type></argument> - <argument name='int|voidxsize'><type> - <object resolved='predef::Image.image.make_ascii'/></type></argument> - <argument name='int|voidysize'><type> - <object resolved='predef::Image.image.make_ascii'/></type></argument> - - </arguments> - </method><doc> - <text> - This method creates a string that looks like - the image. Example: - <pre> - //Stina is an image with a cat. - array(object) Stina4=Stina->orient4(); - Stina4[1]*=215; - Stina4[3]*=215; - string foo=Stina->make_ascii(@Stina4,40,4,8); - </pre> - - </text> - <group><returns/><text> - some nice acsii-art. - </text></group> - <group><note/><text> - Experimental. - <pre> | / - \ - hue= 0 64 128 192 (=red in an hsv image) - </pre> - </text></group> - <group><seealso/><text> - <ref resolved='predef::Image.image.orient'>orient</ref>, <ref resolved='predef::Image.image.orient4'>orient4</ref></text></group> - - </doc> - </docgroup> - <docgroup homogen-name='match' homogen-type='method'> - <method name='match'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='scale'><type> - <or><int/><float/></or></type></argument> - <argument name='objectneedle'><type> - <object resolved='predef::Image.image.match'/></type></argument> - - </arguments> - </method><method name='match'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='scale'><type> - <or><int/><float/></or></type></argument> - <argument name='objectneedle'><type> - <object resolved='predef::Image.image.match'/></type></argument> - <argument name='objecthaystack_cert'><type> - <object resolved='predef::Image.image.match'/></type></argument> - <argument name='objectneedle_cert'><type> - <object resolved='predef::Image.image.match'/></type></argument> - - </arguments> - </method><method name='match'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='scale'><type> - <or><int/><float/></or></type></argument> - <argument name='objectneedle'><type> - <object resolved='predef::Image.image.match'/></type></argument> - <argument name='objecthaystack_avoid'><type> - <object resolved='predef::Image.image.match'/></type></argument> - <argument name='intfoo'><type> - <object resolved='predef::Image.image.match'/></type></argument> - - </arguments> - </method><method name='match'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='scale'><type> - <or><int/><float/></or></type></argument> - <argument name='objectneedle'><type> - <object resolved='predef::Image.image.match'/></type></argument> - <argument name='objecthaystack_cert'><type> - <object resolved='predef::Image.image.match'/></type></argument> - <argument name='objectneedle_cert'><type> - <object resolved='predef::Image.image.match'/></type></argument> - <argument name='objecthaystack_avoid'><type> - <object resolved='predef::Image.image.match'/></type></argument> - <argument name='intfoo'><type> - <object resolved='predef::Image.image.match'/></type></argument> - - </arguments> - </method><doc> - <text> - This method creates an image that describes the - match in every pixel in the image and the - needle-Image. - - <pre> - new pixel value = - sum( abs(needle_pixel-haystack_pixel)) - </pre> - - The new image only have the red rgb-part set. - - - </text> - <group> - <param name='scale'/> - <text>Every pixel is divided with this value. - Note that a proper value here depends on - the size of the neadle. - </text></group> - <group> - <param name='needle'/> - <text>The image to use for the matching. - </text></group> - <group> - <param name='haystack_cert'/> - <text>This image should be the same size as - the image itselves. A non-white-part of the - haystack_cert-image modifies the output - by lowering it. - </text></group> - <group> - <param name='needle_cert'/> - <text>The same, but for the needle-image. - </text></group> - <group> - <param name='foo'/> - <param name='haystack_avoid'/> - <text>This image should be the same size as - the image itselves. If foo is less than the red - value in haystack_avoid the corresponding - matching-calculating is not calculated. The avoided parts - are drawn in the color 0,100,0. - </text></group> - <group><returns/><text> - the new image object - </text></group> - <group><note/><text> - Experimental. - </text></group> - <group><seealso/><text> - <ref resolved='predef::Image.image.phasev'>phasev</ref>, <ref resolved='predef::Image.image.phaseh'>phaseh</ref></text></group> - - </doc> - </docgroup> - <docgroup homogen-name='mirrorx' homogen-type='method'> - <method name='mirrorx'> - <returntype> - <object>object </object></returntype> - <arguments> - </arguments> - </method><doc> - <text> - mirrors an image: - <table><tr valign='center'> - <td><image file='predef.Image.image.mirrorx.1.png' height='115' width='80'>matrix.c0.png</image></td> - <td><image file='predef.Image.image.mirrorx.2.png' height='115' width='80'>matrix.c1.png</image></td> - </tr><tr valign='center'> - <td>original</td> - <td>->mirrorx();</td> - </tr></table> - </text> - <group><returns/><text> - the new image object - </text></group> - - </doc> - </docgroup> - <docgroup homogen-name='mirrory' homogen-type='method'> - <method name='mirrory'> - <returntype> - <object>object </object></returntype> - <arguments> - </arguments> - </method><doc> - <text> - mirrors an image: - <table><tr valign='center'> - <td><image file='predef.Image.image.mirrory.1.png' height='115' width='80'>matrix.c2.png</image></td> - <td><image file='predef.Image.image.mirrory.2.png' height='115' width='80'>matrix.c3.png</image></td> - </tr><tr valign='center'> - <td>original</td> - <td>->mirrory();</td> - </tr></table> - - </text> - - </doc> - </docgroup> - <docgroup homogen-name='noise' homogen-type='method'> - <method name='noise'> - <returntype> - <object>void </object></returntype> - <arguments><argument name='colorrange'><type> - <array><valuetype> - <or><float/><int/><array><valuetype><int/></valuetype></array></or></valuetype></array></type></argument> - - </arguments> - </method><method name='noise'> - <returntype> - <object>void </object></returntype> - <arguments><argument name='colorrange'><type> - <array><valuetype> - <or><float/><int/><array><valuetype><int/></valuetype></array></or></valuetype></array></type></argument> - <argument name='scale'><type><float/></type></argument> - <argument name='xdiff'><type><float/></type></argument> - <argument name='ydiff'><type><float/></type></argument> - <argument name='cscale'><type><float/></type></argument> - - </arguments> - </method><doc> - <text> - Gives a new image with the old image's size, - filled width a 'noise' pattern. - - The random seed may be different with each instance of pike. - - Example: - <tt>->noise( ({0,({255,0,0}), 0.3,({0,255,0}), 0.6,({0,0,255}), 0.8,({255,255,0})}), 0.2,0.0,0.0,1.0 );</tt> - - - </text> - <group> - <param name='colorrange'/> - <text>colorrange table</text></group> - <group> - <param name='scale'/> - <text>default value is 0.1</text></group> - <group> - <param name='xdiff'/> - <param name='ydiff'/> - <text>default value is 0,0</text></group> - <group> - <param name='cscale'/> - <text>default value is 1</text></group> - <group><seealso/><text> - <ref resolved='predef::Image.image.turbulence'>turbulence</ref></text></group> - - </doc> - </docgroup> - <docgroup homogen-type='method'> - <method name='orient'> - <returntype> - <object>object </object></returntype> - <arguments><argument><value>void|array(object)</value></argument> - </arguments> - </method><method name='orient4'> - <returntype> - <array><valuetype><object resolved='predef::Image.image.orient'/></valuetype></array></returntype> - <arguments> - </arguments> - </method><doc> - <text> - Draws images describing the orientation - of the current image. - - <tt>orient</tt> gives an HSV image - (run a <ref>hsv_to_rgb</ref> pass on it - to get a viewable image). - corresponding to the angle of the - orientation: - <pre> | / - \ - hue= 0 64 128 192 (=red in an hsv image) - purple cyan green red - </pre> - Red, green and blue channels are added - and not compared separately. - - If you first use orient4 you can give its - output as input to this function. - - The <tt>orient4</tt> function gives back - 4 image objects, corresponding to the - amount of different directions, see above. - - </text> - <group><returns/><text> - an image or an array of the four new image objects - </text></group> - <group><note/><text> - experimental status; may not be exact the same - output in later versions - </text></group> - - </doc> - </docgroup> - <docgroup homogen-name='paste' homogen-type='method'> - <method name='paste'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='image'><type><object resolved='predef::Image.image.paste'/></type></argument> - - </arguments> - </method><method name='paste'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='image'><type><object resolved='predef::Image.image.paste'/></type></argument> - <argument name='x'><type><int/></type></argument> - <argument name='y'><type><int/></type></argument> - - </arguments> - </method><doc> - <text> - Pastes a given image over the current image. - - </text> - <group> - <param name='image'/> - <text>image to paste (may be empty, needs to be an image object)</text></group> - <group> - <param name='x'/> - <param name='y'/> - <text>where to paste the image; default is 0,0 - </text></group> - <group><returns/><text> - the object called - </text></group> - <group><seealso/><text> - <ref resolved='predef::Image.image.paste_mask'>paste_mask</ref>, <ref resolved='predef::Image.image.paste_alpha'>paste_alpha</ref>, <ref resolved='predef::Image.image.paste_alpha_color'>paste_alpha_color</ref></text></group> - - </doc> - </docgroup> - <docgroup homogen-name='paste_alpha' homogen-type='method'> - <method name='paste_alpha'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='image'><type><object resolved='predef::Image.image.paste_alpha'/></type></argument> - <argument name='alpha'><type><int/></type></argument> - - </arguments> - </method><method name='paste_alpha'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='image'><type><object resolved='predef::Image.image.paste_alpha'/></type></argument> - <argument name='alpha'><type><int/></type></argument> - <argument name='x'><type><int/></type></argument> - <argument name='y'><type><int/></type></argument> - - </arguments> - </method><doc> - <text> - Pastes a given image over the current image, with - the specified alpha channel value. - - An alpha channel value of 0 leaves nothing of the original - image in the paste area, 255 is meaningless and makes the - given image invisible. - - </text> - <group> - <param name='image'/> - <text>image to paste</text></group> - <group> - <param name='alpha'/> - <text>alpha channel value</text></group> - <group> - <param name='x'/> - <param name='y'/> - <text>where to paste the image; default is 0,0 - </text></group> - <group><returns/><text> - the object called - </text></group> - <group><seealso/><text> - <ref resolved='predef::Image.image.paste_mask'>paste_mask</ref>, <ref resolved='predef::Image.image.paste'>paste</ref>, <ref resolved='predef::Image.image.paste_alpha_color'>paste_alpha_color</ref></text></group> - - </doc> - </docgroup> - <docgroup homogen-name='paste_alpha_color' homogen-type='method'> - <method name='paste_alpha_color'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='mask'><type><object resolved='predef::Image.image.paste_alpha_color'/></type></argument> - - </arguments> - </method><method name='paste_alpha_color'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='mask'><type><object resolved='predef::Image.image.paste_alpha_color'/></type></argument> - <argument name='x'><type><int/></type></argument> - <argument name='y'><type><int/></type></argument> - - </arguments> - </method><method name='paste_alpha_color'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='mask'><type><object resolved='predef::Image.image.paste_alpha_color'/></type></argument> - <argument name='r'><type><int/></type></argument> - <argument name='g'><type><int/></type></argument> - <argument name='b'><type><int/></type></argument> - - </arguments> - </method><method name='paste_alpha_color'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='mask'><type><object resolved='predef::Image.image.paste_alpha_color'/></type></argument> - <argument name='r'><type><int/></type></argument> - <argument name='g'><type><int/></type></argument> - <argument name='b'><type><int/></type></argument> - <argument name='x'><type><int/></type></argument> - <argument name='y'><type><int/></type></argument> - - </arguments> - </method><doc> - <text> - Pastes a given color over the current image, - using the given mask as opaque channel. - - A pixel value of 255 makes the result become the color given, - 0 doesn't change anything. - - The masks red, green and blue values are used separately. - If no color are given, the current is used. - - </text> - <group> - <param name='mask'/> - <text>mask image</text></group> - <group> - <param name='r'/> - <param name='g'/> - <param name='b'/> - <text>what color to paint with; default is current</text></group> - <group> - <param name='x'/> - <param name='y'/> - <text>where to paste the image; default is 0,0 - </text></group> - <group><returns/><text> - the object called - </text></group> - <group><seealso/><text> - <ref resolved='predef::Image.image.paste_mask'>paste_mask</ref>, <ref resolved='predef::Image.image.paste_alpha'>paste_alpha</ref>, <ref resolved='predef::Image.image.paste_alpha_color'>paste_alpha_color</ref></text></group> - - </doc> - </docgroup> - <docgroup homogen-name='paste_mask' homogen-type='method'> - <method name='paste_mask'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='image'><type><object resolved='predef::Image.image.paste_mask'/></type></argument> - <argument name='mask'><type><object resolved='predef::Image.image.paste_mask'/></type></argument> - - </arguments> - </method><method name='paste_mask'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='image'><type><object resolved='predef::Image.image.paste_mask'/></type></argument> - <argument name='mask'><type><object resolved='predef::Image.image.paste_mask'/></type></argument> - <argument name='x'><type><int/></type></argument> - <argument name='y'><type><int/></type></argument> - - </arguments> - </method><doc> - <text> - Pastes a given image over the current image, - using the given mask as opaque channel. - - A pixel value of 255 makes the result become a pixel - from the given image, 0 doesn't change anything. - - The masks red, green and blue values are used separately. - - </text> - <group> - <param name='image'/> - <text>image to paste</text></group> - <group> - <param name='mask'/> - <text>mask image</text></group> - <group> - <param name='x'/> - <param name='y'/> - <text>where to paste the image; default is 0,0 - </text></group> - <group><returns/><text> - the object called - </text></group> - <group><seealso/><text> - <ref resolved='predef::Image.image.paste'>paste</ref>, <ref resolved='predef::Image.image.paste_alpha'>paste_alpha</ref>, <ref resolved='predef::Image.image.paste_alpha_color'>paste_alpha_color</ref></text></group> - - </doc> - </docgroup> - <docgroup homogen-type='method'> - <method name='phaseh'> - <returntype> - <object>object </object></returntype> - <arguments> - </arguments> - </method><method name='phasev'> - <returntype> - <object>object </object></returntype> - <arguments> - </arguments> - </method><method name='phasevh'> - <returntype> - <object>object </object></returntype> - <arguments> - </arguments> - </method><method name='phasehv'> - <returntype> - <object>object </object></returntype> - <arguments> - </arguments> - </method><doc> - <text> - Draws images describing the phase - of the current image. phaseh gives the - horizontal phase and phasev the vertical - phase. - - <tt>phaseh</tt> gives an image - were - <pre> - max falling min rising - value= 0 64 128 192 - </pre> - - 0 is set if there is no way to determine - if it is rising or falling. This is done - for the every red, green and blue part of - the image. - - Phase images can be used to create ugly - effects or to find meta-information - in the orginal image. - - </text> - <group><returns/><text> - the new image object - </text></group> - <group><note/><text> - experimental status; may not be exact the same - output in later versions - </text></group> - <group><bugs/><text> - 0 should not be set as explained above. - </text></group> - - </doc> - </docgroup> - <docgroup homogen-name='polyfill' homogen-type='method'> - <method name='polyfill'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='curve'><type><varargs> - <array><valuetype> - <or><int/><float/></or></valuetype></array></varargs></type></argument> - - </arguments> - </method><doc> - <text> - fills an area with the current color - - </text> - <group> - <param name='curve'/> - <text>curve(s), <tt>({x1,y1,x2,y2,...,xn,yn})</tt>, - automatically closed. - - If any given curve is inside another, it - will make a hole. - </text></group> - <group><returns/><text> - the current object - </text></group> - <group><note/><text> - Lines in the polygon may not be crossed without - the crossing coordinate specified in both lines. - - </text></group> - <group><bugs/><text> - Inverted lines reported on Intel and Alpha processors. - - </text></group> - <group><seealso/><text> - <ref>setcolor</ref></text></group> - - </doc> - </docgroup> - <docgroup homogen-name='random' homogen-type='method'> - <method name='random'> - <returntype> - <object>object </object></returntype> - <arguments> - </arguments> - </method><method name='random'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='seed'><type><int/></type></argument> - - </arguments> - </method><doc> - <text> - Gives a randomized image; - <table><tr valign='center'> - <td><image file='predef.Image.image.random.1.png' height='115' width='80'>pattern.c1.png</image></td> - <td><image file='predef.Image.image.random.2.png' height='115' width='80'>pattern.c2.png</image></td> - <td><image file='predef.Image.image.random.3.png' height='115' width='80'>pattern.c3.png</image></td> - <td><image file='predef.Image.image.random.4.png' height='115' width='80'>pattern.c4.png</image></td> - <td><image file='predef.Image.image.random.5.png' height='115' width='80'>pattern.c5.png</image></td> - <td><image file='predef.Image.image.random.6.png' height='115' width='80'>pattern.c6.png</image></td> - </tr><tr> - <td>original</td> - <td>->random()</td> - <td>->random(17)</td> - <td>greyed (same again)</td> - <td>color(red) (same again)</td> - <td>...red channel </td> - </tr></table> - - Use with ->grey() or ->color() for one-color-results. - - </text> - <group><returns/><text> - a new image - </text></group> - - </doc> - </docgroup> - <docgroup homogen-type='method'> - <method name='rotate'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='angle'><type> - <or><int/><float/></or></type></argument> - - </arguments> - </method><method name='rotate'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='angle'><type> - <or><int/><float/></or></type></argument> - <argument name='r'><type><int/></type></argument> - <argument name='g'><type><int/></type></argument> - <argument name='b'><type><int/></type></argument> - - </arguments> - </method><method name='rotate_expand'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='angle'><type> - <or><int/><float/></or></type></argument> - - </arguments> - </method><method name='rotate_expand'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='angle'><type> - <or><int/><float/></or></type></argument> - <argument name='r'><type><int/></type></argument> - <argument name='g'><type><int/></type></argument> - <argument name='b'><type><int/></type></argument> - - </arguments> - </method><doc> - <text> - Rotates an image a certain amount of degrees (360° is - a complete rotation) counter-clockwise: - - <table><tr valign='center'> - <td><image file='predef.Image.image.rotate.1.png' height='115' width='80'>matrix.c4.png</image></td> - <td><image file='predef.Image.image.rotate.2.png' height='141' width='113'>matrix.c5.png</image></td> - <td><image file='predef.Image.image.rotate.3.png' height='141' width='113'>matrix.c6.png</image></td> - </tr><tr valign='center'> - <td>original</td> - <td>->rotate(15,255,0,0);</td> - <td>->rotate_expand(15);</td> - </tr></table> - - The "expand" variant of functions stretches the - image border pixels rather then filling with - the given or current color. - - This rotate uses the <ref resolved='predef::Image.image.skewx'>skewx</ref>() and <ref resolved='predef::Image.image.skewy'>skewy</ref>() functions. - </text> - <group> - <param name='angle'/> - <text>the number of degrees to rotate</text></group> - <group> - <param name='r'/> - <param name='g'/> - <param name='b'/> - <text>color to fill with; default is current</text></group> - <group><returns/><text> - the new image object - </text></group> - - </doc> - </docgroup> - <docgroup homogen-name='rotate_ccw' homogen-type='method'> - <method name='rotate_ccw'> - <returntype> - <object>object </object></returntype> - <arguments> - </arguments> - </method><doc> - <text> - rotates an image counter-clockwise, 90 degrees. - - <table><tr valign='center'> - <td><image file='predef.Image.image.rotate_ccw.1.png' height='115' width='80'>matrix.c7.png</image></td> - <td><image file='predef.Image.image.rotate_ccw.2.png' height='80' width='115'>matrix.c8.png</image></td> - </tr><tr valign='center'> - <td>original</td> - <td>->rotate_ccw();</td> - </tr></table> - - </text> - <group><returns/><text> - the new image object - </text></group> - - </doc> - </docgroup> - <docgroup homogen-name='rotate_cw' homogen-type='method'> - <method name='rotate_cw'> - <returntype> - <object>object </object></returntype> - <arguments> - </arguments> - </method><doc> - <text> - rotates an image clockwise, 90 degrees. - - <table><tr valign='center'> - <td><image file='predef.Image.image.rotate_cw.1.png' height='115' width='80'>matrix.c9.png</image></td> - <td><image file='predef.Image.image.rotate_cw.2.png' height='80' width='115'>matrix.c10.png</image></td> - </tr><tr valign='center'> - <td>original</td> - <td>->rotate_cw();</td> - </tr></table> - </text> - <group><returns/><text> - the new image object - </text></group> - - </doc> - </docgroup> - <docgroup homogen-name='scale' homogen-type='method'> - <method name='scale'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='factor'><type><float/></type></argument> - - </arguments> - </method><method name='scale'> - <returntype> - <object>object </object></returntype> - <arguments><argument><value>0.5</value></argument> - </arguments> - </method><method name='scale'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='xfactor'><type><float/></type></argument> - <argument name='yfactor'><type><float/></type></argument> - - </arguments> - </method><doc> - <text> - scales the image with a factor, - 0.5 is an optimized case. - </text> - <group> - <param name='factor'/> - <text>factor to use for both x and y</text></group> - <group> - <param name='xfactor'/> - <param name='yfactor'/> - <text>separate factors for x and y - </text></group> - <group><returns/><text> - the new image object - </text></group> - - </doc> - </docgroup> - <docgroup homogen-name='scale' homogen-type='method'> - <method name='scale'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='newxsize'><type><int/></type></argument> - <argument name='newysize'><type><int/></type></argument> - - </arguments> - </method><method name='scale'> - <returntype> - <object>object </object></returntype> - <arguments><argument><value>0</value></argument><argument name='newysize'><type><int/></type></argument> - - </arguments> - </method><method name='scale'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='newxsize'><type><int/></type></argument> - <argument><value>0</value></argument> - </arguments> - </method><doc> - <text> - scales the image to a specified new size, - if one of newxsize or newysize is 0, - the image aspect ratio is preserved. - </text> - <group> - <param name='newxsize'/> - <param name='newysize'/> - <text>new image size in pixels - </text></group> - <group><returns/><text> - the new image object - </text></group> - <group><note/><text> - resulting image will be 1x1 pixels, at least - </text></group> - - </doc> - </docgroup> - <docgroup homogen-type='method'> - <method name='skewx'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='x'><type><int/></type></argument> - - </arguments> - </method><method name='skewx'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='yfactor'><type><int/></type></argument> - - </arguments> - </method><method name='skewx'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='x'><type><int/></type></argument> - <argument name='r'><type><int/></type></argument> - <argument name='g'><type><int/></type></argument> - <argument name='b'><type><int/></type></argument> - - </arguments> - </method><method name='skewx'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='yfactor'><type><int/></type></argument> - <argument name='r'><type><int/></type></argument> - <argument name='g'><type><int/></type></argument> - <argument name='b'><type><int/></type></argument> - - </arguments> - </method><method name='skewx_expand'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='x'><type><int/></type></argument> - - </arguments> - </method><method name='skewx_expand'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='yfactor'><type><int/></type></argument> - - </arguments> - </method><method name='skewx_expand'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='x'><type><int/></type></argument> - <argument name='r'><type><int/></type></argument> - <argument name='g'><type><int/></type></argument> - <argument name='b'><type><int/></type></argument> - - </arguments> - </method><method name='skewx_expand'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='yfactor'><type><int/></type></argument> - <argument name='r'><type><int/></type></argument> - <argument name='g'><type><int/></type></argument> - <argument name='b'><type><int/></type></argument> - - </arguments> - </method><doc> - <text> - Skews an image an amount of pixels or a factor; - a skew-x is a transformation: - - <table><tr valign='center'> - <td><image file='predef.Image.image.skewx.1.png' height='115' width='80'>matrix.c11.png</image></td> - <td><image file='predef.Image.image.skewx.2.png' height='115' width='95'>matrix.c12.png</image></td> - <td><image file='predef.Image.image.skewx.3.png' height='115' width='95'>matrix.c13.png</image></td> - </tr><tr valign='center'> - <td>original</td> - <td>->skewx(15,255,0,0);</td> - <td>->skewx_expand(15);</td> - </tr></table> - - </text> - <group> - <param name='x'/> - <text>the number of pixels - The "expand" variant of functions stretches the - image border pixels rather then filling with - the given or current color.</text></group> - <group> - <param name='yfactor'/> - <text>best described as: x=yfactor*this->ysize()</text></group> - <group> - <param name='r'/> - <param name='g'/> - <param name='b'/> - <text>color to fill with; default is current</text></group> - <group><returns/><text> - the new image object - </text></group> - - </doc> - </docgroup> - <docgroup homogen-type='method'> - <method name='skewy'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='y'><type><int/></type></argument> - - </arguments> - </method><method name='skewy'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='xfactor'><type><int/></type></argument> - - </arguments> - </method><method name='skewy'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='y'><type><int/></type></argument> - <argument name='r'><type><int/></type></argument> - <argument name='g'><type><int/></type></argument> - <argument name='b'><type><int/></type></argument> - - </arguments> - </method><method name='skewy'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='xfactor'><type><int/></type></argument> - <argument name='r'><type><int/></type></argument> - <argument name='g'><type><int/></type></argument> - <argument name='b'><type><int/></type></argument> - - </arguments> - </method><method name='skewy_expand'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='y'><type><int/></type></argument> - - </arguments> - </method><method name='skewy_expand'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='xfactor'><type><int/></type></argument> - - </arguments> - </method><method name='skewy_expand'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='y'><type><int/></type></argument> - <argument name='r'><type><int/></type></argument> - <argument name='g'><type><int/></type></argument> - <argument name='b'><type><int/></type></argument> - - </arguments> - </method><method name='skewy_expand'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='xfactor'><type><int/></type></argument> - <argument name='r'><type><int/></type></argument> - <argument name='g'><type><int/></type></argument> - <argument name='b'><type><int/></type></argument> - - </arguments> - </method><doc> - <text> - Skews an image an amount of pixels or a factor; - a skew-y is a transformation: - - <table><tr valign='center'> - <td><image file='predef.Image.image.skewy.1.png' height='115' width='80'>matrix.c14.png</image></td> - <td><image file='predef.Image.image.skewy.2.png' height='130' width='80'>matrix.c15.png</image></td> - <td><image file='predef.Image.image.skewy.3.png' height='130' width='80'>matrix.c16.png</image></td> - </tr><tr valign='center'> - <td>original</td> - <td>->skewy(15,255,0,0);</td> - <td>->skewy_expand(15);</td> - </tr></table> - - The "expand" variant of functions stretches the - image border pixels rather then filling with - the given or current color. - </text> - <group> - <param name='y'/> - <text>the number of pixels</text></group> - <group> - <param name='xfactor'/> - <text>best described as: t=xfactor*this->xsize()</text></group> - <group> - <param name='r'/> - <param name='g'/> - <param name='b'/> - <text>color to fill with; default is current</text></group> - <group><returns/><text> - the new image object - </text></group> - - </doc> - </docgroup> - <docgroup homogen-name='toppm' homogen-type='method'> - <method name='toppm'> - <returntype> - <object>string </object></returntype> - <arguments> - </arguments> - </method><doc> - <text> - compability method - do not use in new programs. - - See <ref resolved='predef::Image.PNM.encode'>Image.PNM.encode</ref>(). - - </text> - <group><returns/><text> - PPM data - </text></group> - - </doc> - </docgroup> - <docgroup homogen-name='turbulence' homogen-type='method'> - <method name='turbulence'> - <returntype> - <object>void </object></returntype> - <arguments><argument name='colorrange'><type> - <array><valuetype> - <or><float/><int/><array><valuetype><int/></valuetype></array></or></valuetype></array></type></argument> - - </arguments> - </method><method name='turbulence'> - <returntype> - <object>void </object></returntype> - <arguments><argument name='colorrange'><type> - <array><valuetype> - <or><float/><int/><array><valuetype><int/></valuetype></array></or></valuetype></array></type></argument> - <argument name='octaves'><type><int/></type></argument> - <argument name='scale'><type><float/></type></argument> - <argument name='xdiff'><type><float/></type></argument> - <argument name='ydiff'><type><float/></type></argument> - <argument name='cscale'><type><float/></type></argument> - - </arguments> - </method><doc> - <text> - gives a new image with the old image's size, - filled width a 'turbulence' pattern - - The random seed may be different with each instance of pike. - - Example: - <tt>->turbulence( ({0,({229,204,204}), 0.9,({229,20,20}), 0.9,Image.color.black}) );</tt> - - </text> - <group> - <param name='colorrange'/> - <text>colorrange table</text></group> - <group> - <param name='octaves'/> - <text>default value is 3</text></group> - <group> - <param name='scale'/> - <text>default value is 0.1</text></group> - <group> - <param name='xdiff'/> - <param name='ydiff'/> - <text>default value is 0,0</text></group> - <group> - <param name='cscale'/> - <text>default value is 1</text></group> - <group><seealso/><text> - <ref resolved='predef::Image.image.noise'>noise</ref></text></group> - - </doc> - </docgroup> - </class> - </module> + <module name='Math'> <class name='Matrix'> <doc>

autodoc.git/ autodoc.xml

1999-04-13

1999-04-13 12:32:50 by Mirar (Pontus Hagland) <pike@sort.mirar.org>