← Back to branch summary

~lfaraone/ubuntu/maverick/imagemagick/graphviz-rebuild

« back to all changes in this revision

Viewing changes to www/api/module.html

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2008-11-21 08:26:29 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20081121082629-iy01ycd87bs5fn2g
Tags: 7:6.4.5.4.dfsg1-1ubuntu1
* Merge with Debian; remaining changes:
  - (Build-)depend on libltdl7-dev instead of libltdl3-dev (the armel buildds
    currently have both available).

Show diffs side-by-side

added added

removed removed

Lines of Context:
www/api/module.html
12
12
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
13
13
  <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
14
14
  <meta name="Generator" content="PHP"/>
15
 
  <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, loadable, modules, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand"/>
 
15
  <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, loadable, modules, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject"/>
16
16
  <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.  ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems.  The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
17
17
  <meta name="Rating" content="GENERAL"/>
18
18
  <meta name="Robots" content="INDEX, FOLLOW"/>
29
29
  <table id="titlebar" style="width: 100%;background-color: #f5f5f5" cellpadding="0" cellspacing="0" border="0" summary="ImageMagick">
30
30
    <tbody>
31
31
      <tr valign="top">
32
 
        <td align="left"><a href="../../index.html"><img id="titlebar-west" src="../../images/script.png" alt="[ImageMagick]" width="350" height="60" border="0" vspace="28" name="titlebar-west"/></a></td>
33
 
        <td align="left"><a href="https://secure.networkredux.com/affiliate/idevaffiliate.html?id=146" target="442293865"><img id="titlebar-west" src="../../images/networkredux.png" alt="[sponsor]" border="0" vspace="45" name="titlebar-west"/></a></td>
 
32
        <td align="left"><a href="../../index.html"><img id="titlebar-west" src="../../images/script.png" alt="[ImageMagick]" width="350" height="60" vspace="28" name="titlebar-west"/></a></td>
 
33
        <td align="left"><a href="http://www.networkredux.com" target="321201121"><img id="titlebar-west" src="../../images/networkredux.png" alt="[sponsor]" border="0" vspace="45" name="titlebar-west"/></a></td>
34
34
        <td width="99%"><br /> </td>
35
35
        <td style="background-color: white" align="right"><a href="../../index.html"><img src="../../images/sprite.jpg" alt="" width="114" height="118" border="0" name="titlebar-east"/></a></td>
36
 
        <td style="background-color: white" align="right"><a href="http://www.imagemagick.org/discourse-server/" target="673628216"><img id="titlebar-east" src="../../images/logo.jpg" alt="" width="114" height="118" border="0" name="titlebar-east"/></a></td>
 
36
        <td style="background-color: white" align="right"><a href="http://www.imagemagick.org/discourse-server/" target="1854398400"><img id="titlebar-east" src="../../images/logo.jpg" alt="" width="114" height="118" border="0" name="titlebar-east"/></a></td>
37
37
      </tr>
38
38
    </tbody>
39
39
  </table>
44
44
    <tr valign="top" style="height: 100%;">
45
45
      <td id="menu" width="1%" height="100%">
46
46
      <p><a href="#main">Skip to page contents</a></p>
 
47
      <font size="-1">
