doc/info.html in rmagick-1.15.17 vs doc/info.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::Info - Optional method
+ <title>RMagick 2.0.0: class Image::Info - Optional method
arguments</title>
<meta http-equiv="Content-Type" content=
"text/html; charset=us-ascii" />
<meta name="GENERATOR" content="Quanta Plus" />
<meta name="Copyright" content=
@@ -42,11 +42,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="struct.html">Prev</a> | <a href=
"index.html">Contents</a> | <a href=
"constants.html">Next</a> »
@@ -75,10 +75,12 @@
<div class="toccol">
<ul>
<li><a href="#antialias">antialias</a></li>
+ <li><a href="#attenuate">attenuate</a></li>
+
<li><a href="#authenticate">authenticate</a></li>
<li><a href="#background_color">background_color</a></li>
<li><a href="#border_color">border_color</a></li>
@@ -96,17 +98,17 @@
<li><a href="#depth">depth</a></li>
<li><a href="#dispose">dispose</a></li>
<li><a href="#dither">dither</a></li>
+
+ <li><a href="#extract">extract</a></li>
</ul>
</div>
<div class="toccol">
<ul>
- <li><a href="#extract">extract</a></li>
-
<li><a href="#filename">filename</a></li>
<li><a href="#fill">fill</a></li>
<li><a href="#font">font</a></li>
@@ -124,21 +126,21 @@
<li><a href="#label">label</a></li>
<li><a href="#matte_color">matte_color</a></li>
<li><a href="#monitor">monitor</a></li>
- </ul>
- </div>
- <div class="toccol">
- <ul>
<li><a href="#monochrome">monochrome</a></li>
<li><a href="#orientation">orientation</a></li>
<li><a href="#origin">origin</a></li>
+ </ul>
+ </div>
+ <div class="toccol">
+ <ul>
<li><a href="#page">page</a></li>
<li><a href="#pointsize">pointsize</a></li>
<li><a href="#quality">quality</a></li>
@@ -147,12 +149,20 @@
<li><a href="#server_name">server_name</a></li>
<li><a href="#size">size</a></li>
+ <li><a href="#stroke">stroke</a></li>
+
+ <li><a href="#stroke_width">stroke_width</a></li>
+
+ <li><a href="#tile_offset">tile_offset</a></li>
+
<li><a href="#texture">texture</a></li>
+ <li><a href="#undercolor">undercolor</a></li>
+
<li><a href="#units">units</a></li>
<li><a href="#view">view</a></li>
</ul>
</div>
@@ -175,11 +185,11 @@
the <code>Image::Info</code> class to get optional arguments
will only accept some of the attributes listed on this page,
that is, only those attributes that are meaningful for the
particular method. Any other attributes that you set are
ignored. Also, some attributes are only used by a subset of the
- image formats. See the ×Magick documentation for more
+ image formats. See the ImageMagick documentation for more
information.</p>
<p>Remember, you do not ever need to create an
<code>Image::Info</code> object. The object is created for you
before the optional arguments block is entered and destroyed
@@ -197,31 +207,34 @@
<h3 id="aset">[]=</h3>
<p><span class="arg">self</span>[<span class=
"arg">format</span>, <span class="arg">key</span>] =
<span class="arg">value</span> -> <span class=
+ "arg">self</span><br />
+ <span class="arg">self</span>[<span class="arg">key</span>] =
+ <span class="arg">value</span> -> <span class=
"arg">self</span></p>
</div>
<div class="desc">
<h4>Description</h4>
- <p>Define a format-specific option. An alternative to <a href=
+ <p>Define an option. An alternative to <a href=
"#define">define</a>, below. Use this method to set options for
- reading or writing certain image formats. ImageMagick and
- GraphicsMagick support different options, and the list of
- supported options changes from release to release. For a list
- of the valid image formats, keys, and values, refer to the
- documentation for the -define option for the specific release
- of the library you're using.</p>
+ reading or writing certain image formats. The list of supported
+ options changes from release to release. For a list of the
+ valid image formats, keys, and values, refer to the
+ documentation for the -define option for the release of
+ ImageMagick installed on your system.</p>
<h4>Arguments</h4>
<dl>
<dt>format</dt>
- <dd>An image format name such as "ps" or "tiff".</dd>
+ <dd>An image format name such as "ps" or "tiff". (Depending
+ on the key, this argument may be omitted.)</dd>
<dt>key</dt>
<dd>A string that identifies the option.</dd>
@@ -241,20 +254,21 @@
self["tiff", "bits-per-sample"] = 2
</pre>
<h4>Magick API</h4>
- <p>SetImageOption (ImageMagick 6.0.0), AddDefinitions
- (GraphicsMagick 1.1)</p>
+ <p>SetImageOption</p>
</div>
<div class="sig">
<h3 id="aref">[]</h3>
<p><span class="arg">self</span>[<span class=
"arg">format</span>, <span class="arg">key</span>] ->
- <span class="arg">value</span></p>
+ <em>value</em><br />
+ <span class="arg">self</span>[<span class="arg">key</span>]
+ -> <em>value</em></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -264,11 +278,12 @@
<h4>Arguments</h4>
<dl>
<dt>format</dt>
- <dd>An image format name such as "ps" or "tiff".</dd>
+ <dd>An image format name such as "ps" or "tiff". (Depending
+ on the key, this argument may be omitted.)</dd>
<dt>key</dt>
<dd>A string that identifies the option.</dd>
</dl>
@@ -282,12 +297,11 @@
self["tiff", "bits-per-sample"] » 2
</pre>
<h4>Magick API</h4>
- <p>GetImageOption (ImageMagick 6.0.0), AccessDefinitions
- (GraphicsMagick 1.1)</p>
+ <p>GetImageOption</p>
</div>
<div class="sig">
<h3 id="channel">channel</h3>
@@ -324,12 +338,12 @@
</div>
<div class="desc">
<h4>Description</h4>
- <p>Define a format-specific option. See <a href="#aset">[]=</a>,
- above.</p>
+ <p>Define a format-specific option. See <a href=
+ "#aset">[]=</a>, above.</p>
<h4>Arguments</h4>
<dl>
<dt>format</dt>
@@ -356,12 +370,11 @@
self.define("tiff", "bits-per-sample", 2)
</pre>
<h4>Magick API</h4>
- <p>SetImageOption (ImageMagick 6.0.0), AddDefinitions
- (GraphicsMagick 1.1)</p>
+ <p>SetImageOption</p>
</div>
<div class="sig">
<h3 id="undefine">undefine</h3>
@@ -418,10 +431,24 @@
Postscript and Postscript or TrueType fonts.</span> The default
is <code>true</code>.</p>
</div>
<div class="sig">
+ <h3 id="attenuate">attenuate</h3>
+
+ <p><span class="arg">self</span>.attenuate= <span class=
+ "arg">aNumeric</span></p>
+ </div>
+
+ <div class="desc">
+ <h4>Description</h4>
+
+ <p class="imquote">Lessen (or intensify) when adding noise to
+ an image.</p>
+ </div>
+
+ <div class="sig">
<h3 id="authenticate">authenticate</h3>
<p><span class="arg">self.</span>authenticate= <span class=
"arg">aString</span></p>
</div>
@@ -480,11 +507,11 @@
</div>
<div class="desc">
<h4>Description</h4>
- <p>Specify the image pixel interpretation.</p>
+ <p>Specifies the image pixel interpretation.</p>
<h4>Arguments</h4>A <a href=
"constants.html#ColorspaceType">ColorspaceType</a> constant.
</div>
@@ -518,11 +545,11 @@
</div>
<div class="desc">
<h4>Description</h4>
- <p>Specify the type of compression used when writing the image.
+ <p>Specifies the type of compression used when writing the image.
Only some image formats support compression. For those that do,
only some compression types are supported. If you specify an
compression type that is not supported, the default compression
type (usually NoCompression) is used instead.</p>
@@ -566,12 +593,11 @@
</tr>
<tr>
<td>GIF</td>
- <td><strong>LZWCompression</strong> <em>(see Notes,
- below)</em></td>
+ <td><strong>LZWCompression</strong></td>
</tr>
<tr>
<td>JNG</td>
@@ -670,21 +696,14 @@
<ol id="compression_notes">
<li>NoCompression is accepted for all image formats. Except
as noted in the table, it is the default.</li>
- <li>Prior to July 10, 2004, the default for GIF images was
- NoCompression.</li>
-
- <li>×Magick must be configured and built with extra
- support to use LZWCompression (in releases prior to July 10,
- 2004) and LosslessJPEGCompression.</li>
-
- <li>This table is based on my examination of the
- ×Magick source code. It is not necessarily complete and
- it may contain mistakes. If you need an authoritative list,
- you should consult the ×Magick developers.</li>
+ <li>This table is based on my examination of the ImageMagick
+ source code. It is not necessarily complete and it may
+ contain mistakes. If you need an authoritative list, you
+ should consult the ImageMagick developers.</li>
</ol>
<h4>Arguments</h4>A <a href=
"constants.html#CompressionType">CompressionType</a> constant.
</div>
@@ -697,16 +716,16 @@
</div>
<div class="desc">
<h4>Description</h4>
- <p>Specify the vertical and horizontal resolution in pixels.
+ <p>Specifies the vertical and horizontal resolution in pixels.
The default density is "72.0x72.0". This attribute can be used
when writing JBIG, PCL, PS, PS2, and PS3 format images.</p>
<p>This attribute can also be used to specify the width and
- height of HISTOGRAM format images. For HISTOGRAM, the default
+ height of HISTOGRRAM format images. For HISTOGRAM, the default
is 256x200.</p>
<h4>Arguments</h4>
<p>The argument can be either a string in the form "XxY" where
@@ -741,17 +760,17 @@
</div>
<div class="desc">
<h4>Description</h4>
- <p>Specify the image depth.</p>
+ <p>Specifies the image depth.</p>
<h4>Arguments</h4>
<p>Either 8, 16, or 32. You can specify 16 and 32 only when
- ×Magick was compiled with a QuantumDepth that allows
- these depth values.</p>
+ ImageMagick was compiled with a QuantumDepth that allows these
+ depth values.</p>
<p>Use <code>depth</code> to specify the depth of CMYK, GRAY,
RGB, RGBA, MAP, and XC format images. See also <a href=
"#size"><code>size</code></a>.</p>
</div>
@@ -804,11 +823,11 @@
</div>
<div class="desc">
<h4>Description</h4>
- <p>Specify a portion of an image to be extracted when the image
+ <p>Specifies a portion of an image to be extracted when the image
is constituted. This attribute can be used to identify a subset
of an image that is otherwise too large to keep in memory.</p>
<h4>Arguments</h4>
@@ -838,13 +857,12 @@
</div>
<div class="desc">
<h4>Description</h4>
- <p>In the <code>Image::Info</code> class, the <code>fill</code>
- attribute specifies the fill color to use when creating an
- image with the "caption:" format..</p>
+ <p>Specifies the fill color to use when creating an image with
+ the "caption:" format..</p>
<h4>Arguments</h4>
<p>A <a href="imusage.html#color_names">color name</a> or a
<a href="struct.html#Pixel">aPixel</a>.</p>
@@ -901,13 +919,13 @@
<h4>Arguments</h4>
<p>The argument may be a 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>
</div>
<div class="sig">
<h3 id="gravity">gravity</h3>
@@ -1033,20 +1051,20 @@
<p>Set a <code>Proc</code> object as a progress monitor. This
proc can be used to monitor the progress of methods that accept
optional arguments such as <code>read</code> and
<code>write</code>. To stop monitoring, set the monitor to
<code>nil</code>. See <a href=
- "imageattrs.html#monitor">Image#monitor</a> for more information
+ "imageattrs.html#monitor">Image#monitor</a> for more informat
about the proc. This attribute is set-only.</p>
<p>If you assign a monitor to an image with
<code>self.monitor=</code> when the image is created, the image
object inherits the monitor. Any methods applied to the new
image will be monitored as well.</p>
- <p>Available in ImageMagick 6.1.0 and later. This method
- supercedes the <code>Magick.set_monitor</code> method.</p>
+ <p>This method supercedes the <code>Magick.set_monitor</code>
+ method.</p>
</div>
<div class="sig">
<h3 id="monochrome">monochrome</h3>
@@ -1070,11 +1088,11 @@
</div>
<div class="desc">
<h4>Description</h4>
- <p>Specify the orientation of the image pixels.</p>
+ <p>Specifies the orientation of the image pixels.</p>
<h4>Argument</h4>
<p>An <a href=
"constants.html#OrientationType">OrientationType</a> value.</p>
@@ -1142,11 +1160,11 @@
<div class="desc">
<h4>Description</h4>
<p>The compression level for JPEG, MPEG, JPEG-2000, MIFF, MNG,
- and PNG image format. Corresponds to ×Magick's -quality
+ and PNG image format. Corresponds to ImageMagick's -quality
option. The default is 75. See <em><a href=
"comtasks.html#compressing">Compressing image
files</a></em>.</p>
</div>
@@ -1207,48 +1225,126 @@
JBIG, or JPEG.</p>
<p>Use <code>size</code> to specify the width and height of
images in the CMYK, DIB, EMF, GRAY, RGB, RGBA, UYVY, YUV, or XC
formats, the width and height of some <a href=
- "imusage.html#builtin_formats">built in formats</a>, or the
+ "imusage.html#builtin_formats">builtin formats</a>, or the
subimage size of PTIF-format images.</p>
<h4>Arguments</h4>
- <p>A g<a href="imusage.html#geometry">eometry string</a>
- or a <a href="struct.html#Geometry">Geometry</a> object.</p>
+ <p>A <a href="imusage.html#geometry">geometry string</a> or a
+ <a href="struct.html#Geometry">Geometry</a> object.</p>
</div>
<div class="sig">
+ <h3 id="stroke">stroke</h3>
+
+ <p><span class="arg">self.</span>stroke= <span class=
+ "arg">aString</span> or <span class="arg">aPixel</span></p>
+ </div>
+
+ <div class="desc">
+ <h4>Description</h4>
+
+ <p>Specifies the stroke color to use when creating an image
+ with the "caption:" format..</p>
+
+ <h4>Arguments</h4>
+
+ <p>A <a href="imusage.html#color_names">color name</a> or a
+ <a href="struct.html#Pixel">aPixel</a>.</p>
+ </div>
+
+ <div class="sig">
+ <h3 id="stroke_width">stroke_width</h3>
+
+ <p><span class="arg">self.</span>stroke_width=
+ <em>aNumeric</em></p>
+ </div>
+
+ <div class="desc">
+ <h4>Description</h4>
+
+ <p>Specifies the stroke width to use when creating an image
+ with the "caption:" format..</p>
+
+ <h4>Arguments</h4>
+
+ <p>The stroke width.</p>
+ </div>
+
+ <div class="sig">
<h3 id="texture">texture</h3>
<p><span class="arg">self</span>.texture= <span class=
"arg">image</span></p>
</div>
<div class="desc">
<h4>Description</h4>
<p>Set a texture to tile onto the image background. Corresponds
- to the -texture option to ×Magick's convert and mogrify
+ to the -texture option to ImageMagick's convert and mogrify
commands. This attribute is set-only.</p>
<h4>Argument</h4>
<p>An image</p>
</div>
<div class="sig">
+ <h3 id="tile_offset">tile_offset</h3>
+
+ <p><span class="arg">self</span>.tile_offset= <span class=
+ "arg">aString</span> or <span class="arg">aGeometry</span></p>
+ </div>
+
+ <div class="desc">
+ <h4>Description</h4>
+
+ <p class="imquote">Specifies the offset for tile images, relative
+ to the background image it will be tiled on.</p>
+
+ <p>This attribute is useful with the "tile:" and "pattern:"
+ image formats.</p>
+
+ <h4>Arguments</h4>
+
+ <p>A <a href="imusage.html#geometry">geometry string</a> or a
+ <a href="struct.html#Geometry">Geometry</a> object.</p>
+ </div>
+
+ <div class="sig">
+ <h3 id="undercolor">undercolor</h3>
+
+ <p><span class="arg">self.</span>undercolor= <span class=
+ "arg">aString</span> or <span class="arg">aPixel</span></p>
+ </div>
+
+ <div class="desc">
+ <h4>Description</h4>
+
+ <p>Specifies the undercolor color to use when creating an image
+ with the "caption:" format..</p>
+
+ <h4>Arguments</h4>
+
+ <p>A <a href="imusage.html#color_names">color name</a> or a
+ <a href="struct.html#Pixel">aPixel</a>.</p>
+ </div>
+
+ <div class="sig">
<h3 id="units">units</h3>
<p><span class="arg">self.</span>units= <span class=
"arg">aResolutionType</span></p>
</div>
<div class="desc">
<h4>Description</h4>
- <p>Specify the units of image resolution.</p>
+ <p>Specifies the units of image resolution.</p>
<h4>Arguments</h4>
<p>A <a href="constants.html#ResolutionType">ResolutionType</a>
constant.</p>