php/archived-doc-en
1
0
Fork 0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

gmagick: fix XML by converting para to simpara tags via script (#5132)

Browse Source
This commit is contained in:
Gina Peter Banyard
2026-01-19 03:58:54 +00:00
committed by GitHub
parent fde9a41838
commit 35752f0720
188 changed files with 1676 additions and 1833 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
reference/gmagick/book.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- State: experimental -->
<book xml:id="book.gmagick" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.gmagick">
<?phpdoc extension-membership="pecl" ?>
<title>Gmagick</title>
<titleabbrev>Gmagick</titleabbrev>
@@ -10,17 +9,17 @@
<preface xml:id="intro.gmagick">
&reftitle.intro;
&warn.experimental;
<para>
Gmagick is a php extension to create, modify and obtain meta information of images using the GraphicsMagick API.
</para>
<para>
<simpara>
Gmagick is a php extension to create, modify and obtain meta information of images using the GraphicsMagick API.
</simpara>
<simpara>
GraphicsMagick prides itself as the swiss army knife of image processing. It works with over 88 major formats
including important formats like DPX, GIF, JPEG, JPEG-2000, PNG, PDF, PNM, and TIFF.
</para>
<para>
Gmagick consists of a main Gmagick class, a GmagickDraw class which is in effect a drawing wand and a
GmagickPixel class of which instances represent a single pixel of an image (color, opacity).
</para>
</simpara>
<simpara>
Gmagick consists of a main Gmagick class, a GmagickDraw class which is in effect a drawing wand and a
GmagickPixel class of which instances represent a single pixel of an image (color, opacity).
</simpara>
</preface>
&reference.gmagick.setup;
@@ -28,9 +27,8 @@
&reference.gmagick.examples;
&reference.gmagick.gmagick;
&reference.gmagick.gmagickdraw;
&reference.gmagick.gmagickpixel;
&reference.gmagick.gmagickpixel;
</book>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -51,4 +49,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

9
reference/gmagick/examples.xml
View File

@@ -1,11 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<chapter xml:id="gmagick.examples" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.examples">
&reftitle.examples;
<para>
<simpara>
The following shows some common Gmagick image operations.
</para>
</simpara>
<example>
<title>Gmagick Example</title>
<programlisting role="php">
@@ -28,7 +27,6 @@ $image->write('example_thumbnail.jpg');
</programlisting>
</example>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -49,4 +47,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

10
reference/gmagick/gmagick.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.gmagick" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.gmagick" role="class">
<title>The Gmagick class</title>
<titleabbrev>Gmagick</titleabbrev>
@@ -11,9 +10,9 @@
<!-- {{{ Gmagick intro -->
<section xml:id="gmagick.intro">
&reftitle.intro;
<para>
</para>
<simpara>
</simpara>
</section>
<!-- }}} -->
@@ -47,7 +46,6 @@
&reference.gmagick.entities.gmagick;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/gmagick/gmagick/addimage.xml
View File

@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>Gmagick</type><methodname>Gmagick::addimage</methodname>
<methodparam><type>Gmagick</type><parameter>source</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Adds new image to Gmagick object from the current position of the source object. After the operation iterator position is moved at the end of the list.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,9 +23,9 @@
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
<simpara>
The source Gmagick object
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -33,16 +33,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The Gmagick object with image added
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

16
reference/gmagick/gmagick/addnoiseimage.xml
View File

@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>Gmagick</type><methodname>Gmagick::addnoiseimage</methodname>
<methodparam><type>int</type><parameter>noise_type</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Adds random noise to the image.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,9 +23,9 @@
<varlistentry>
<term><parameter>noise_type</parameter></term>
<listitem>
<para>
<simpara>
The type of the noise. Refer to this list of <link linkend="gmagick.constants.noise">noise constants</link>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -33,16 +33,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The Gmagick object with noise added.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

32
reference/gmagick/gmagick/annotateimage.xml
View File

@@ -16,9 +16,9 @@
<methodparam><type>float</type><parameter>angle</parameter></methodparam>
<methodparam><type>string</type><parameter>text</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Annotates an image with text.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,41 +27,41 @@
<varlistentry>
<term><parameter>GmagickDraw</parameter></term>
<listitem>
<para>
<simpara>
The <classname>GmagickDraw</classname> object that contains settings for drawing the text.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>x</parameter></term>
<listitem>
<para>
<simpara>
Horizontal offset in pixels to the left of text.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y</parameter></term>
<listitem>
<para>
<simpara>
Vertical offset in pixels to the baseline of text.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>angle</parameter></term>
<listitem>
<para>
<simpara>
The angle at which to write the text.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>text</parameter></term>
<listitem>
<para>
<simpara>
The string to draw.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -69,16 +69,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The <classname>Gmagick</classname> object with annotation made.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

20
reference/gmagick/gmagick/blurimage.xml
View File

@@ -14,9 +14,9 @@
<methodparam><type>float</type><parameter>sigma</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>channel</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Adds blur filter to image.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,17 +25,17 @@
<varlistentry>
<term><parameter>radius</parameter></term>
<listitem>
<para>
<simpara>
Blur radius
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>sigma</parameter></term>
<listitem>
<para>
<simpara>
Standard deviation
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -43,16 +43,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The blurred <classname>Gmagick</classname> object
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

24
reference/gmagick/gmagick/borderimage.xml
View File

@@ -14,9 +14,9 @@
<methodparam><type>int</type><parameter>width</parameter></methodparam>
<methodparam><type>int</type><parameter>height</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Surrounds the image with a border of the color defined by the bordercolor <classname>GmagickPixel</classname> object or a color string.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,25 +25,25 @@
<varlistentry>
<term><parameter>color</parameter></term>
<listitem>
<para>
<simpara>
<classname>GmagickPixel</classname> object or a string containing the border color.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>width</parameter></term>
<listitem>
<para>
<simpara>
Border width.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>height</parameter></term>
<listitem>
<para>
<simpara>
Border height.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -51,16 +51,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The <classname>Gmagick</classname> object with border defined.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

20
reference/gmagick/gmagick/charcoalimage.xml
View File

@@ -13,9 +13,9 @@
<methodparam><type>float</type><parameter>radius</parameter></methodparam>
<methodparam><type>float</type><parameter>sigma</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Simulates a charcoal drawing.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,17 +24,17 @@
<varlistentry>
<term><parameter>radius</parameter></term>
<listitem>
<para>
<simpara>
The radius of the Gaussian, in pixels, not counting the center pixel.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>sigma</parameter></term>
<listitem>
<para>
<simpara>
The standard deviation of the Gaussian, in pixels.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -42,16 +42,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The <classname>Gmagick</classname> object with charcoal simulation.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>

28
reference/gmagick/gmagick/chopimage.xml
View File

@@ -15,9 +15,9 @@
<methodparam><type>int</type><parameter>x</parameter></methodparam>
<methodparam><type>int</type><parameter>y</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Removes a region of an image and collapses the image to occupy the removed portion.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,33 +26,33 @@
<varlistentry>
<term><parameter>width</parameter></term>
<listitem>
<para>
<simpara>
Width of the chopped area.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>height</parameter></term>
<listitem>
<para>
<simpara>
Height of the chopped area.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>x</parameter></term>
<listitem>
<para>
<simpara>
X origo of the chopped area.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y</parameter></term>
<listitem>
<para>
<simpara>
Y origo of the chopped area.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -60,16 +60,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The chopped <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>

18
reference/gmagick/gmagick/clear.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.clear" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.clear">
<refnamediv>
<refname>Gmagick::clear</refname>
<refpurpose>Clears all resources associated to Gmagick object</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>Gmagick</type><methodname>Gmagick::clear</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Clears all resources associated to <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,20 +24,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The cleared <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/gmagick/gmagick/commentimage.xml
View File

@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>Gmagick</type><methodname>Gmagick::commentimage</methodname>
<methodparam><type>string</type><parameter>comment</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Adds a comment to your image.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,9 +23,9 @@
<varlistentry>
<term><parameter>comment</parameter></term>
<listitem>
<para>
<simpara>
The comment to add.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -33,16 +33,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The <classname>Gmagick</classname> object with comment added.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>

28
reference/gmagick/gmagick/compositeimage.xml
View File

@@ -15,9 +15,9 @@
<methodparam><type>int</type><parameter>x</parameter></methodparam>
<methodparam><type>int</type><parameter>y</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Composite one image onto another at the specified offset.
</para>
</simpara>
</refsect1>
@@ -27,33 +27,33 @@
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
<simpara>
<classname>Gmagick</classname> object which holds the composite image.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>COMPOSE</parameter></term>
<listitem>
<para>
<simpara>
Composite operator.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>x</parameter></term>
<listitem>
<para>
<simpara>
The column offset of the composited image.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y</parameter></term>
<listitem>
<para>
<simpara>
The row offset of the composited image.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -61,16 +61,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The <classname>Gmagick</classname> object with compositions.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>

12
reference/gmagick/gmagick/construct.xml
View File

@@ -12,9 +12,9 @@
<modifier>public</modifier> <methodname>Gmagick::__construct</methodname>
<methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
</constructorsynopsis>
<para>
<simpara>
The <classname>Gmagick</classname> constructor.
</para>
</simpara>
</refsect1>
@@ -24,9 +24,9 @@
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
<simpara>
The path to an image to load or array of paths.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,9 +34,9 @@
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>

28
reference/gmagick/gmagick/cropimage.xml
View File

@@ -21,9 +21,9 @@
<methodparam><type>int</type><parameter>x</parameter></methodparam>
<methodparam><type>int</type><parameter>y</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Extracts a region of the image.
</para>
</simpara>
</refsect1>
@@ -37,9 +37,9 @@
<parameter>width</parameter>
</term>
<listitem>
<para>
<simpara>
The width of the crop.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -47,25 +47,25 @@
<parameter>height</parameter>
</term>
<listitem>
<para>
<simpara>
The height of the crop.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>x</parameter></term>
<listitem>
<para>
<simpara>
The X coordinate of the cropped region's top left corner.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y</parameter></term>
<listitem>
<para>
<simpara>
The Y coordinate of the cropped region's top left corner.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -73,16 +73,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The cropped <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>

20
reference/gmagick/gmagick/cropthumbnailimage.xml
View File

@@ -13,9 +13,9 @@
<methodparam><type>int</type><parameter>width</parameter></methodparam>
<methodparam><type>int</type><parameter>height</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Creates a fixed size thumbnail by first scaling the image down and cropping a specified area from the center.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,17 +24,17 @@
<varlistentry>
<term><parameter>width</parameter></term>
<listitem>
<para>
<simpara>
The width of the thumbnail.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>height</parameter></term>
<listitem>
<para>
<simpara>
The Height of the thumbnail.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -42,16 +42,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The cropped <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>

20
reference/gmagick/gmagick/current.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.current" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.current">
<refnamediv>
<refname>Gmagick::current</refname>
<refpurpose>The current purpose</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>Gmagick</type><methodname>Gmagick::current</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Returns reference to the current gmagick object with image pointer at the correct sequence.
</para>
<simpara>
Returns reference to the current gmagick object with image pointer at the correct sequence.
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,20 +24,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns self on success.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/gmagick/gmagick/cyclecolormapimage.xml
View File

@@ -12,10 +12,10 @@
<modifier>public</modifier> <type>Gmagick</type><methodname>Gmagick::cyclecolormapimage</methodname>
<methodparam><type>int</type><parameter>displace</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Displaces an image's colormap by a given number of positions. If you cycle the colormap a number of times you can
produce a psychedelic effect.
</para>
</simpara>
</refsect1>
@@ -25,9 +25,9 @@ produce a psychedelic effect.
<varlistentry>
<term><parameter>displace</parameter></term>
<listitem>
<para>
<simpara>
The amount to displace the colormap.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,16 +35,16 @@ produce a psychedelic effect.
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns self on success.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>

20
reference/gmagick/gmagick/deconstructimages.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.deconstructimages" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.deconstructimages">
<refnamediv>
<refname>Gmagick::deconstructimages</refname>
<refpurpose>Returns certain pixel differences between images</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>Gmagick</type><methodname>Gmagick::deconstructimages</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Compares each image with the next in a sequence and returns the maximum bounding region of any pixel differences it discovers.
</para>
<simpara>
Compares each image with the next in a sequence and returns the maximum bounding region of any pixel differences it discovers.
</simpara>
</refsect1>
@@ -26,20 +25,19 @@ Compares each image with the next in a sequence and returns the maximum bounding
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a new <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

12
reference/gmagick/gmagick/despeckleimage.xml
View File

@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>Gmagick</type><methodname>Gmagick::despeckleimage</methodname>
<void/>
</methodsynopsis>
<para>
<simpara>
Reduces the speckle noise in an image while preserving the edges of the original image.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,16 +24,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The despeckled <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

18
reference/gmagick/gmagick/destroy.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.destroy" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.destroy">
<refnamediv>
<refname>Gmagick::destroy</refname>
<refpurpose>The destroy purpose</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>Gmagick::destroy</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Destroys the <classname>Gmagick</classname> object and frees all resources associated with it
</para>
</simpara>
</refsect1>
@@ -26,20 +25,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/gmagick/gmagick/drawimage.xml
View File

@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>Gmagick</type><methodname>Gmagick::drawimage</methodname>
<methodparam><type>GmagickDraw</type><parameter>GmagickDraw</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Renders the <classname>GmagickDraw</classname> object on the current image.
</para>
</simpara>
</refsect1>
@@ -25,9 +25,9 @@
<varlistentry>
<term><parameter>GmagickDraw</parameter></term>
<listitem>
<para>
<simpara>
The drawing operations to render on the image.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,16 +35,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The drawn <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>

16
reference/gmagick/gmagick/edgeimage.xml
View File

@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>Gmagick</type><methodname>Gmagick::edgeimage</methodname>
<methodparam><type>float</type><parameter>radius</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Enhance edges within the image with a convolution filter of the given radius. Use radius 0 and it will be auto-selected.
</para>
</simpara>
</refsect1>
@@ -25,9 +25,9 @@
<varlistentry>
<term><parameter>radius</parameter></term>
<listitem>
<para>
<simpara>
The radius of the operation.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,16 +35,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The <classname>Gmagick</classname> object with edges enhanced.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>

20
reference/gmagick/gmagick/embossimage.xml
View File

@@ -13,9 +13,9 @@
<methodparam><type>float</type><parameter>radius</parameter></methodparam>
<methodparam><type>float</type><parameter>sigma</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Returns a grayscale image with a three-dimensional effect. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and it will choose a suitable radius for you.
</para>
</simpara>
</refsect1>
@@ -26,17 +26,17 @@
<varlistentry>
<term><parameter>radius</parameter></term>
<listitem>
<para>
<simpara>
The radius of the effect.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>sigma</parameter></term>
<listitem>
<para>
<simpara>
The sigma of the effect.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -44,16 +44,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The embossed <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>

18
reference/gmagick/gmagick/enhanceimage.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.enhanceimage" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.enhanceimage">
<refnamediv>
<refname>Gmagick::enhanceimage</refname>
<refpurpose>Improves the quality of a noisy image</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>Gmagick</type><methodname>Gmagick::enhanceimage</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Applies a digital filter that improves the quality of a noisy image.
</para>
</simpara>
</refsect1>
@@ -26,21 +25,20 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The enhanced <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/gmagick/gmagick/equalizeimage.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.equalizeimage" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.equalizeimage">
<refnamediv>
<refname>Gmagick::equalizeimage</refname>
<refpurpose>Equalizes the image histogram</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>Gmagick</type><methodname>Gmagick::equalizeimage</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Equalizes the image histogram.
</para>
</simpara>
</refsect1>
@@ -26,20 +25,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The equalized <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

22
reference/gmagick/gmagick/flipimage.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.flipimage" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.flipimage">
<refnamediv>
<refname>Gmagick::flipimage</refname>
<refpurpose>Creates a vertical mirror image</refpurpose>
@@ -11,30 +10,30 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>Gmagick</type><methodname>Gmagick::flipimage</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Creates a vertical mirror image by reflecting the pixels around the central x-axis.
</para>
<simpara>
Creates a vertical mirror image by reflecting the pixels around the central x-axis.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The flipped <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -45,7 +44,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/gmagick/gmagick/flopimage.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.flopimage" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.flopimage">
<refnamediv>
<refname>Gmagick::flopimage</refname>
<refpurpose>Creates a horizontal mirror image</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>Gmagick</type><methodname>Gmagick::flopimage</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Creates a horizontal mirror image by reflecting the pixels around the central y-axis.
</para>
<simpara>
Creates a horizontal mirror image by reflecting the pixels around the central y-axis.
</simpara>
</refsect1>
@@ -26,16 +25,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The flopped <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
@@ -46,7 +45,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

32
reference/gmagick/gmagick/frameimage.xml
View File

@@ -16,9 +16,9 @@
<methodparam><type>int</type><parameter>inner_bevel</parameter></methodparam>
<methodparam><type>int</type><parameter>outer_bevel</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Adds a simulated three-dimensional border around the image. The width and height specify the border width of the vertical and horizontal sides of the frame. The inner and outer bevels indicate the width of the inner and outer shadows of the frame.
</para>
</simpara>
</refsect1>
@@ -28,41 +28,41 @@ Adds a simulated three-dimensional border around the image. The width and height
<varlistentry>
<term><parameter>color</parameter></term>
<listitem>
<para>
<simpara>
<classname>GmagickPixel</classname> object or a float representing the matte color.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>width</parameter></term>
<listitem>
<para>
<simpara>
The width of the border.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>height</parameter></term>
<listitem>
<para>
<simpara>
The height of the border.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>inner_bevel</parameter></term>
<listitem>
<para>
<simpara>
The inner bevel width.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>outer_bevel</parameter></term>
<listitem>
<para>
<simpara>
The outer bevel width.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -70,16 +70,16 @@ Adds a simulated three-dimensional border around the image. The width and height
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The framed <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>

16
reference/gmagick/gmagick/gammaimage.xml
View File

@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>Gmagick</type><methodname>Gmagick::gammaimage</methodname>
<methodparam><type>float</type><parameter>gamma</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Gamma-corrects an image. The same image viewed on different devices will have perceptual differences in the way the image's intensities are represented on the screen. Specify individual gamma levels for the red, green, and blue channels, or adjust all three with the gamma parameter. Values typically range from 0.8 to 2.3.
</para>
</simpara>
</refsect1>
@@ -24,9 +24,9 @@
<varlistentry>
<term><parameter>gamma</parameter></term>
<listitem>
<para>
<simpara>
The amount of gamma-correction.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,16 +34,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The gamma corrected <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>

18
reference/gmagick/gmagick/getcopyright.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getcopyright" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getcopyright">
<refnamediv>
<refname>Gmagick::getcopyright</refname>
<refpurpose>Returns the GraphicsMagick API copyright as a string</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>Gmagick::getcopyright</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns the GraphicsMagick API copyright as a string.
</para>
</simpara>
</refsect1>
@@ -26,21 +25,20 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a string containing the copyright notice of GraphicsMagick and
Magickwand C API.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/gmagick/gmagick/getfilename.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getfilename" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getfilename">
<refnamediv>
<refname>Gmagick::getfilename</refname>
<refpurpose>The filename associated with an image sequence</refpurpose>
@@ -11,34 +10,33 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>Gmagick::getfilename</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns the filename associated with an image sequence.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a string on success.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/gmagick/gmagick/getimagebackgroundcolor.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimagebackgroundcolor" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimagebackgroundcolor">
<refnamediv>
<refname>Gmagick::getimagebackgroundcolor</refname>
<refpurpose>Returns the image background color</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>GmagickPixel</type><methodname>Gmagick::getimagebackgroundcolor</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns the image background color.
</para>
</simpara>
</refsect1>
@@ -27,20 +26,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns an GmagickPixel set to the background color of the image.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/gmagick/gmagick/getimageblueprimary.xml
View File

@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>array</type><methodname>Gmagick::getimageblueprimary</methodname>
<void/>
</methodsynopsis>
<para>
<simpara>
Returns the chromaticity blue primary point for the image.
</para>
</simpara>
</refsect1>
@@ -25,17 +25,17 @@
<varlistentry>
<term><parameter>x</parameter></term>
<listitem>
<para>
<simpara>
The chromaticity blue primary x-point.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y</parameter></term>
<listitem>
<para>
<simpara>
The chromaticity blue primary y-point.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -43,16 +43,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Array consisting of "x" and "y" coordinates of point.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>

18
reference/gmagick/gmagick/getimagebordercolor.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimagebordercolor" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimagebordercolor">
<refnamediv>
<refname>Gmagick::getimagebordercolor</refname>
<refpurpose>Returns the image border color</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>GmagickPixel</type><methodname>Gmagick::getimagebordercolor</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns the image border color.
</para>
</simpara>
</refsect1>
@@ -27,20 +26,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<classname>GmagickPixel</classname> object representing the color of the border.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/gmagick/gmagick/getimagechanneldepth.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimagechanneldepth" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimagechanneldepth">
<refnamediv>
<refname>Gmagick::getimagechanneldepth</refname>
<refpurpose>Gets the depth for a particular image channel</refpurpose>
@@ -13,9 +12,9 @@
<modifier>public</modifier> <type>int</type><methodname>Gmagick::getimagechanneldepth</methodname>
<methodparam><type>int</type><parameter>channel_type</parameter></methodparam>
</methodsynopsis>
<para>
Gets the depth for a particular image channel.
</para>
<simpara>
Gets the depth for a particular image channel.
</simpara>
</refsect1>
@@ -27,20 +26,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Depth of image channel
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/gmagick/gmagick/getimagecolors.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimagecolors" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimagecolors">
<refnamediv>
<refname>Gmagick::getimagecolors</refname>
<refpurpose>Returns the color of the specified colormap index</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>Gmagick::getimagecolors</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns the color of the specified colormap index.
</para>
</simpara>
</refsect1>
@@ -27,20 +26,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The number of colors in image.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/gmagick/gmagick/getimagecolorspace.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimagecolorspace" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimagecolorspace">
<refnamediv>
<refname>Gmagick::getimagecolorspace</refname>
<refpurpose>Gets the image colorspace</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>Gmagick::getimagecolorspace</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Gets the image colorspace.
</para>
</simpara>
</refsect1>
@@ -27,20 +26,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Colorspace
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/gmagick/gmagick/getimagecompose.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimagecompose" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimagecompose">
<refnamediv>
<refname>Gmagick::getimagecompose</refname>
<refpurpose>Returns the composite operator associated with the image</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>Gmagick::getimagecompose</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Returns the composite operator associated with the image.
</para>
<simpara>
Returns the composite operator associated with the image.
</simpara>
</refsect1>
@@ -27,20 +26,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the composite operator associated with the image.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/gmagick/gmagick/getimagedelay.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimagedelay" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimagedelay">
<refnamediv>
<refname>Gmagick::getimagedelay</refname>
<refpurpose>Gets the image delay</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>Gmagick::getimagedelay</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Gets the image delay
</para>
</simpara>
</refsect1>
@@ -26,20 +25,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the composite operator associated with the image.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/gmagick/gmagick/getimagedepth.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimagedepth" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimagedepth">
<refnamediv>
<refname>Gmagick::getimagedepth</refname>
<refpurpose>Gets the depth of the image</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>Gmagick::getimagedepth</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Gets the depth of the image.
</para>
</simpara>
</refsect1>
@@ -27,20 +26,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Image depth
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/gmagick/gmagick/getimagedispose.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimagedispose" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimagedispose">
<refnamediv>
<refname>Gmagick::getimagedispose</refname>
<refpurpose>Gets the image disposal method</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>Gmagick::getimagedispose</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Gets the image disposal method
</para>
</simpara>
</refsect1>
@@ -26,20 +25,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the dispose method on success.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/gmagick/gmagick/getimageextrema.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimageextrema" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimageextrema">
<refnamediv>
<refname>Gmagick::getimageextrema</refname>
<refpurpose>Gets the extrema for the image</refpurpose>
@@ -11,13 +10,13 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>Gmagick::getimageextrema</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns an associative array with the keys "min" and "max". &gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
@@ -28,20 +27,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns an associative array with the keys "min" and "max".
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/gmagick/gmagick/getimagefilename.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimagefilename" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimagefilename">
<refnamediv>
<refname>Gmagick::getimagefilename</refname>
<refpurpose>Returns the filename of a particular image in a sequence</refpurpose>
@@ -11,13 +10,13 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>Gmagick::getimagefilename</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns the filename of a particular image in a sequence
</para>
</simpara>
</refsect1>
@@ -28,20 +27,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a string with the filename of the image
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/gmagick/gmagick/getimageformat.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimageformat" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimageformat">
<refnamediv>
<refname>Gmagick::getimageformat</refname>
<refpurpose>Returns the format of a particular image in a sequence</refpurpose>
@@ -11,13 +10,13 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>Gmagick::getimageformat</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns the format of a particular image in a sequence.
</para>
</simpara>
</refsect1>
@@ -28,20 +27,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a string containing the image format on success.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/gmagick/gmagick/getimagegamma.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimagegamma" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimagegamma">
<refnamediv>
<refname>Gmagick::getimagegamma</refname>
<refpurpose>Gets the image gamma</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>float</type><methodname>Gmagick::getimagegamma</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Gets the image gamma
</para>
</simpara>
</refsect1>
@@ -26,19 +25,18 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the image gamma on success
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

22
reference/gmagick/gmagick/getimagegreenprimary.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimagegreenprimary" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimagegreenprimary">
<refnamediv>
<refname>Gmagick::getimagegreenprimary</refname>
<refpurpose>Returns the chromaticy green primary point</refpurpose>
@@ -11,13 +10,13 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>Gmagick::getimagegreenprimary</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns the chromaticity green primary point. Returns an array with the keys "x" and "y".
</para>
</simpara>
</refsect1>
@@ -28,19 +27,18 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array with the keys "x" and "y" on success.
</para>
<simpara>
Returns an array with the keys "x" and "y" on success.
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/gmagick/gmagick/getimageheight.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimageheight" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimageheight">
<refnamediv>
<refname>Gmagick::getimageheight</refname>
<refpurpose>Returns the image height</refpurpose>
@@ -11,13 +10,13 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>Gmagick::getimageheight</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns the image height
</para>
</simpara>
</refsect1>
@@ -28,20 +27,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the image height in pixels.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

24
reference/gmagick/gmagick/getimagehistogram.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimagehistogram" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimagehistogram">
<refnamediv>
<refname>Gmagick::getimagehistogram</refname>
<refpurpose>Gets the image histogram</refpurpose>
@@ -11,14 +10,14 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>Gmagick::getimagehistogram</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Returns the image histogram as an array of <classname>GmagickPixel</classname> objects.
<simpara>
Returns the image histogram as an array of <classname>GmagickPixel</classname> objects.
Throw an <classname>GmagickException</classname> on error.
</para>
</simpara>
</refsect1>
@@ -29,20 +28,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the image histogram as an array of <classname>GmagickPixel</classname> objects.
</para>
<simpara>
Returns the image histogram as an array of <classname>GmagickPixel</classname> objects.
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/gmagick/gmagick/getimageindex.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimageindex" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimageindex">
<refnamediv>
<refname>Gmagick::getimageindex</refname>
<refpurpose>Gets the index of the current active image</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>Gmagick::getimageindex</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Returns the index of the current active image within the <classname>Gmagick</classname> object.
</para>
<simpara>
Returns the index of the current active image within the <classname>Gmagick</classname> object.
</simpara>
</refsect1>
@@ -26,20 +25,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Index of current active image.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

22
reference/gmagick/gmagick/getimageinterlacescheme.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimageinterlacescheme" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimageinterlacescheme">
<refnamediv>
<refname>Gmagick::getimageinterlacescheme</refname>
<refpurpose>Gets the image interlace scheme</refpurpose>
@@ -11,13 +10,13 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>Gmagick::getimageinterlacescheme</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Gets the image interlace scheme.
</para>
<simpara>
Gets the image interlace scheme.
</simpara>
</refsect1>
@@ -28,20 +27,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the interlace scheme as an integer on success
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/gmagick/gmagick/getimageiterations.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimageiterations" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimageiterations">
<refnamediv>
<refname>Gmagick::getimageiterations</refname>
<refpurpose>Gets the image iterations</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>Gmagick::getimageiterations</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Gets the image iterations.
</para>
</simpara>
</refsect1>
@@ -26,20 +25,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the image iterations as an integer.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/gmagick/gmagick/getimagematte.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimagematte" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimagematte">
<refnamediv>
<refname>Gmagick::getimagematte</refname>
<refpurpose>Check if the image has a matte channel</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>Gmagick::getimagematte</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns &true; if the image has a matte channel, otherwise &false;.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,20 +24,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns &true; if the image has a matte channel, otherwise &false;.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/gmagick/gmagick/getimagemattecolor.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimagemattecolor" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimagemattecolor">
<refnamediv>
<refname>Gmagick::getimagemattecolor</refname>
<refpurpose>Returns the image matte color</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>GmagickPixel</type><methodname>Gmagick::getimagemattecolor</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Returns GmagickPixel object on success. Throw an GmagickException on error.
</para>
<simpara>
Returns GmagickPixel object on success. Throw an GmagickException on error.
</simpara>
</refsect1>
@@ -26,20 +25,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns GmagickPixel object on success.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/gmagick/gmagick/getimageprofile.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimageprofile" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimageprofile">
<refnamediv>
<refname>Gmagick::getimageprofile</refname>
<refpurpose>Returns the named image profile</refpurpose>
@@ -13,11 +12,11 @@
<modifier>public</modifier> <type>string</type><methodname>Gmagick::getimageprofile</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para>
Returns the named image profile.
</para>
<simpara>
Returns the named image profile.
</simpara>
</refsect1>
@@ -28,20 +27,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a string containing the image profile.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

24
reference/gmagick/gmagick/getimageredprimary.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimageredprimary" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimageredprimary">
<refnamediv>
<refname>Gmagick::getimageredprimary</refname>
<refpurpose>Returns the chromaticity red primary point</refpurpose>
@@ -11,13 +10,13 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>Gmagick::getimageredprimary</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Returns the chromaticity red primary point as an array with the keys "x" and "y".
</para>
<simpara>
Returns the chromaticity red primary point as an array with the keys "x" and "y".
</simpara>
</refsect1>
@@ -28,20 +27,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the chromaticity red primary point as an array with the keys "x" and "y".
</para>
<simpara>
Returns the chromaticity red primary point as an array with the keys "x" and "y".
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/gmagick/gmagick/getimagerenderingintent.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimagerenderingintent" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimagerenderingintent">
<refnamediv>
<refname>Gmagick::getimagerenderingintent</refname>
<refpurpose>Gets the image rendering intent</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>Gmagick::getimagerenderingintent</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Gets the image rendering intent
</para>
</simpara>
@@ -28,20 +27,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Extracts a region of the image and returns it as a new wand
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/gmagick/gmagick/getimageresolution.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimageresolution" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimageresolution">
<refnamediv>
<refname>Gmagick::getimageresolution</refname>
<refpurpose>Gets the image X and Y resolution</refpurpose>
@@ -11,13 +10,13 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>Gmagick::getimageresolution</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns the resolution as an array.
</para>
</simpara>
</refsect1>
@@ -28,20 +27,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the resolution as an array.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/gmagick/gmagick/getimagescene.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimagescene" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimagescene">
<refnamediv>
<refname>Gmagick::getimagescene</refname>
<refpurpose>Gets the image scene</refpurpose>
@@ -11,13 +10,13 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>Gmagick::getimagescene</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Gets the image scene.
</para>
</simpara>
</refsect1>
@@ -28,20 +27,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the image scene.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

18
reference/gmagick/gmagick/getimagesignature.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimagesignature" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimagesignature">
<refnamediv>
<refname>Gmagick::getimagesignature</refname>
<refpurpose>Generates an SHA-256 message digest</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>Gmagick::getimagesignature</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Generates an SHA-256 message digest for the image pixel stream.
</para>
</simpara>
</refsect1>
@@ -26,20 +25,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a string containing the SHA-256 hash of the file.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

22
reference/gmagick/gmagick/getimagetype.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimagetype" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimagetype">
<refnamediv>
<refname>Gmagick::getimagetype</refname>
<refpurpose>Gets the potential image type</refpurpose>
@@ -11,13 +10,13 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>Gmagick::getimagetype</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Gets the potential image type.
</para>
<simpara>
Gets the potential image type.
</simpara>
</refsect1>
@@ -28,20 +27,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the potential image type.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/gmagick/gmagick/getimageunits.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimageunits" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimageunits">
<refnamediv>
<refname>Gmagick::getimageunits</refname>
<refpurpose>Gets the image units of resolution</refpurpose>
@@ -11,13 +10,13 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>Gmagick::getimageunits</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Gets the image units of resolution.
</para>
</simpara>
</refsect1>
@@ -28,14 +27,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the image units of resolution.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

22
reference/gmagick/gmagick/getimagewhitepoint.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimagewhitepoint" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimagewhitepoint">
<refnamediv>
<refname>Gmagick::getimagewhitepoint</refname>
<refpurpose>Returns the chromaticity white point</refpurpose>
@@ -11,13 +10,13 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>Gmagick::getimagewhitepoint</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Returns the chromaticity white point as an associative array with the keys "x" and "y".
</para>
<simpara>
Returns the chromaticity white point as an associative array with the keys "x" and "y".
</simpara>
</refsect1>
@@ -28,19 +27,18 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the chromaticity white point as an associative array with the keys "x" and "y".
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

22
reference/gmagick/gmagick/getimagewidth.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getimagewidth" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getimagewidth">
<refnamediv>
<refname>Gmagick::getimagewidth</refname>
<refpurpose>Returns the width of the image</refpurpose>
@@ -11,13 +10,13 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>Gmagick::getimagewidth</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns the width of the image.
</para>
</simpara>
</refsect1>
@@ -28,19 +27,18 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the image width.
</para>
<simpara>
Returns the image width.
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/gmagick/gmagick/getpackagename.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getpackagename" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getpackagename">
<refnamediv>
<refname>Gmagick::getpackagename</refname>
<refpurpose>Returns the GraphicsMagick package name</refpurpose>
@@ -11,13 +10,13 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>Gmagick::getpackagename</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns the GraphicsMagick package name.
</para>
</simpara>
</refsect1>
@@ -28,20 +27,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the GraphicsMagick package name as a string.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

22
reference/gmagick/gmagick/getquantumdepth.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getquantumdepth" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getquantumdepth">
<refnamediv>
<refname>Gmagick::getquantumdepth</refname>
<refpurpose>Returns the Gmagick quantum depth as a string</refpurpose>
@@ -11,13 +10,13 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>Gmagick::getquantumdepth</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns the <classname>Gmagick</classname> quantum depth as a string.
</para>
</simpara>
</refsect1>
@@ -28,20 +27,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the <classname>Gmagick</classname> quantum depth as a string.
</para>
<simpara>
Returns the <classname>Gmagick</classname> quantum depth as a string.
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

22
reference/gmagick/gmagick/getreleasedate.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getreleasedate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getreleasedate">
<refnamediv>
<refname>Gmagick::getreleasedate</refname>
<refpurpose>Returns the GraphicsMagick release date as a string</refpurpose>
@@ -11,13 +10,13 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>Gmagick::getreleasedate</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns the GraphicsMagick release date as a string.
</para>
</simpara>
</refsect1>
@@ -28,19 +27,18 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the GraphicsMagick release date as a string.
</para>
<simpara>
Returns the GraphicsMagick release date as a string.
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

24
reference/gmagick/gmagick/getsamplingfactors.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getsamplingfactors" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getsamplingfactors">
<refnamediv>
<refname>Gmagick::getsamplingfactors</refname>
<refpurpose>Gets the horizontal and vertical sampling factor</refpurpose>
@@ -11,13 +10,13 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>Gmagick::getsamplingfactors</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Gets the horizontal and vertical sampling factor.
</para>
<simpara>
Gets the horizontal and vertical sampling factor.
</simpara>
</refsect1>
@@ -28,20 +27,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an associative array with the horizontal and vertical sampling factors of the image.
</para>
<simpara>
Returns an associative array with the horizontal and vertical sampling factors of the image.
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

22
reference/gmagick/gmagick/getsize.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getsize" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getsize">
<refnamediv>
<refname>Gmagick::getsize</refname>
<refpurpose>Returns the size associated with the Gmagick object</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>Gmagick::getsize</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Returns the size associated with the <classname>Gmagick</classname> object as an array with the keys "columns" and "rows".
</para>
<simpara>
Returns the size associated with the <classname>Gmagick</classname> object as an array with the keys "columns" and "rows".
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,20 +24,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the size associated with the <classname>Gmagick</classname> object as an array with the keys "columns" and "rows".
</para>
<simpara>
Returns the size associated with the <classname>Gmagick</classname> object as an array with the keys "columns" and "rows".
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

22
reference/gmagick/gmagick/getversion.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.getversion" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.getversion">
<refnamediv>
<refname>Gmagick::getversion</refname>
<refpurpose>Returns the GraphicsMagick API version</refpurpose>
@@ -11,13 +10,13 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>Gmagick::getversion</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Returns the GraphicsMagick API version as a string and as a number.
</para>
<simpara>
Returns the GraphicsMagick API version as a string and as a number.
</simpara>
</refsect1>
@@ -28,20 +27,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the GraphicsMagick API version as a string and as a number.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

22
reference/gmagick/gmagick/hasnextimage.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.hasnextimage" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.hasnextimage">
<refnamediv>
<refname>Gmagick::hasnextimage</refname>
<refpurpose>Checks if the object has more images</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>Gmagick::hasnextimage</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Returns &true; if the object has more images when traversing the list in the forward direction.
</para>
<simpara>
Returns &true; if the object has more images when traversing the list in the forward direction.
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,19 +24,18 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the object has more images when traversing the list in the forward direction, returns &false; if there are none.
</para>
<simpara>
Returns &true; if the object has more images when traversing the list in the forward direction, returns &false; if there are none.
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/gmagick/gmagick/haspreviousimage.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.haspreviousimage" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.haspreviousimage">
<refnamediv>
<refname>Gmagick::haspreviousimage</refname>
<refpurpose>Checks if the object has a previous image</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>Gmagick::haspreviousimage</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Returns &true; if the object has more images when traversing the list in the reverse direction.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,19 +24,18 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the object has more images when traversing the list in the reverse direction, returns &false; if there are none.
</para>
<simpara>
Returns &true; if the object has more images when traversing the list in the reverse direction, returns &false; if there are none.
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/gmagick/gmagick/implodeimage.xml
View File

@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>mixed</type><methodname>Gmagick::implodeimage</methodname>
<methodparam><type>float</type><parameter>radius</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Creates a new image that is a copy of an existing one with the image pixels "imploded" by the specified percentage.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,9 +23,9 @@
<varlistentry>
<term><parameter>radius</parameter></term>
<listitem>
<para>
<simpara>
The radius of the implode.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -33,16 +33,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns imploded <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

16
reference/gmagick/gmagick/labelimage.xml
View File

@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>mixed</type><methodname>Gmagick::labelimage</methodname>
<methodparam><type>string</type><parameter>label</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Adds a label to an image.
</para>
</simpara>
@@ -26,9 +26,9 @@
<varlistentry>
<term><parameter>label</parameter></term>
<listitem>
<para>
<simpara>
The label to add
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -36,16 +36,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Gmagick with label.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

28
reference/gmagick/gmagick/levelimage.xml
View File

@@ -15,14 +15,14 @@
<methodparam><type>float</type><parameter>whitePoint</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>channel</parameter><initializer>Gmagick::CHANNEL_DEFAULT</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Adjusts the levels of an image by scaling the colors falling between specified white and black
points to the full available quantum range. The parameters provided represent the black, mid, and
white points. The black point specifies the darkest color in the image. Colors darker than the black
point are set to zero. Mid point specifies a gamma correction to apply to the image. White point
specifies the lightest color in the image. Colors brighter than the white point are set to the
maximum quantum value.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -31,35 +31,35 @@
<varlistentry>
<term><parameter>blackPoint</parameter></term>
<listitem>
<para>
<simpara>
The image black point.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>gamma</parameter></term>
<listitem>
<para>
<simpara>
The gamma value.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>whitePoint</parameter></term>
<listitem>
<para>
<simpara>
The image white point.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>channel</parameter></term>
<listitem>
<para>
<simpara>
Provide any channel constant that is valid for your channel mode.
To apply to more than one channel, combine channeltype constants using bitwise
operators. Refer to this list of <link linkend="gmagick.constants.channel">channel constants</link>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -67,15 +67,15 @@ operators. Refer to this list of <link linkend="gmagick.constants.channel">chann
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<classname>Gmagick</classname> object with image leveled.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

20
reference/gmagick/gmagick/magnifyimage.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.magnifyimage" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.magnifyimage">
<refnamediv>
<refname>Gmagick::magnifyimage</refname>
<refpurpose>Scales an image proportionally 2x</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>Gmagick::magnifyimage</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Conveniently scales an image proportionally to twice its original size.
</para>
<simpara>
Conveniently scales an image proportionally to twice its original size.
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,19 +24,18 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Magnified <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/gmagick/gmagick/mapimage.xml
View File

@@ -13,9 +13,9 @@
<methodparam><type>gmagick</type><parameter>gmagick</parameter></methodparam>
<methodparam><type>bool</type><parameter>dither</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Replaces the colors of an image with the closest color from a reference image.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,17 +24,17 @@
<varlistentry>
<term><parameter>gmagick</parameter></term>
<listitem>
<para>
<simpara>
The reference image.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dither</parameter></term>
<listitem>
<para>
<simpara>
Set this integer value to something other than zero to dither the mapped image.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -42,15 +42,15 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

16
reference/gmagick/gmagick/medianfilterimage.xml
View File

@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>void</type><methodname>Gmagick::medianfilterimage</methodname>
<methodparam><type>float</type><parameter>radius</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Applies a digital filter that improves the quality of a noisy image. Each pixel is replaced by the median in a set of neighboring pixels as defined by radius.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,9 +23,9 @@
<varlistentry>
<term><parameter>radius</parameter></term>
<listitem>
<para>
<simpara>
The radius of the pixel neighborhood.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -33,16 +33,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
<classname>Gmagick</classname> object with median filter applied.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>

18
reference/gmagick/gmagick/minifyimage.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.minifyimage" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.minifyimage">
<refnamediv>
<refname>Gmagick::minifyimage</refname>
<refpurpose>Scales an image proportionally to half its size</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>Gmagick</type><methodname>Gmagick::minifyimage</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
A convenient method that scales an image proportionally to one-half its original size.
</para>
</simpara>
</refsect1>
@@ -26,20 +25,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

24
reference/gmagick/gmagick/modulateimage.xml
View File

@@ -14,12 +14,12 @@
<methodparam><type>float</type><parameter>saturation</parameter></methodparam>
<methodparam><type>float</type><parameter>hue</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Lets you control the brightness, saturation, and hue of an image. Hue is the
percentage of absolute rotation from the current position. For example 50 results
in a counter-clockwise rotation of 90 degrees, 150 results in a clockwise rotation
of 90 degrees, with 0 and 200 both resulting in a rotation of 180 degrees.
</para>
</simpara>
@@ -31,25 +31,25 @@
<varlistentry>
<term><parameter>brightness</parameter></term>
<listitem>
<para>
<simpara>
The percent change in brighness (-100 thru +100).
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>saturation</parameter></term>
<listitem>
<para>
<simpara>
The percent change in saturation (-100 thru +100)
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>hue</parameter></term>
<listitem>
<para>
<simpara>
The percent change in hue (-100 thru +100)
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -57,16 +57,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>

24
reference/gmagick/gmagick/motionblurimage.xml
View File

@@ -14,12 +14,12 @@
<methodparam><type>float</type><parameter>sigma</parameter></methodparam>
<methodparam><type>float</type><parameter>angle</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Simulates motion blur. We convolve the image with a Gaussian operator of the
given radius and standard deviation (sigma). For reasonable results, radius should be
larger than sigma. Use a radius of 0 and <methodname>Gmagick::motionblurimage</methodname> selects a suitable radius
for you. Angle gives the angle of the blurring motion.
</para>
</simpara>
</refsect1>
@@ -29,25 +29,25 @@
<varlistentry>
<term><parameter>radius</parameter></term>
<listitem>
<para>
<simpara>
The radius of the Gaussian, in pixels, not counting the center pixel.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>sigma</parameter></term>
<listitem>
<para>
<simpara>
The standard deviation of the Gaussian, in pixels.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>angle</parameter></term>
<listitem>
<para>
<simpara>
Apply the effect along this angle.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -55,15 +55,15 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

28
reference/gmagick/gmagick/newimage.xml
View File

@@ -15,9 +15,9 @@
<methodparam><type>string</type><parameter>background</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>format</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Creates a new image with the specified background color.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,33 +26,33 @@
<varlistentry>
<term><parameter>width</parameter></term>
<listitem>
<para>
<simpara>
Width of the new image.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>height</parameter></term>
<listitem>
<para>
<simpara>
Height of the new image.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>background</parameter></term>
<listitem>
<para>
<simpara>
The background color used for this image (as float).
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>format</parameter></term>
<listitem>
<para>
<simpara>
Image format.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -60,16 +60,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>

20
reference/gmagick/gmagick/nextimage.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.nextimage" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.nextimage">
<refnamediv>
<refname>Gmagick::nextimage</refname>
<refpurpose>Moves to the next image</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>Gmagick::nextimage</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Associates the next image in the image list with an <classname>Gmagick</classname> object.
</para>
<simpara>
Associates the next image in the image list with an <classname>Gmagick</classname> object.
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,20 +24,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/gmagick/gmagick/normalizeimage.xml
View File

@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>Gmagick</type><methodname>Gmagick::normalizeimage</methodname>
<methodparam choice="opt"><type>int</type><parameter>channel</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Enhances the contrast of a color image by adjusting the pixels color to span the entire range of colors available.
</para>
</simpara>
</refsect1>
@@ -24,9 +24,9 @@
<varlistentry>
<term><parameter>channel</parameter></term>
<listitem>
<para>
<simpara>
Identify which channel to normalize.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,16 +34,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>

16
reference/gmagick/gmagick/oilpaintimage.xml
View File

@@ -15,9 +15,9 @@
<parameter>radius</parameter>
</methodparam>
</methodsynopsis>
<para>
<simpara>
Applies a special effect filter that simulates an oil painting. Each pixel is replaced by the most frequent color occurring in a circular region defined by radius.
</para>
</simpara>
@@ -31,9 +31,9 @@
<parameter>radius</parameter>
</term>
<listitem>
<para>
<simpara>
The radius of the circular neighborhood.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -41,15 +41,15 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The Gmagick object on success
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>

20
reference/gmagick/gmagick/previousimage.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.previousimage" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.previousimage">
<refnamediv>
<refname>Gmagick::previousimage</refname>
<refpurpose>Move to the previous image in the object</refpurpose>
@@ -11,13 +10,13 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>Gmagick::previousimage</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Associates the previous image in an image list with the Gmagick object.
</para>
</simpara>
</refsect1>
@@ -28,20 +27,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/gmagick/gmagick/profileimage.xml
View File

@@ -13,10 +13,10 @@
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>profile</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Adds or removes a ICC, IPTC, or generic profile from an image. If the profile is &null;, it is removed from the image otherwise added.
Use a name of <literal>*</literal> and a profile of &null; to remove all profiles from the image.
</para>
</simpara>
</refsect1>
@@ -26,17 +26,17 @@
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
<simpara>
Name of profile to add or remove: ICC, IPTC, or generic profile.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>profile</parameter></term>
<listitem>
<para>
<simpara>
The profile.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -44,16 +44,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>

32
reference/gmagick/gmagick/quantizeimage.xml
View File

@@ -16,11 +16,11 @@
<methodparam><type>bool</type><parameter>dither</parameter></methodparam>
<methodparam><type>bool</type><parameter>measureError</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Analyzes the colors within a reference image and chooses a fixed number of
colors to represent the image. The goal of the algorithm is to minimize the
color difference between the input and output image while minimizing the processing time.
</para>
</simpara>
@@ -32,46 +32,46 @@
<varlistentry>
<term><parameter>numColors</parameter></term>
<listitem>
<para>
<simpara>
The number of colors.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>colorspace</parameter></term>
<listitem>
<para>
<simpara>
Perform color reduction in this colorspace, typically RGBColorspace.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>treeDepth</parameter></term>
<listitem>
<para>
<simpara>
Normally, this integer value is zero or one. A zero or one tells Quantize
to choose a optimal tree depth of Log4(number_colors).% A tree of this depth generally
allows the best representation of the reference image with the least amount of memory
and the fastest computational speed. In some cases, such as an image with low color
dispersion (a few number of colors), a value other than Log4(number_colors) is required.
To expand the color tree completely, use a value of 8.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dither</parameter></term>
<listitem>
<para>
<simpara>
A value other than zero distributes the difference between an original image and the corresponding color reduced algorithm to neighboring pixels along a Hilbert curve.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>measureError</parameter></term>
<listitem>
<para>
<simpara>
A value other than zero measures the difference between the original and quantized images. This difference is the total quantization error. The error is computed by summing over all pixels in an image the distance squared in RGB space between each reference pixel value and its quantized value.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -79,16 +79,16 @@ To expand the color tree completely, use a value of 8.
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The Gmagick object on success
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

32
reference/gmagick/gmagick/quantizeimages.xml
View File

@@ -16,11 +16,11 @@
<methodparam><type>bool</type><parameter>dither</parameter></methodparam>
<methodparam><type>bool</type><parameter>measureError</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Analyzes the colors within a sequence of images and chooses a fixed number of
colors to represent the image. The goal of the algorithm is to minimize the
color difference between the input and output image while minimizing the processing time.
</para>
</simpara>
@@ -32,46 +32,46 @@
<varlistentry>
<term><parameter>numColors</parameter></term>
<listitem>
<para>
<simpara>
The number of colors.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>colorspace</parameter></term>
<listitem>
<para>
<simpara>
Perform color reduction in this colorspace, typically RGBColorspace.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>treeDepth</parameter></term>
<listitem>
<para>
<simpara>
Normally, this integer value is zero or one. A zero or one tells Quantize
to choose a optimal tree depth of Log4(number_colors).% A tree of this depth generally
allows the best representation of the reference image with the least amount of memory
and the fastest computational speed. In some cases, such as an image with low color
dispersion (a few number of colors), a value other than Log4(number_colors) is required.
To expand the color tree completely, use a value of 8.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dither</parameter></term>
<listitem>
<para>
<simpara>
A value other than zero distributes the difference between an original image and the corresponding color reduced algorithm to neighboring pixels along a Hilbert curve.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>measureError</parameter></term>
<listitem>
<para>
<simpara>
A value other than zero measures the difference between the original and quantized images. This difference is the total quantization error. The error is computed by summing over all pixels in an image the distance squared in RGB space between each reference pixel value and its quantized value.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -79,16 +79,16 @@ To expand the color tree completely, use a value of 8.
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The Gmagick object on success
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

16
reference/gmagick/gmagick/queryfontmetrics.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.queryfontmetrics" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.queryfontmetrics">
<refnamediv>
<refname>Gmagick::queryfontmetrics</refname>
<refpurpose>Returns an array representing the font metrics</refpurpose>
@@ -14,9 +13,9 @@
<methodparam><type>GmagickDraw</type><parameter>draw</parameter></methodparam>
<methodparam><type>string</type><parameter>text</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
MagickQueryFontMetrics() returns an array representing the font metrics.
</para>
</simpara>
</refsect1>
@@ -27,20 +26,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The Gmagick object on success
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/gmagick/gmagick/queryfonts.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.queryfonts" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.queryfonts">
<refnamediv>
<refname>Gmagick::queryfonts</refname>
<refpurpose>Returns the configured fonts</refpurpose>
@@ -13,11 +12,11 @@
<modifier>public</modifier> <type>array</type><methodname>Gmagick::queryfonts</methodname>
<methodparam choice="opt"><type>string</type><parameter>pattern</parameter><initializer>"*"</initializer></methodparam>
</methodsynopsis>
<para>
Returns fonts supported by Gmagick.
</para>
<simpara>
Returns fonts supported by Gmagick.
</simpara>
</refsect1>
@@ -28,20 +27,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The Gmagick object on success
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/gmagick/gmagick/queryformats.xml
View File

@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>array</type><methodname>Gmagick::queryformats</methodname>
<methodparam choice="opt"><type>string</type><parameter>pattern</parameter><initializer>"*"</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Returns formats supported by <classname>Gmagick</classname>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,9 +23,9 @@
<varlistentry>
<term><parameter>pattern</parameter></term>
<listitem>
<para>
<simpara>
Specifies a <type>string</type> containing a pattern.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -33,16 +33,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

20
reference/gmagick/gmagick/radialblurimage.xml
View File

@@ -13,9 +13,9 @@
<methodparam><type>float</type><parameter>angle</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>channel</parameter><initializer>Gmagick::CHANNEL_DEFAULT</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Radial blurs an image.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,17 +24,17 @@
<varlistentry>
<term><parameter>angle</parameter></term>
<listitem>
<para>
<simpara>
The angle of the blur in degrees.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>channel</parameter></term>
<listitem>
<para>
<simpara>
Related channel.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -42,15 +42,15 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

32
reference/gmagick/gmagick/raiseimage.xml
View File

@@ -16,9 +16,9 @@
<methodparam><type>int</type><parameter>y</parameter></methodparam>
<methodparam><type>bool</type><parameter>raise</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Creates a simulated three-dimensional button-like effect by lightening and darkening the edges of the image. Members width and height of raise_info define the width of the vertical and horizontal edge of the effect.
</para>
</simpara>
</refsect1>
@@ -28,41 +28,41 @@
<varlistentry>
<term><parameter>width</parameter></term>
<listitem>
<para>
<simpara>
Width of the area to raise.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>height</parameter></term>
<listitem>
<para>
<simpara>
Height of the area to raise.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>x</parameter></term>
<listitem>
<para>
<simpara>
X coordinate.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y</parameter></term>
<listitem>
<para>
<simpara>
Y coordinate.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>raise</parameter></term>
<listitem>
<para>
<simpara>
A value other than zero creates a 3-D raise effect, otherwise it has a lowered effect.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -70,16 +70,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>

16
reference/gmagick/gmagick/read.xml
View File

@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>Gmagick</type><methodname>Gmagick::read</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Reads image from filename.
</para>
</simpara>
</refsect1>
@@ -24,9 +24,9 @@
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
<simpara>
The image filename.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,16 +34,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>

16
reference/gmagick/gmagick/readimage.xml
View File

@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>Gmagick</type><methodname>Gmagick::readimage</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Reads image from filename.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,9 +23,9 @@
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
<simpara>
The image filename.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -33,16 +33,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>

20
reference/gmagick/gmagick/readimageblob.xml
View File

@@ -13,9 +13,9 @@
<methodparam><type>string</type><parameter>imageContents</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Reads image from a binary string.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,17 +24,17 @@
<varlistentry>
<term><parameter>imageContents</parameter></term>
<listitem>
<para>
<simpara>
Content of image.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
<simpara>
The image filename.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -42,16 +42,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>

16
reference/gmagick/gmagick/readimagefile.xml
View File

@@ -13,9 +13,9 @@
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Reads an image or image sequence from an open file descriptor.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +24,9 @@
<varlistentry>
<term><parameter>fp</parameter></term>
<listitem>
<para>
<simpara>
The file descriptor.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,16 +34,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>

16
reference/gmagick/gmagick/reducenoiseimage.xml
View File

@@ -12,10 +12,10 @@
<modifier>public</modifier> <type>Gmagick</type><methodname>Gmagick::reducenoiseimage</methodname>
<methodparam><type>float</type><parameter>radius</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Smooths the contours of an image while still preserving edge information. The algorithm works by replacing each pixel with its neighbor closest in value. A neighbor is defined by radius.
Use a radius of 0 and <methodname>Gmagick::reducenoiseimage</methodname> selects a suitable radius for you.
</para>
</simpara>
</refsect1>
@@ -25,9 +25,9 @@
<varlistentry>
<term><parameter>radius</parameter></term>
<listitem>
<para>
<simpara>
The radius of the pixel neighborhood.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,16 +35,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>

20
reference/gmagick/gmagick/removeimage.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="gmagick.removeimage" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="gmagick.removeimage">
<refnamediv>
<refname>Gmagick::removeimage</refname>
<refpurpose>Removes an image from the image list</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>Gmagick</type><methodname>Gmagick::removeimage</methodname>
<void />
<void/>
</methodsynopsis>
<para>
Removes an image from the image list.
</para>
<simpara>
Removes an image from the image list.
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,20 +24,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The <classname>Gmagick</classname> object.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
&gmagick.gmagickexception.throw;
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

Some files were not shown because too many files have changed in this diff Show More