47
48
      <span>[</span>
48
49
      <a href="../../index.html">About ImageMagick</a>
 
50
  <span>]</span><br /><span>[</span>
49
51
      <a href="../../www/command-line-tools.html">Command-line Tools</a>
50
52
      <a href="../../www/command-line-processing.html" class="sub">Processing</a>
51
53
      <a href="../../www/command-line-options.html" class="sub">Options</a>
52
 
      <a href="http://www.imagemagick.org/Usage/" target="1352754996" class="sub">Usage</a>
 
54
      <a href="http://www.imagemagick.org/Usage/" target="595344775" class="sub">Usage</a>
53
55
      <a href="../../www/api.html">Program Interfaces</a>
54
56
      <a href="../../www/magick-wand.html" class="sub">MagickWand</a>
55
57
      <a href="../../www/magick-core.html" class="sub">MagickCore</a>
56
58
      <a href="../../www/perl-magick.html" class="sub">PerlMagick</a>
57
 
      <a href="../../Magick++/" target="970089170" class="sub">Magick++</a>
 
59
      <a href="../../Magick++/" target="239356075" class="sub">Magick++</a>
58
60
      <a href="../../www/architecture.html">Architecture</a>
59
61
  <span>]</span><br /><span>[</span>
60
62
      <a href="../../www/install-source.html">Install from Source</a>
70
72
  <span>]</span><br /><span>[</span>
71
73
      <a href="../../www/sitemap.html">Site Map</a>
72
74
                        <a href="../../www/links.html" class="sub">Links</a>
73
 
  <span>]</span><br /><br /><span>[</span>
74
 
      <a href="../../www/sponsors.html">Sponsors</a>
75
 
  <a href="http://www.wbuch.de" class="sponsor" target="sponsor">Online Woerterbuch,<br />Rechtschreibpruefung</a><!-- 200803010000 -->
76
 
<br />
77
 
<a href="http://analogik.com"><img src="../../images/analogik.png" alt="[Electronic Music]" width="105" height="60" border="0" name="analogik"/></a> <!-- 200803030160 -->
 
75
  <span>]</span><br /><span>[</span>
 
76
      <a href="../../www/sponsors.html">Sponsors:</a>
 
77
      <fieldset>
 
78
  <a href="http://www.handyvertrag.net" class="sponsor" target="sponsor">Handyvertrag</a><!-- 200811010250 -->
 
79
      <br />
 
80
      <a href="http://meta-preisvergleich.de" class="sponsor" target="sponsor">Preisvergleich</a><!-- 200901010120 -->
 
81
      <br />
 
82
      <a href="http://www.checkcost.co.uk" class="sponsor" target="sponsor">Compare</a><!-- 200902010720 -->
 
83
      <br />
 
84
      <a href="http://www.ecostsoftware.com" class="sponsor" target="sponsor">Software</a><!-- 200902010720 -->
 
85
      <br />
 
86
      <a href="http://www.callerbase.com" class="sponsor" target="sponsor">Phone Number<br />Search</a><!-- 200812010040 -->
 
87
      <br />
 
88
      <a href="http://www.online-kredit-index.de" class="sponsor" target="sponsor">Kredit</a><!-- 200903010120 -->
 
89
      <br />
 
90
      <a href="http://www.posters555.com" class="sponsor" target="sponsor">Poster</a><!-- 200903010800 -->
 
91
      <br />
 
92
      <a href="http://www.iceposter.com" class="sponsor" target="sponsor">Posters</a><!-- 200812010200 -->
 
93
      <br />
 
94
      <a href="http://www.imade-art.de"><img src="../../images/imade_art2.jpg" alt="[Kunst bei imade-art]" width="116" height="28" border="0" name="Kunst bei imade-art"/></a> <!-- 200811010160 -->
 
95
      </fieldset>
78
96
      <span>]</span>
 
97
      </font>
79
98
      </td>
80
99
 
81
100
      <td id="main" valign="top">
82
 
<p class="navigation-index">[ <a href="#DestroyMagickList">DestroyMagickList</a> | <a href="#GetModuleInfo">GetModuleInfo</a> | <a href="#GetModuleInfoList">GetModuleInfoList</a> | <a href="#GetModuleList">GetModuleList</a> | <a href="#GetMagickModulePath">GetMagickModulePath</a> | <a href="#InvokeDynamicImageFilter">InvokeDynamicImageFilter</a> | <a href="#ListModuleInfo">ListModuleInfo</a> | <a href="#OpenModule">OpenModule</a> | <a href="#OpenModules">OpenModules</a> | <a href="#RegisterModule">RegisterModule</a> | <a href="#TagToCoderModuleName">TagToCoderModuleName</a> | <a href="#TagToFilterModuleName">TagToFilterModuleName</a> | <a href="#TagToModuleName">TagToModuleName</a> | <a href="#UnregisterModule">UnregisterModule</a> ]</p>
83
 
 
84
 
<div style="margin: auto;">
85
 
  <h2><a name="DestroyMagickList">DestroyMagickList</a></h2>
86
 
</div>
87
 
 
88
 
