doc/imageattrs.html in rmagick-1.9.1 vs doc/imageattrs.html in rmagick-1.9.2
- old
+ new
@@ -2,11 +2,11 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta name="generator" content=
- "HTML Tidy for Linux/x86 (vers 1st March 2005), see www.w3.org" />
+ "HTML Tidy for Mac OS X (vers 1st September 2004), see www.w3.org" />
<title>RMagick: class Image (attribute methods)</title>
<meta http-equiv="Content-Type" content=
"text/html; charset=us-ascii" />
<meta name="GENERATOR" content="Quanta Plus" />
@@ -78,17 +78,17 @@
<li><a href="#compression">compression</a></li>
<li><a href="#delay">delay</a></li>
<li><a href="#density">density</a></li>
+
+ <li><a href="#depth">depth</a></li>
</ul>
</div>
<div class="toccol">
<ul>
- <li><a href="#depth">depth</a></li>
-
<li><a href="#directory">directory</a></li>
<li><a href="#dispose">dispose</a></li>
<li><a href="#endian">endian</a></li>
@@ -121,17 +121,17 @@
"#mean_error_per_pixel">mean_error_per_pixel</a></li>
<li><a href="#mime_type">mime_type</a></li>
<li><a href="#monitor">monitor</a></li>
+
+ <li><a href="#montage">montage</a></li>
</ul>
</div>
<div class="toccol">
<ul>
- <li><a href="#montage">montage</a></li>
-
<li><a href=
"#normalized_mean_error">normalized_mean_error</a></li>
<li><a href=
"#normalized_maximum_error">normalized_maximum_error</a></li>
@@ -156,16 +156,21 @@
<li><a href="#scene">scene</a></li>
<li><a href="#start_loop">start_loop</a></li>
+ <li><a href="#ticks_per_second">ticks_per_second</a></li>
+
<li><a href="#tile_info">tile_info</a></li>
<li><a href="#total_colors">total_colors</a></li>
<li><a href="#units">units</a></li>
+ <li><a href=
+ "#virtual_pixel_method">virtual_pixel_method</a></li>
+
<li><a href="#x_resolution">x_resolution</a></li>
<li><a href="#y_resolution">y_resolution</a></li>
</ul>
</div>
@@ -524,13 +529,15 @@
</div>
<div class="desc">
<h4>Description</h4>
- <p><span class="imquote">Time in 1/100ths of a second which
- must expire before displaying the next image in an animated
- sequence.</span> The default is 0.</p>
+ <p>Number of ticks which must expire before displaying the next
+ image in an animated sequence. The default number of ticks is
+ 0. By default there are 100 ticks per second but this number
+ can be changed via the <a href=
+ "#ticks_per_second">ticks_per_second</a> attribute.</p>
<h4>Arguments</h4>An integer value between 0 and 65535,
inclusive.
<h4>Returns</h4>
@@ -955,11 +962,12 @@
<div class="desc">
<h4>Description</h4>
<p><span class="imquote">The mean error per pixel computed when
a image is color reduced.</span> This attribute is only valid
- if the <code>measure_error</code> argument to <code>quantize</code><a href=
+ if the <code>measure_error</code> argument to
+ <code>quantize</code><a href=
"ilist.html#quantize">[ImageList]</a><a href=
"image3.html#quantize">[Image]</a> is set to <code>true</code>.
Get-only.</p>
</div>
@@ -1100,11 +1108,12 @@
<div class="desc">
<h4>Description</h4>
<p><span class="imquote">The normalized mean error computed
when an image is color reduced.</span> This attribute is only
- valid if the <code>measure_error</code> argument to <code>quantize</code><a href=
+ valid if the <code>measure_error</code> argument to
+ <code>quantize</code><a href=
"ilist.html#quantize">[ImageList]</a><a href=
"image3.html#quantize">[Image]</a> is set to <code>true</code>.
Get-only.</p>
</div>
@@ -1354,10 +1363,39 @@
<p>Indicates the first image in an animation.</p>
</div>
<div class="sig">
+ <h3 id="ticks_per_second">ticks_per_second</h3>
+
+ <p><span class="arg">image.</span>ticks_per_second ->
+ <em>aNumeric</em><br />
+ <span class="arg">iamge.</span>ticks_per_second = <span class=
+ "arg">aNumeric</span></p>
+ </div>
+
+ <div class="desc">
+ <h4>Description</h4>
+
+ <p>Gets/sets the number of ticks per second. This attribute is
+ used in conjunction with the <a href="#delay">delay</a>
+ attribute to establish the amount of time that must elapse
+ between frames in an animation.The default is 100.</p>
+
+ <h4>Returns</h4>
+
+ <p>The current number of ticks per second</p>
+
+ <h4>Notes</h4>
+
+ <p>Available in ImageMagick 6.2.4 and later. Prior to this
+ release the number of ticks per second was fixed at 100. The
+ GIF image format only accepts 100 ticks per second regardless
+ of the value of this attribute.</p>
+ </div>
+
+ <div class="sig">
<h3 id="tile_info">tile_info</h3>
<p><span class="arg">image.</span>tile_info ->
<em>aRectangle</em><br />
<span class="arg">image.</span>tile_info = <span class=
@@ -1395,12 +1433,13 @@
<h4>Description</h4>
<p>The number of colors in the image after quantization. Set by
<code>quantize</code> <a href=
"ilist.html#quantize">[ImageList]</a><a href=
- "image3.html#quantize">[Image]</a> if the <code>measure_error</code>
- argument is <code>true</code>. Get-only.</p>
+ "image3.html#quantize">[Image]</a> if the
+ <code>measure_error</code> argument is <code>true</code>.
+ Get-only.</p>
</div>
<div class="sig">
<h3 id="units">units</h3>
@@ -1427,9 +1466,71 @@
<h4>See also</h4>
<p><a href="#x_resolution">x_resolution</a>, <a href=
"y_resolution">y_resolution</a></p>
+ </div>
+
+ <div class="sig">
+ <h3 id="virtual_pixel_method">virtual_pixel_method</h3>
+
+ <p><span class="arg">image</span>.virtual_pixel_method ->
+ <em>aVirtualPixelMethod</em><br />
+ <span class="arg">image</span>.virtual_pixel_method =
+ <span class="arg">aVirtualPixelMethod</span></p>
+ </div>
+
+ <div class="desc">
+ <h4>Description</h4>
+
+ <p>Specify how "virtual pixels" behave. Virtual pixels are
+ pixels that are outside the boundaries of the image. Methods
+ such as <a href="image1.html#blur_image">blur_image</a>,
+ <a href="image3.html#sharpen">sharpen</a>, and <a href=
+ "image3.html#wave">wave</a> use virtual pixels.</p>
+
+ <h4>Arguments</h4>
+
+ <p>The virtual pixel method can be any one of the following
+ <code>VirtualPixelMethod</code> constants:</p>
+
+ <dl>
+ <dt>EdgeVirtualPixelMethod</dt>
+
+ <dd>Extend the edge pixel toward infinity. This is the
+ default.</dd>
+
+ <dt>MirrorVirtualPixelMethod</dt>
+
+ <dd>Mirror the image.</dd>
+
+ <dt>TileVirtualPixelMethod</dt>
+
+ <dd>Tile the image.</dd>
+
+ <dt>BackgroundVirtualPixelMethod</dt>
+
+ <dd>The area surrounding the image is the background
+ color.</dd>
+
+ <dt>TransparentVirtualPixelMethod</dt>
+
+ <dd>The area surrounding the image is transparent
+ blackness.</dd>
+ </dl>
+
+ <p><code>BackgroundVirtualPixelMethod</code> and
+ <code>TransparentVirtualPixelMethod</code> are available only
+ in ImageMagick 6.2.4 and later.</p>
+
+ <h4>Returns</h4>
+
+ <p>A <code>VirtualPixelMethod</code> constant.</p>
+
+ <h4>Example</h4>
+ <pre>
+ img.virtual_pixel_method = Magick::TransparentVirtualPixelMethod
+</pre>
</div>
<div class="sig">
<h3 id="x_resolution">x_resolution</h3>