doc/ilist.html in rmagick-1.14.1 vs doc/ilist.html in rmagick-1.15.0

- old
+ new

@@ -4,11 +4,11 @@ <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta name="generator" content= "HTML Tidy for Linux/x86 (vers 1st December 2004), see www.w3.org" /> - <title>RMagick: class ImageList</title> + <title>RMagick 1.15.0: class ImageList</title> <meta http-equiv="Content-Type" content= "text/html; charset=us-ascii" /> <meta name="GENERATOR" content="Quanta Plus" /> <meta name="Copyright" content= "Copyright (C) 2005 by Timothy P. Hunter" /> @@ -18,11 +18,11 @@ <script type="text/javascript" src="scripts/doc.js"> </script> </head> <body> - <h6 id="header">RMagick User's Guide and Reference</h6> + <h6 id="header">RMagick 1.15.0 User's Guide and Reference</h6> <div class="nav"> &laquo;&nbsp;<a href="magick.html">Prev</a> | <a href= "index.html">Contents</a> | <a href= "imageattrs.html">Next</a>&nbsp;&raquo; @@ -89,22 +89,24 @@ <li><a href="#flatten_images">flatten_images</a></li> <li><a href="#from_blob">from_blob</a></li> + <li><a href="#fx">fx</a></li> + <li><a href="#inspect">inspect</a></li> <li><a href="#map">map</a></li> <li><a href="#montage">montage</a></li> - - <li><a href="#morph">morph</a></li> </ul> </div> <div class="toccol"> <ul> + <li><a href="#morph">morph</a></li> + <li><a href="#mosaic">mosaic</a></li> <li><a href="#new_image">new_image</a></li> <li><a href="#optimize_layers">optimize_layers</a></li> @@ -856,9 +858,86 @@ "image1.html#from_blob">Image.from_blob</a> <h4>Magick API</h4> <p>BlobToImageList</p> + </div> + + <div class="sig"> + <h3 id="fx">fx</h3> + + <p>imagelist.fx(expression [, channel...]) -&gt; anImage</p> + </div> + + <div class="desc"> + <h4>Description</h4> + + <p>Applies the specified mathematical expression to the input + images. This method corresponds to ImageMagick's <a href= + "http://redux.imagemagick.org/script/fx.php">-fx</a> + operator.</p> + + <h4>Arguments</h4> + + <dl> + <dt>expression</dt> + + <dd>A mathematical expression of the form accepted by the -fx + operator..</dd> + + <dt>channel...</dt> + + <dd>0 or more <a href= + "constants.html#ChannelType">ChannelType</a> arguments. + Specify the output channels. If no channels are specified the + result is set over all channels except the opacity + channel.</dd> + </dl> + + <h4>Notes</h4> + + <ul> + <li>Fx expressions are interpreted. Therefore this method can + be quite slow depending on the complexity of the expression. + Generally you will get better performance by accessing the + image pixels as <a href="struct.html#Pixel">Pixel</a> objects + (see <a href="image2.html#get_pixel">get_pixel</a> and + <a href="image3.html#view">view</a>) and using Ruby code to + perform the mathematics.</li> + + <li>The <code>u</code> and <code>v</code> symbols refer to + the 0th and 1st image in the list. The image reference index + (<code>u[2]</code> for example) works as expected. The + current <a href="#scene">scene number</a> has no meaning in + the context of the <code>fx</code> method.</li> + + <li>To specify a non-default pixel interpolation method, set + the <a href= + "imageattrs.html#pixel_interpolation_method">pixel_interpolation_method</a> + attribute of the last image in the list.</li> + </ul> + + <h4>Returns</h4> + + <p>The image created by the expression.</p> + + <h4>Example</h4> + <pre> +# Produce a navy blue image from a black image +imgl = Magick::ImageList.new +imgl &lt;&lt; Magick::Image.new(64, 64) {self.background_color = 'black'} + +res = imgl.fx('1/2', Magick::BlueChannel) +</pre> + + <h4>ImageMagick API</h4> + + <p>FxImageChannel</p> + + <h4>See also</h4> + + <p><a href="image2.html#get_pixel">get_pixel</a>, <a href= + "image3.html#view">view</a></p> </div> <div class="sig"> <h3 id="inspect">inspect</h3>