<p>DestroyMagickList() unregisters any previously loaded modules and exits the module loaded environment.</p></ol>
89
 
 
90
 
<p>The format of the DestroyMagickList module is:</p>
 
101
<p class="navigation-index">[ <a href="#AcquireModuleInfo">AcquireModuleInfo</a> | <a href="#DestroyModuleList">DestroyModuleList</a> | <a href="#GetModuleInfo">GetModuleInfo</a> | <a href="#GetModuleInfoList">GetModuleInfoList</a> | <a href="#GetModuleList">GetModuleList</a> | <a href="#GetMagickModulePath">GetMagickModulePath</a> | <a href="#InvokeDynamicImageFilter">InvokeDynamicImageFilter</a> | <a href="#ListModuleInfo">ListModuleInfo</a> | <a href="#OpenModule">OpenModule</a> | <a href="#OpenModules">OpenModules</a> | <a href="#RegisterModule">RegisterModule</a> | <a href="#TagToCoderModuleName">TagToCoderModuleName</a> | <a href="#TagToFilterModuleName">TagToFilterModuleName</a> | <a href="#TagToModuleName">TagToModuleName</a> | <a href="#UnregisterModule">UnregisterModule</a> ]</p>
 
102
 
 
103
<div style="margin: auto;">
 
104
  <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 
105
_8c.html" target="source" name="AcquireModuleInfo">AcquireModuleInfo</a></h2>
 
106
</div>
 
107
 
 
108
<p>AcquireModuleInfo() allocates the ModuleInfo structure.</p></ol>
 
109
 
 
110
<p>The format of the AcquireModuleInfo method is:</p>
 
111
 
 
112
<pre class="code">
 
113
  ModuleInfo *AcquireModuleInfo(const char *path,const char *tag)
 
114
</pre>
 
115
 
 
116
<p>A description of each parameter follows:</p></ol>
 
117
 
 
118
<h5>path</h5>
 
119
<ol><p>the path associated with the tag.</p></ol>
 
120
 
 
121
<h5>tag</h5>
 
122
<ol><p>a character string that represents the image format we are looking for.</p></ol>
 
123
 
 
124
<div style="margin: auto;">
 
125
  <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 
126
_8c.html" target="source" name="DestroyModuleList">DestroyModuleList</a></h2>
 
127
</div>
 
128
 
 
129
<p>DestroyModuleList() unregisters any previously loaded modules and exits the module loaded environment.</p></ol>
 
130
 
 
131
<p>The format of the DestroyModuleList module is:</p>
91
132
 
92
133
<pre class="text">
93
 
  void DestroyMagickList(void)
 
134
  void DestroyModuleList(void)
94
135
</pre>
95
136
 
96
137
<div style="margin: auto;">
97
 
  <h2><a name="GetModuleInfo">GetModuleInfo</a></h2>
 
138
  <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 
139
_8c.html" target="source" name="GetModuleInfo">GetModuleInfo</a></h2>
98
140
</div>
99
141
 
100
142
<p>GetModuleInfo() returns a pointer to a ModuleInfo structure that matches the specified tag.  If tag is NULL, the head of the module list is returned. If no modules are loaded, or the requested module is not found, NULL is returned.</p></ol>
114
156
<ol><p>Return any errors or warnings in this structure.</p></ol>
115
157
 
116
158
<div style="margin: auto;">
117
 
  <h2><a name="GetModuleInfoList">GetModuleInfoList</a></h2>
 
159
  <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 
160
_8c.html" target="source" name="GetModuleInfoList">GetModuleInfoList</a></h2>
118
161
</div>
119
162
 
120
163
<p>GetModuleInfoList() returns any modules that match the specified pattern.</p></ol>
138
181
<ol><p>Return any errors or warnings in this structure.</p></ol>
139
182
 
140
183
<div style="margin: auto;">
141
 
  <h2><a name="GetModuleList">GetModuleList</a></h2>
 
184
  <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 
185
_8c.html" target="source" name="GetModuleList">GetModuleList</a></h2>
142
186
</div>
143
187
 
144
188
<p>GetModuleList() returns any image format modules that match the specified pattern.</p></ol>
162
206
<ol><p>Return any errors or warnings in this structure.</p></ol>
163
207
 
