doc/imageattrs.html in rmagick-1.15.17 vs doc/imageattrs.html in rmagick-2.0.0
- old
+ new
@@ -2,13 +2,13 @@
"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 December 2004), see www.w3.org" />
+ "HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
- <title>RMagick 1.15.17: class Image (attribute methods)</title>
+ <title>RMagick 2.0.0: class Image (attribute methods)</title>
<meta http-equiv="Content-Type" content=
"text/html; charset=us-ascii" />
<meta name="GENERATOR" content="Quanta Plus" />
<meta name="Copyright" content=
"Copyright (C) 2006 by Timothy P. Hunter" />
@@ -23,11 +23,11 @@
/*]]>*/
</style>
</head>
<body>
- <h6 id="header">RMagick 1.15.17 User's Guide and Reference</h6>
+ <h6 id="header">RMagick 2.0.0 User's Guide and Reference</h6>
<div class="nav">
« <a href="ilist.html">Prev</a> | <a href=
"index.html">Contents</a> | <a href=
"image1.html">Next</a> »
@@ -43,10 +43,12 @@
<h3>attribute methods</h3>
<div>
<div class="toccol">
<ul>
+ <li><a href="#alpha">alpha</a></li>
+
<li><a href="#background_color">background_color</a></li>
<li><a href="#base_columns">base_columns</a></li>
<li><a href="#base_filename">base_filename</a></li>
@@ -184,10 +186,54 @@
</div>
<h2 class="methods">attribute methods</h2>
<div class="sig">
+ <h3 id="alpha">alpha</h3>
+
+ <p><span class="arg">image</span>.alpha = <span class=
+ "arg">anAlphaChannelType</span></p>
+ </div>
+
+ <div class="desc">
+ <h4>Description</h4>
+
+ <p>Set a flag to indicate whether or not to use alpha channel
+ data. Set-only.</p>
+
+ <h4>Arguments</h4>
+
+ <p>One of the following values of the AlphaChannelType
+ enumeration:</p>
+
+ <dl>
+ <dt>ActivateAlphaChannel</dt>
+
+ <dd>Use alpha channel data. Equivalent to <code>img.matte =
+ true</code>.</dd>
+
+ <dt>DeactivateAlphaChannel</dt>
+
+ <dd>Do not use alpha channel data. Equivalent to
+ <code>img.matte = false</code>.</dd>
+
+ <dt>ResetAlphaChannel</dt>
+
+ <dd>Set the alpha channel to fully opaque.</dd>
+
+ <dt>SetAlphaChannel</dt>
+
+ <dd>Sets the alpha channel to the intensity of the
+ image.</dd>
+ </dl>
+
+ <h4>See also</h4>
+
+ <p><a href="#matte">matte</a></p>
+ </div>
+
+ <div class="sig">
<h3 id="background_color">background_color</h3>
<p><span class="arg">image.</span>background_color ->
<em>aString</em><br />
<span class="arg">image</span>.background_color = <span class=
@@ -466,13 +512,13 @@
<div class="sig">
<h3 id="colorspace">colorspace</h3>
<p><span class="arg">image.</span>colorspace ->
- <em>aColorspace</em><br />
+ <em>aColorspaceType</em><br />
<span class="arg">image.</span>colorspace = <span class=
- "arg">aColorspace</span></p>
+ "arg">aColorspaceType</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -483,16 +529,16 @@
CMYKColorspace, the pixels are cyan, yellow, magenta, black.
Otherwise the colorspace is ignored.</p>
<h4>Arguments</h4>
- <p>A <a href="constants.html#ColorspaceType">Colorspace</a>
+ <p>A <a href="constants.html#ColorspaceType">ColorspaceType</a>
constant.</p>
<h4>Returns</h4>
- <p>A <a href="constants.html#ColorspaceType">Colorspace</a>
+ <p>A <a href="constants.html#ColorspaceType">ColorspaceType</a>
constant.</p>
</div>
<div class="sig">
<h3 id="columns">columns</h3>
@@ -776,15 +822,15 @@
default filter is Lanczos which has been shown to produce high
quality results when reducing most images.</p>
<h4>Arguments</h4>
- <p>A <a href="constants.html#FilterTypes">FilterType</a>
+ <p>A <a href="constants.html#FilterTypes">FilterTypes</a>
constant.</p>
<h4>Returns</h4>A <a href=
- "constants.html#FilterTypes">FilterType</a> constant.
+ "constants.html#FilterTypes">FilterTypes</a> constant.
</div>
<div class="sig">
<h3 id="format">format</h3>
@@ -834,13 +880,13 @@
<h4>Arguments</h4>
<p>The argument may be a floating-point numeric value or a
string in the form "NN%". In the second case, the argument is
computed as a percentage of <a href=
- "constants.html#Miscellaneous_constants">MaxRGB</a>. For
+ "constants.html#Miscellaneous_constants">QuantumRange</a>. For
example, a value of '5%' sets <code>fuzz</code> to
- 0.05*MaxRGB.</p>
+ 0.05*QuantumRange.</p>
<h4>Returns</h4>
<p>A <code>Float</code></p>
</div>
@@ -897,11 +943,11 @@
<div class="desc">
<h4>Description</h4>
<p>The image type classification. For example, GrayscaleType.
Don't confuse this attribute with the <a href=
- "#format">format</a>, that is "GIF" or "JPG".</p>
+ "#format">format</a>, that is "GIF" or "JPG". Get-only.</p>
<h4>Returns</h4>
<p>An <a href="constants.html#ImageType">ImageType</a>
value.</p>
@@ -1041,10 +1087,13 @@
<div class="desc">
<h4>Description</h4>
<p>If <code>true</code>, honor the opacity values in the image
pixels. See <a href="struct.html#Pixel">Pixel</a>.</p>
+
+ <p>This attribute is deprecated in ImageMagick 6.3.5 and later.
+ Use <a href="#alpha">alpha</a> instead.</p>
</div>
<div class="sig">
<h3 id="mean_error_per_pixel">mean_error_per_pixel</h3>
@@ -1112,13 +1161,11 @@
</dl>
<p>If the monitor proc returns <code>nil</code> or
<code>false</code> the operation will be immediately
terminated. To stop monitoring, set <code>monitor</code> to
- <code>nil</code>. Available in ImageMagick 6.1.0 and later,
- this attribute supercedes <a href=
- "magick.html#set_monitor">Magick.set_monitor</a>. Set-only.</p>
+ <code>nil</code>. Set-only.</p>
<h4>Argument</h4>
<p>Any object that can respond to</p>
<pre>
@@ -1170,27 +1217,22 @@
<div class="sig">
<h3 id="montage">montage</h3>
<p><span class="arg">image.</span>montage ->
- <em>aString</em><br />
- <span class="arg">image.</span>montage = <code>nil</code></p>
+ <em>aString</em><br /></p>
</div>
<div class="desc">
<h4>Description</h4>
<p><span class="imquote">Tile size and offset within an image
montage. Only valid for</span> [images produced by <a href=
"ilist.html#montage">montage</a>.] <span class="imquote">The
string is in the form of a <a href=
- "imusage.html#geometry">geometry</a> string.</span></p>
-
- <h4>Arguments</h4>
-
- <p>To release the montage string, set this attribute to
- <code>nil</code>.</p>
+ "imusage.html#geometry">geometry</a> string.</span>
+ Get-only.</p>
</div>
<div class="sig">
<h3 id="normalized_mean_error">normalized_mean_error</h3>
@@ -1273,12 +1315,12 @@
image. If the image pixels are opaque, they are set to the
specified opacity level. Otherwise, the pixel opacity values
are blended with the supplied transparency value.</span>
Set-only.</p>
- <h4>Arguments</h4>A number between 0 and MaxRGB. Higher numbers
- increase transparency.
+ <h4>Arguments</h4>A number between 0 and QuantumRange. Higher
+ numbers increase transparency.
</div>
<div class="sig">
<h3 id="orientation">orientation</h3>
@@ -1296,12 +1338,10 @@
<h4>Returns</h4>
<p>An <a href=
"constants.html#OrientationType">OrientationType</a> value.</p>
- <h4>Magick API</h4>Available in ImageMagick 6.0.0.
-
<h4>Notes</h4>See <a href=
"http://jpegclub.org/exif_orientation.html">http://jpegclub.org/exif_orientation.html</a>
for more information about the Exif Orientation Tag.
</div>
@@ -1401,11 +1441,11 @@
<div class="desc">
<h4>Description</h4>
<p>The image depth to the nearest Quantum (8, 16, or 32).
- Get-only. Available in ImageMagick 6.0.0.</p>
+ Get-only.</p>
</div>
<div class="sig">
<h3 id="rendering_intent">rendering_intent</h3>
@@ -1480,11 +1520,11 @@
<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">image.</span>ticks_per_second = <span class=
+ <span class="arg">iamge.</span>ticks_per_second = <span class=
"arg">aNumeric</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -1495,17 +1535,10 @@
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="total_colors">total_colors</h3>
@@ -1598,14 +1631,42 @@
<dt>TransparentVirtualPixelMethod</dt>
<dd>The area surrounding the image is transparent
blackness.</dd>
+
+ <dt>BlackVirtualPixelMethod</dt>
+
+ <dd class="imquote">The area surrounding the image is
+ black.</dd>
+
+ <dt>GrayVirtualPixelMethod</dt>
+
+ <dd class="imquote">The area surrounding the image is
+ gray.</dd>
+
+ <dt>WhiteVirtualPixelMethod</dt>
+
+ <dd class="imquote">The area surrounding the image is
+ white.</dd>
+
+ <dt>RandomVirtualPixelMethod</dt>
+
+ <dd class="imquote">Choose a random pixel from the
+ image.</dd>
+
+ <dt>DitherVirtualPixelMethod</dt>
+
+ <dd class="imquote">use a dithered pattern to choose a pixel
+ in a 32x32 neighborhood.</dd>
</dl>
- <p><code>BackgroundVirtualPixelMethod</code> and
- <code>TransparentVirtualPixelMethod</code> are available only
- in ImageMagick 6.2.4 and later.</p>
+ <p>Some of these values are not supported by older versions of
+ ImageMagick. To see what values are available, enter the
+ following code in irb:</p>
+ <pre>
+Magick::VirtualPixelMethod.values {|v| puts v}
+</pre>
<h4>Returns</h4>
<p>A <code>VirtualPixelMethod</code> constant.</p>