doc/imageattrs.html in rmagick-2.3.0 vs doc/imageattrs.html in rmagick-2.4.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 1 September 2005), see www.w3.org" />
- <title>RMagick 2.3.0: class Image (attribute methods)</title>
+ <title>RMagick 2.4.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 2.3.0 User's Guide and Reference</h6>
+ <h6 id="header">RMagick 2.4.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> »
@@ -196,11 +196,11 @@
<h4>Description</h4>
<p>The image's background color. By default the background
color is "white".</p>
- <h4>Arguments</h4>Either a <a href=
+ <h4>Argument</h4>Either a <a href=
"imusage.html#color_names">color name</a> or a <a href=
"struct.html#Pixel">Pixel</a> object.
<h4>Returns</h4>
@@ -316,11 +316,11 @@
<div class="desc">
<h4>Description</h4>The image's border color. The default
border color is "#dfdfdf" (gray).
- <h4>Arguments</h4>
+ <h4>Argument</h4>
<p>Either a <a href="imusage.html#color_names">color name</a>
or a <a href="struct.html#Pixel">Pixel</a> object.</p>
<h4>Returns</h4>
@@ -341,11 +341,11 @@
<h4>Description</h4>
<p>The <span class="imquote">red, green, blue, and white-point
chromaticity values.</span>.</p>
- <h4>Arguments</h4>A <a href=
+ <h4>Argument</h4>A <a href=
"struct.html#Chromaticity">Chromaticity</a> object.
<h4>Returns</h4>A <a href=
"struct.html#Chromaticity">Chromaticity</a> object.
</div>
@@ -365,11 +365,11 @@
<p>The image's <em>storage class</em>. <span class="imquote">If
DirectClass then the pixels contain valid RGB or CMYK colors.
If PseudoClass then the image has a colormap referenced by the
pixel's index member.</span></p>
- <h4>Arguments</h4>
+ <h4>Argument</h4>
<p>A <a href="constants.html#ClassType">ClassType</a>
constant.</p>
<h4>Returns</h4>
@@ -391,11 +391,11 @@
<h4>Description</h4>
<p>The <a href="http://www.color.org/icc_specs2.html">ICC color
profile</a>.</p>
- <h4>Arguments</h4>
+ <h4>Argument</h4>
<p>A color profile is represented as a string. If the argument
is <code>nil</code> instead of <span class="arg">string</span>
then any ICC color profile present in the image is deleted.</p>
@@ -450,11 +450,11 @@
the pixels are red, green, blue. If <a href="#matte">matte</a>
is true, then red, green, blue, and opacity. If it is
CMYKColorspace, the pixels are cyan, yellow, magenta, black.
Otherwise the colorspace is ignored.</p>
- <h4>Arguments</h4>
+ <h4>Argument</h4>
<p>A <a href="constants.html#ColorspaceType">ColorspaceType</a>
constant.</p>
<h4>Returns</h4>
@@ -490,11 +490,11 @@
<p>The image composite operator. The default is
OverCompositeOp. See <a href=
"ilist.html#montage">montage</a>.</p>
- <h4>Arguments</h4>
+ <h4>Argument</h4>
<p>A <a href="constants.html#CompositeOperator">composite
operator</a> constant.</p>
<h4>Returns</h4>
@@ -514,11 +514,11 @@
<div class="desc">
<h4>Description</h4>The image compression type. The default is
the compression type of the specified image file.
- <h4>Arguments</h4>
+ <h4>Argument</h4>
<p>A <a href=
"constants.html#CompressionType">CompressionType</a>
constant.</p>
@@ -545,11 +545,11 @@
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,
+ <h4>Argument</h4>An integer value between 0 and 65535,
inclusive.
<h4>Returns</h4>
<p>The current delay value.</p>
@@ -568,11 +568,11 @@
<h4>Description</h4>
<p>The <span class="imquote">vertical and horizontal resolution
in pixels of the image.</span> The default is "72x72".</p>
- <h4>Arguments</h4>
+ <h4>Argument</h4>
<p>The density may be expressed either as a string or a
<a href="struct.html#Geometry">Geometry</a> object. If a
string, it is in the form "XxY", or simply "X". If "Y" is
omitted it is set to "X". To specify the density with a
@@ -640,11 +640,11 @@
<p class="imquote">GIF disposal method. This attribute is used
to control how successive images are rendered (how the
preceding image is disposed of) when creating a GIF
animation.</p>
- <h4>Arguments</h4>
+ <h4>Argument</h4>
<p>An integer corresponding to the disposal method.</p>
<h4>Returns</h4>A <a href=
"constants.html#DisposeType">DisposeType</a> constant.
@@ -663,11 +663,11 @@
<h4>Description</h4>
<p>Get or set the endian attribute. <em>(As best I can tell,
only the TIFF format supports this attribute.)</em></p>
- <h4>Arguments</h4>
+ <h4>Argument</h4>
<p>An <a href="constants.html#EndianType">EndianType</a>
value.</p>
<h4>Returns</h4>
@@ -690,11 +690,11 @@
<p>Specify a rectangle within an image, or retrieve the
rectangle specified when the image was constituted. See
<a href="info.html#extract">extract=</a>.</p>
- <h4>Arguments</h4>
+ <h4>Argument</h4>
<p>A <a href="struct.html#Rectangle">Rectangle</a> object.</p>
<h4>Returns</h4>
@@ -743,11 +743,11 @@
reduction filter employed has a significant effect on the time
required to resize an image and the resulting quality. The
default filter is Lanczos which has been shown to produce high
quality results when reducing most images.</p>
- <h4>Arguments</h4>
+ <h4>Argument</h4>
<p>A <a href="constants.html#FilterTypes">FilterTypes</a>
constant.</p>
<h4>Returns</h4>A <a href=
@@ -767,11 +767,11 @@
<h4>Description</h4>
<p>The image encoding format. For example, "GIF" or "PNG". See
<a href="magick.html#formats">formats</a>.</p>
- <h4>Arguments</h4>
+ <h4>Argument</h4>
<p>The format name.</p>
<h4>Returns</h4>
@@ -797,11 +797,11 @@
<p>See <a href="image2.html#opaque">opaque</a>, <a href=
"image3.html#texture_floodfill">texture_floodfill</a>, and
<a href="image3.html#transparent">transparent</a>.</p>
- <h4>Arguments</h4>
+ <h4>Argument</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">QuantumRange</a>. For
@@ -843,11 +843,11 @@
<h4>Description</h4>
<p class="imquote">Preferred size of the image when
encoding.</p>
- <h4>Arguments</h4>
+ <h4>Argument</h4>
<p>A <a href="imusage.html#geometry">geometry string</a> or a
<a href="struct.html#Geometry">Geometry</a> object.</p>
<h4>Returns</h4>
@@ -856,13 +856,13 @@
</div>
<div class="sig">
<h3 id="gravity">gravity</h3>
- <p>image.<span class="arg">gravity</span> ->
+ <p><span class="arg">img</span>.gravity ->
<em>gravity</em><br />
- image.<span class="arg">gravity =</span> <span class=
+ <span class="arg">img</span>.gravity = <span class=
"arg">gravity</span></p>
</div>
<div class="desc">
<h4>Description</h4>
@@ -870,30 +870,42 @@
<p>Used with the <a href=
"ilist.html#composite_layers">ImageList#composite_layers</a>
method. <span class="imquote">The direction that the image
gravitates within the composite.</span></p>
- <h4>Arguments</h4>
+ <h4>Argument</h4>
<p>A <a href="constants.html#GravityType">GravityType</a>
value.</p>
+
+ <h4>Returns</h4>
+
+ <p>A <a href="constants.html#GravityType">GravityType</a>
+ value.</p>
</div>
<div class="sig">
<h3 id="image_type">image_type</h3>
<p><span class="arg">img.</span>image_type ->
- <em>type</em></p>
+ <em>type</em><br />
+ <span class="arg">img</span>.image_type = <span class=
+ "arg">type</span></p>
</div>
<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". Get-only.</p>
+ <h4>Argument</h4>
+
+ <p>An <a href="constants.html#ImageType">ImageType</a>
+ value.</p>
+
<h4>Returns</h4>
<p>An <a href="constants.html#ImageType">ImageType</a>
value.</p>
</div>
@@ -918,11 +930,11 @@
PartitionInterlace is like PlaneInterlace except the different
planes are saved to individual files (e.g. image.R, image.G,
and image.B). Use LineInterlace or PlaneInterlace to create an
interlaced GIF or progressive JPEG image.</p>
- <h4>Arguments</h4>
+ <h4>Argument</h4>
<p>An <a href="constants.html#InterlaceType">InterlaceType</a>
constant.</p>
<h4>Returns</h4>
@@ -944,11 +956,11 @@
<h4>Description</h4>
<p>The <a href="http://www.iptc.org/IIM/">International Press
Telecommunications Council profile</a>.</p>
- <h4>Arguments</h4>
+ <h4>Argument</h4>
<p>A IPTC profile is represented as a string. If the argument
is <code>nil</code> instead of <span class="arg">string</span>
then any IPTC profile present in the image is deleted.</p>
@@ -1204,11 +1216,11 @@
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 QuantumRange. Higher
+ <h4>Argument</h4>A number between 0 and QuantumRange. Higher
numbers increase transparency.
</div>
<div class="sig">
<h3 id="orientation">orientation</h3>
@@ -1249,11 +1261,11 @@
this image with respect to the underlying image. See <a href=
"ilist.html#coalesce">coalesce</a>, <a href=
"ilist.html#flatten_images">flatten_images</a>, and <a href=
"ilist.html#mosaic">mosaic</a>.</p>
- <h4>Arguments</h4>
+ <h4>Argument</h4>
<p>A <a href="struct.html#Rectangle">Rectangle</a> object.</p>
<h4>Returns</h4>
@@ -1348,11 +1360,11 @@
<p class="imquote">The type of rendering intent. See <a href=
"http://www.cambridgeincolour.com/tutorials/color-space-conversion.htm">
http://www.cambridgeincolour.com/tutorials/color-space-conversion.htm</a></p>
- <h4>Arguments</h4>
+ <h4>Argument</h4>
<p>A <a href=
"constants.html#RenderingIntent">RenderingIntent</a>
constant.</p>
@@ -1455,11 +1467,11 @@
<div class="desc">
<h4>Description</h4>
<p class="imquote">Units of image resolution.</p>
- <h4>Arguments</h4>
+ <h4>Argument</h4>
<p>A <a href="constants.html#ResolutionType">ResolutionType</a>
constant.</p>
<h4>Returns</h4>
@@ -1489,10 +1501,10 @@
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>
+ <h4>Argument</h4>
<p>The virtual pixel method can be any one of the following
<code>VirtualPixelMethod</code> constants:</p>
<dl>