164
208
<div style="margin: auto;">
165
 
  <h2><a name="GetMagickModulePath">GetMagickModulePath</a></h2>
 
209
  <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 
210
_8c.html" target="source" name="GetMagickModulePath">GetMagickModulePath</a></h2>
166
211
</div>
167
212
 
168
213
<p>GetMagickModulePath() finds a module with the specified module type and filename.</p></ol>
177
222
<p>A description of each parameter follows:</p></ol>
178
223
 
179
224
<h5>filename</h5>
180
 
<ol><p>The module file name.</p></ol>
 
225
<ol><p>the module file name.</p></ol>
181
226
 
182
227
<h5>module_type</h5>
183
 
<ol><p>The module type: MagickImageCoderModule or MagickImageFilterModule.</p></ol>
 
228
<ol><p>the module type: MagickImageCoderModule or MagickImageFilterModule.</p></ol>
184
229
 
185
230
<h5>path</h5>
186
 
<ol><p>The path associated with the filename.</p></ol>
 
231
<ol><p>the path associated with the filename.</p></ol>
187
232
 
188
233
<h5>exception</h5>
189
234
<ol><p>Return any errors or warnings in this structure.</p></ol>
190
235
 
191
236
<div style="margin: auto;">
192
 
  <h2><a name="InvokeDynamicImageFilter">InvokeDynamicImageFilter</a></h2>
 
237
  <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 
238
_8c.html" target="source" name="InvokeDynamicImageFilter">InvokeDynamicImageFilter</a></h2>
193
239
</div>
194
240
 
195
241
<p>InvokeDynamicImageFilter() invokes a dynamic image filter.</p></ol>
207
253
<ol><p>a character string that represents the name of the particular module.</p></ol>
208
254
 
209
255
<h5>image</h5>
210
 
<ol><p>The image.</p></ol>
 
256
<ol><p>the image.</p></ol>
211
257
 
212
258
<h5>argc</h5>
213
 
<ol><p>Specifies a pointer to an integer describing the number of elements in the argument vector.</p></ol>
 
259
<ol><p>a pointer to an integer describing the number of elements in the argument vector.</p></ol>
214
260
 
215
261
<h5>argv</h5>
216
 
<ol><p>Specifies a pointer to a text array containing the command line arguments.</p></ol>
 
262
<ol><p>a pointer to a text array containing the command line arguments.</p></ol>
217
263
 
218
264
<h5>exception</h5>
219
 
<ol><p>Return any errors or warnings in this structure.</p></ol>
 
265
<ol><p>return any errors or warnings in this structure.</p></ol>
220
266
 
221
267
<div style="margin: auto;">
222
 
  <h2><a name="ListModuleInfo">ListModuleInfo</a></h2>
 
268
  <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 
269
_8c.html" target="source" name="ListModuleInfo">ListModuleInfo</a></h2>
223
270
</div>
224
271
 
225
272
<p>ListModuleInfo() lists the module info to a file.</p></ol>
239
286
<ol><p>Return any errors or warnings in this structure.</p></ol>
240
287
 
241
288
<div style="margin: auto;">
242
 
  <h2><a name="OpenModule">OpenModule</a></h2>
 
289
  <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 
290
_8c.html" target="source" name="OpenModule">OpenModule</a></h2>
243
291
</div>
244
292
 
245
293
<p>OpenModule() loads a module, and invokes its registration module.  It returns MagickTrue on success, and MagickFalse if there is an error.</p></ol>
259
307
<ol><p>Return any errors or warnings in this structure.</p></ol>
260
308
 
261
309
<div style="margin: auto;">
262
 
  <h2><a name="OpenModules">OpenModules</a></h2>
 
310
  <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 
311
_8c.html" target="source" name="OpenModules">OpenModules</a></h2>
263
312
</div>
264
313
 
265
314
<p>OpenModules() loads all available modules.</p></ol>
276
325
<ol><p>Return any errors or warnings in this structure.</p></ol>
277
326
 
278
327
<div style="margin: auto;">
279
 
  <h2><a name="RegisterModule">RegisterModule</a></h2>
 
