1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta content="en" name="language">
<title>Magick++ API for GraphicsMagick</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link media="screen" href="../docutils-articles.css" type="text/css" rel="stylesheet">
</head>
<body>
<div class="banner">
<img src="../images/gm-107x76.png" alt="GraphicMagick logo" width="107" height="76" />
<span class="title">GraphicsMagick</span>
<form action="http://www.google.com/search">
<input type="hidden" name="domains" value="www.graphicsmagick.org" />
<input type="hidden" name="sitesearch" value="www.graphicsmagick.org" />
<span class="nowrap"><input type="text" name="q" size="25" maxlength="255" /> <input type="submit" name="sa" value="Search" /></span>
</form>
</div>
<div class="navmenu">
<ul>
<li><a href="../index.html">Home</a></li>
<li><a href="../project.html">Project</a></li>
<li><a href="../download.html">Download</a></li>
<li><a href="../README.html">Install</a></li>
<li><a href="../Hg.html">Source</a></li>
<li><a href="../NEWS.html">News</a> </li>
<li><a href="../utilities.html">Utilities</a></li>
<li><a href="../programming.html">Programming</a></li>
<li><a href="../reference.html">Reference</a></li>
</ul>
</div>
<main id="magick-api-for-graphicsmagick">
<h1 class="title">Magick++ API for GraphicsMagick</h1>
<!-- -*- mode: rst -*- -->
<!-- This text is in reStucturedText format, so it may look a bit odd. -->
<!-- See http://docutils.sourceforge.net/rst.html for details. -->
<div class="contents topic" id="contents">
<p class="topic-title">Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#introduction" id="id1">Introduction</a></p></li>
<li><p><a class="reference internal" href="#api" id="id2">API</a></p></li>
<li><p><a class="reference internal" href="#obtaining-magick" id="id3">Obtaining Magick++</a></p></li>
<li><p><a class="reference internal" href="#installation" id="id4">Installation</a></p></li>
<li><p><a class="reference internal" href="#usage" id="id5">Usage</a></p></li>
<li><p><a class="reference internal" href="#reporting-bugs" id="id6">Reporting Bugs</a></p></li>
</ul>
</div>
<section id="introduction">
<h1><a class="toc-backref" href="#id1">Introduction</a></h1>
<p><em>Magick++</em> is the object-oriented C++ API to the <a class="reference external" href="../index.html">GraphicsMagick</a>
image-processing library, the most comprehensive open-source image
processing package available. Read the <a class="reference external" href="ChangeLog.html">ChangeLog</a> for <em>Magick++</em>.</p>
<p><em>Magick++</em> supports an object model which is inspired by <a class="reference external" href="../perl.html">PerlMagick</a>.
Images support implicit reference counting so that copy constructors and
assignment incur almost no cost. The cost of actually copying an image
(if necessary) is done just before modification and this copy is managed
automatically by <em>Magick++</em>. De-referenced copies are automatically
deleted. The image objects support value (rather than pointer) semantics
so it is trivial to support multiple generations of an image in memory at
one time.</p>
<p><em>Magick++</em> provides integrated support for the Standard Template
Library (STL) which is part of the standard C++ language so that
the powerful containers available (e.g. deque, vector, list, and
map) can be used to write programs similar to those possible with
PERL & <a class="reference external" href="../perl.html">PerlMagick</a>. STL-compatible template versions of
GraphicsMagick's list-style operations are provided so that operations
may be performed on multiple images stored in STL containers.</p>
</section>
<section id="api">
<h1><a class="toc-backref" href="#id2">API</a></h1>
<p><em>Magick++</em> provides a simple C++ API to the GraphicsMagick image
processing library which supports reading and writing a huge number of
image formats as well as supporting a broad spectrum of traditional image
processing operations. The GraphicsMagick C API is complex and the data
structures are not well documented. <em>Magick++</em> provides access to most of
the features available from the C API but in a simple object-oriented and
well-documented framework.</p>
<p><em>Magick++</em> is intended to support commercial-grade application
development. In order to avoid possible conflicts with the user's
application, all symbols contained in <em>Magick++</em> (included by the header
<Magick++.h>) are scoped to the namespace Magick. Symbols from the
GraphicsMagick C library are imported under the MagickLib namespace to
avoid possible conflicts and GraphicsMagick macros are only included
within the <em>Magick++</em> implementation so they won't impact the user's
application.</p>
<p>The InitializeMagick() function <em>MUST</em> be invoked before constructing
any Magick++ objects. This used to be optional, but now it is
absolutely required. This function initalizes semaphores and
configuration information necessary for the software to work
correctly. Failing to invoke InitializeMagick() is likely to lead to
a program crash or thrown assertion. If the program resides in the
same directory as the GraphicsMagick files, then argv[0] may be passed
as an argument so that GraphicsMagick knows where its files reside,
otherwise NULL may be passed and GraphicsMagick will try to use other
means (if necessary).</p>
<p>The core class in <em>Magick++</em> is the <a class="reference external" href="Image.html">Image</a> class. The <a class="reference external" href="Image.html">Image</a> class
provides methods to manipulate a single image frame (e.g. a JPEG image).
Standard Template Library (<a class="reference external" href="STL.html">STL</a>) compatible algorithms and function
objects are provided in order to manipulate multiple image frames or to
read and write file formats which support multiple image frames (e.g. GIF
animations, MPEG animations, and Postscript files).</p>
<p>The <a class="reference external" href="Image.html">Image</a> class supports reference-counted memory management which
supports the semantics of an intrinsic variable type (e.g. 'int') with an
extremely efficient operator = and copy constructor (only a pointer is
assigned) while ensuring that the image data is replicated as required so
that it the image may be modified without impacting earlier generations.
Since the <a class="reference external" href="Image.html">Image</a> class manages heap memory internally, images are best
allocated via C++ automatic (stack-based) memory allocation. This support
allows most programs using <em>Magick++</em> to be written without using any
pointers, simplifying the implementation and avoiding the risks of using
pointers. When a program uses automatic memory allocation to allocate
<em>Magick++</em> images, that aspect of the program becomes naturally
exception-safe and thread-safe.</p>
<p>The image class uses a number of supportive classes in order to specify
arguments. Colors are specified via the <a class="reference external" href="Color.html">Color</a> class. Colors specified
in X11-style string form are implicitly converted to the <a class="reference external" href="Color.html">Color</a> class.
Geometry arguments (those specifying width, height, and/or x and y
offset) are specified via the <a class="reference external" href="Geometry.html">Geometry</a> class. Similar to the <a class="reference external" href="Color.html">Color</a>
class, geometries specified as an X11-style string are implicitly
converted to the <a class="reference external" href="Geometry.html">Geometry</a> class. Two dimensional drawable objects are
specified via the <a class="reference external" href="Drawable.html">Drawable</a> class. Drawable objects may be provided as
a single object or as a list of objects to be rendered using the current
image options. <a class="reference external" href="Montage.html">Montage</a> options (a montage is a rendered grid of
thumbnails in one image) are specified via the <a class="reference external" href="Montage.html">Montage</a> class.</p>
<p>Errors are reported using C++ exceptions derived from the <a class="reference external" href="Exception.html">Exception</a>
class, which is itself derived from the standard C++ exception class.
Exceptions are reported synchronous with the operation and are caught by
the first matching try block as the stack is unraveled. This allows a
clean coding style in which multiple related <em>Magick++</em> commands may be
executed with errors handled as a unit rather than line-by-line. Since
the <a class="reference external" href="Image.html">Image</a> object provides reference-counted memory management,
unreferenced images on the stack are automatically cleaned up, avoiding
the potential for memory leaks.</p>
<p>For ease of access, the documentation for the available user-level
classes is available via the following table:</p>
<table>
<caption><em>Magick++</em> User-Level Classes</caption>
<colgroup>
<col style="width: 18%" />
<col style="width: 82%" />
</colgroup>
<tbody>
<tr><td><p><a class="reference external" href="Blob.html">Blob</a></p></td>
<td><p>Binary Large OBject container.</p></td>
</tr>
<tr><td><p><a class="reference external" href="CoderInfo.html">CoderInfo</a></p></td>
<td><p>Report information about supported image formats (use with
<a class="reference external" href="STL.html#coderInfoList">coderInfoList</a>())</p></td>
</tr>
<tr><td><p><a class="reference external" href="Color.html">Color</a></p></td>
<td><p>Color specification.</p></td>
</tr>
<tr><td><p><a class="reference external" href="Drawable.html">Drawable</a></p></td>
<td><p>Drawable shape (for input to 'draw').</p></td>
</tr>
<tr><td><p><a class="reference external" href="Exception.html">Exception</a></p></td>
<td><p>C++ exception objects.</p></td>
</tr>
<tr><td><p><a class="reference external" href="Geometry.html">Geometry</a></p></td>
<td><p>Geometry specification.</p></td>
</tr>
<tr><td><p><a class="reference external" href="Image.html">Image</a></p></td>
<td><p>Image frame. This is the primary object in <em>Magick++</em>.</p></td>
</tr>
<tr><td><p><a class="reference external" href="Montage.html">Montage</a></p></td>
<td><p>Montage options for montageImages().</p></td>
</tr>
<tr><td><p><a class="reference external" href="Pixels.html">Pixels</a></p></td>
<td><p>Low-level access to image pixels.</p></td>
</tr>
<tr><td><p><a class="reference external" href="STL.html">STL</a></p></td>
<td><p>STL algorithms and function objects for operating on
containers of image frames.</p></td>
</tr>
<tr><td><p><a class="reference external" href="TypeMetric.html">TypeMetric</a></p></td>
<td><p>Container for font type metrics (use with
<a class="reference external" href="Image.html#fonttypemetrics">Image::fontTypeMetrics</a>).</p></td>
</tr>
</tbody>
</table>
</section>
<section id="obtaining-magick">
<h1><a class="toc-backref" href="#id3">Obtaining Magick++</a></h1>
<p><em>Magick++</em> is included as part of <a class="reference external" href="../index.html">GraphicsMagick</a> source releases and may
be retrieved via <a class="reference external" href="../download.html">ftp</a> or <a class="reference external" href="../Hg.html">Mercurial</a>.</p>
</section>
<section id="installation">
<h1><a class="toc-backref" href="#id4">Installation</a></h1>
<p>Installation is very easy since <em>Magick++</em> is part of <a class="reference external" href="../index.html">GraphicsMagick</a> and
is built by default. Once <a class="reference external" href="../index.html">GraphicsMagick</a> is built, then <em>Magick++</em> is
available for use.</p>
</section>
<section id="usage">
<h1><a class="toc-backref" href="#id5">Usage</a></h1>
<p>A helper script named <em>GraphicsMagick++-config</em> is installed in the same
directory as the GraphicsMagick <em>gm</em> program under Unix which assists
with recalling compilation options required to compile and link programs
which depend on <em>Magick++</em>. For example, the following command will
compile and link the source file example.cpp to produce the executable
example (notice that quotes are backward quotes):</p>
<pre class="literal-block">c++ -o example example.cpp `GraphicsMagick++-config --cppflags --cxxflags
--ldflags --libs`</pre>
<p>Windows users may get started by manually editing a project file for one
of the <em>Magick++</em> demo programs.</p>
<p>It is necessary to initialize the GraphicsMagick library prior to
using the <em>Magick++</em> library. This initialization is performed by
passing the path to the GraphicsMagick DLLs (assumed to be in the same
directory as your program) to the InitializeMagick() function
call. This is commonly performed by providing the path to your program
(argv[0]) as shown in the following example:</p>
<pre class="literal-block">int main( int /*argc*/, char ** argv)
{
InitializeMagick(*argv);</pre>
<p>If you don't have the path to your executable, then pass NULL and
usually the library will be found anyway. Besides helping to find the
GraphicsMagick DLL/library and configuration files, InitializeMagick()
initializes all of the semaphores and data necessary for a
multi-threaded program to be completely thread safe. This step used
to be optional, but it is now absolutely required. Failure to
initialize GraphicsMagick will result in an application crash.</p>
</section>
<section id="reporting-bugs">
<h1><a class="toc-backref" href="#id6">Reporting Bugs</a></h1>
<p>Please report any bugs via the <a class="reference external" href="http://sourceforge.net/projects/graphicsmagick/">GraphicsMagick Bug Tracker</a>. Questions
regarding usage should be directed to <a class="reference external" href="mailto:bfriesen%40simple.dallas.tx.us">Bob Friesenhahn</a>.</p>
<p>Copyright © Bob Friesenhahn 1999 - 2022</p>
</section>
</main>
<hr class="docutils">
<div class="document">
<p><a href="../Copyright.html">Copyright</a> © GraphicsMagick Group 2002-2025<!--SPONSOR_LOGO--></p>
</div>
</main>
</body>
</html>
|