328
  <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 
329
_8c.html" target="source" name="RegisterModule">RegisterModule</a></h2>
280
330
</div>
281
331
 
282
332
<p>RegisterModule() adds an entry to the module list.  It returns a pointer to the registered entry on success.</p></ol>
300
350
<ol><p>Return any errors or warnings in this structure.</p></ol>
301
351
 
302
352
<div style="margin: auto;">
303
 
  <h2><a name="TagToCoderModuleName">TagToCoderModuleName</a></h2>
 
353
  <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 
354
_8c.html" target="source" name="TagToCoderModuleName">TagToCoderModuleName</a></h2>
304
355
</div>
305
356
 
306
 
<p>TagToCoderModuleName() munges a module tag and obtains the filename of the corresponding module module.</p></ol>
 
357
<p>TagToCoderModuleName() munges a module tag and obtains the filename of the corresponding module.</p></ol>
307
358
 
308
359
<p>The format of the TagToCoderModuleName module is:</p>
309
360
 
317
368
<ol><p>a character string representing the module tag.</p></ol>
318
369
 
319
370
<h5>name</h5>
320
 
<ol><p>return the module module name here.</p></ol>
 
371
<ol><p>return the module name here.</p></ol>
321
372
 
322
373
<div style="margin: auto;">
323
 
  <h2><a name="TagToFilterModuleName">TagToFilterModuleName</a></h2>
 
374
  <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 
375
_8c.html" target="source" name="TagToFilterModuleName">TagToFilterModuleName</a></h2>
324
376
</div>
325
377
 
326
378
<p>TagToFilterModuleName() munges a module tag and returns the filename of the corresponding filter module.</p></ol>
340
392
<ol><p>return the filter name here.</p></ol>
341
393
 
342
394
<div style="margin: auto;">
343
 
  <h2><a name="TagToModuleName">TagToModuleName</a></h2>
 
395
  <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 
396
_8c.html" target="source" name="TagToModuleName">TagToModuleName</a></h2>
344
397
</div>
345
398
 
346
399
<p>TagToModuleName() munges the module tag name and returns an upper-case tag name as the input string, and a user-provided format.</p></ol>
363
416
<ol><p>pointer to a destination buffer for the formatted result.</p></ol>
364
417
 
365
418
<div style="margin: auto;">
366
 
  <h2><a name="UnregisterModule">UnregisterModule</a></h2>
 
419
  <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 
420
_8c.html" target="source" name="UnregisterModule">UnregisterModule</a></h2>
367
421
</div>
368
422
 
369
423
<p>UnregisterModule() unloads a module, and invokes its de-registration module. Returns MagickTrue on success, and MagickFalse if there is an error.</p></ol>
378
432
<p>A description of each parameter follows:</p></ol>
379
433
 
380
434
<h5>module_info</h5>
381
 
<ol><p>The module info.</p></ol>
 
435
<ol><p>the module info.</p></ol>
382
436
 
383
437
<h5>exception</h5>
384
438
<ol><p>Return any errors or warnings in this structure.</p></ol>
389
443
  </tbody>
390
444
  </table>
391
445
  <div id="linkbar">
392
 
    <a href="http://www.imagemagick.org/discourse-server/" target="576914550">Discourse Server</a> &bull;
393
 
    <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
394
 
    <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi" target="833542776">ImageMagick Studio</a>
 
446
    <span id="linkbar-west">
 
447
      <font size="-1">
 
448
      </font>
 
449
    </span>
 
450
    <span id="linkbar-center">
 
451
      <a href="http://www.imagemagick.org/discourse-server/" target="1746446089">Discourse Server</a> &bull;
 
452
      <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
 
453
      <a href="http://cafe.imagemagick.org" target="170838857">Cafe</a> &bull;
 
454
    <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi" target="1350938021">Studio</a>
 
455
    </span>
 
456
    <span id="linkbar-east">
 
457
      <font size="-1">
 
458
      </font>
 
459
    </span>
395
460
  </div>
396
461
  <div id="footer">
397
462
    <span id="footer-west">&copy; 1999-2008 ImageMagick Studio LLC</span>