]> granicus.if.org Git - imagemagick/blob - www/api/module.html
(no commit message)
[imagemagick] / www / api / module.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\r
4 <head>\r
5   <meta http-equiv="Content-Type" value="application/xhtml+xml" />\r
6   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
7   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
8   <style type="text/css" media="screen,projection"><!--\r
9     @import url("../../www/magick.css");\r
10   --></style>\r
11   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
12   <title>ImageMagick: MagickCore, C API for ImageMagick: Loadable Modules</title>
13   <meta http-equiv="Content-Language" content="en-US"/>
14   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
15   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
16   <meta name="Generator" content="PHP"/>
17   <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, Swiss, Army, Knife, Image, Processing"/>
18   <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."/>
19   <meta name="Rating" content="GENERAL"/>
20   <meta name="Robots" content="INDEX, FOLLOW"/>
21   <meta name="Generator" content="ImageMagick Studio LLC"/>
22   <meta name="Author" content="ImageMagick Studio LLC"/>
23   <meta name="Revisit-after" content="2 DAYS"/>
24   <meta name="Resource-type" content="document"/>
25   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
26   <meta name="Distribution" content="Global"/>
27 </head>\r
28 \r
29 <body id="www-imagemagick-org">\r
30 <div class="titlebar">\r
31 <a href="../../index.html">\r
32   <img src="../../images/script.png" alt="[ImageMagick]"\r
33   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
34 <a href="http://www.networkredux.com">\r
35   <img src="../../images/networkredux.png" alt="[sponsor]"\r
36   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
37 <a href="http://www.imagemagick.org/discourse-server/">\r
38   <img src="../../images/logo.jpg" alt=""\r
39   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
40 <a href="../../index.html">\r
41   <img src="../../images/sprite.jpg" alt=""\r
42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
43 </div>\r
44 \r
45 <div class="eastbar">\r
46 \r
47 <div class="menu">
48   <a href="../../index.html">About ImageMagick</a>
49 </div>
50 <div class="sep"></div>\r
51 <div class="menu">
52   <a href="../../www/command-line-tools.html">Command-line Tools</a>
53 </div>
54 <div class="sub">
55     <a href="../../www/command-line-processing.html">Processing</a>
56 </div>
57 <div class="sub">
58     <a href="../../www/command-line-options.html">Options</a>
59 </div>
60 <div class="sub">
61     <a href="http://www.imagemagick.org/Usage/">Usage</a>
62 </div>
63 <div class="menu">
64   <a href="../../www/api.html">Program Interfaces</a>
65 </div>
66 <div class="sub">
67     <a href="../../www/magick-wand.html">MagickWand</a>
68 </div>
69 <div class="sub">
70     <a href="../../www/magick-core.html">MagickCore</a>
71 </div>
72 <div class="sub">
73     <a href="../../www/perl-magick.html">PerlMagick</a>
74 </div>
75 <div class="sub">
76     <a href="../../Magick++/">Magick++</a>
77 </div>
78 <div class="menu">
79   <a href="../../www/architecture.html">Architecture</a>
80 </div>
81 <div class="sep"></div>\r
82 <div  class="menu">
83    <a href="../../www/install-source.html">Install from Source</a>
84 </div>
85 <div class="sub">
86     <a href="../../www/install-source.html#unix">Unix</a>
87 </div>
88 <div class="sub">
89     <a href="../../www/install-source.html#windows">Windows</a>
90  </div>
91 <div class="menu">
92   <a href="../../www/binary-releases.html">Binary Releases</a>
93 </div>
94 <div class="sub">
95     <a href="../../www/binary-releases.html#unix">Unix</a>
96 </div>
97 <div class="sub">
98     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
99 </div>
100 <div class="sub">
101     <a href="../../www/binary-releases.html#windows">Windows</a>
102 </div>
103 <div class="menu">
104   <a href="../../www/resources.html">Resources</a>
105 </div>
106 <div class="sep"></div>\r
107 <div class="menu">
108   <a href="../../www/download.html">Download</a>
109 </div>
110 <div class="sep"></div>\r
111 <div class="menu">
112   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
113 </div>
114 <div class="sep"></div>\r
115 <div class="menu">
116   <a href="../../www/sitemap.html">Site Map</a>
117 </div>
118 <div  class="sub">
119     <a href="../../www/links.html">Links</a>
120 </div>
121 <div class="sep"></div>\r
122 <div  class="menu">
123   <a href="../../www/sponsors.html">Sponsors:</a>
124
125 <div class="sponsbox">
126 <div  class="sponsor">
127    <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20101101000200 -->
128 </div>
129 <div  class="sponsor">
130   <a href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
131 </div>
132 <div  class="sponsor">
133   <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
134 </div>
135 <div  class="sponsor">
136   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
137 </div>
138 <div  class="sponsor">
139   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
140 </div>
141 <div  class="sponsor">
142   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
143 </div>
144 <div  class="sponsor">
145    <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
146 </div>
147 <div  class="sponsor">
148    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
149 </div>
150 </div>
151 </div>
152 \r
153 \r
154 </div>\r
155 \r
156 <div class="main">\r
157 \r
158 <p class="navigation-index">[<a href="#AcquireModuleInfo">AcquireModuleInfo</a> &bull; <a href="#DestroyModuleList">DestroyModuleList</a> &bull; <a href="#GetModuleInfo">GetModuleInfo</a> &bull; <a href="#GetModuleInfoList">GetModuleInfoList</a> &bull; <a href="#GetModuleList">GetModuleList</a> &bull; <a href="#GetMagickModulePath">GetMagickModulePath</a> &bull; <a href="#InitializeModuleList">InitializeModuleList</a> &bull; <a href="#InvokeDynamicImageFilter">InvokeDynamicImageFilter</a> &bull; <a href="#ListModuleInfo">ListModuleInfo</a> &bull; <a href="#OpenModule">OpenModule</a> &bull; <a href="#OpenModules">OpenModules</a> &bull; <a href="#RegisterModule">RegisterModule</a> &bull; <a href="#TagToCoderModuleName">TagToCoderModuleName</a> &bull; <a href="#TagToFilterModuleName">TagToFilterModuleName</a> &bull; <a href="#TagToModuleName">TagToModuleName</a> &bull; <a href="#UnregisterModule">UnregisterModule</a>]</p>
159
160 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
161 _8c.html" target="source" name="AcquireModuleInfo">AcquireModuleInfo</a></h2>
162 <div class="doc-section">
163
164 <p>AcquireModuleInfo() allocates the ModuleInfo structure.</p></ol>
165
166 <p>The format of the AcquireModuleInfo method is:</p>
167
168 <pre class="code">
169   ModuleInfo *AcquireModuleInfo(const char *path,const char *tag)
170 </pre>
171
172 <p>A description of each parameter follows:</p></ol>
173
174 <h5>path</h5>
175 <ol><p>the path associated with the tag.</p></ol>
176
177 <h5>tag</h5>
178 <ol><p>a character string that represents the image format we are looking for.</p></ol>
179
180  </div>
181 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
182 _8c.html" target="source" name="DestroyModuleList">DestroyModuleList</a></h2>
183 <div class="doc-section">
184
185 <p>DestroyModuleList() unregisters any previously loaded modules and exits the module loaded environment.</p></ol>
186
187 <p>The format of the DestroyModuleList module is:</p>
188
189 <pre class="text">
190   void DestroyModuleList(void)
191 </pre>
192
193  </div>
194 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
195 _8c.html" target="source" name="GetModuleInfo">GetModuleInfo</a></h2>
196 <div class="doc-section">
197
198 <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>
199
200 <p>The format of the GetModuleInfo module is:</p>
201
202 <pre class="text">
203   ModuleInfo *GetModuleInfo(const char *tag,ExceptionInfo *exception)
204 </pre>
205
206 <p>A description of each parameter follows:</p></ol>
207
208 <h5>tag</h5>
209 <ol><p>a character string that represents the image format we are looking for.</p></ol>
210
211 <h5>exception</h5>
212 <ol><p>return any errors or warnings in this structure.</p></ol>
213
214  </div>
215 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
216 _8c.html" target="source" name="GetModuleInfoList">GetModuleInfoList</a></h2>
217 <div class="doc-section">
218
219 <p>GetModuleInfoList() returns any modules that match the specified pattern.</p></ol>
220
221 <p>The format of the GetModuleInfoList function is:</p>
222
223 <pre class="text">
224   const ModuleInfo **GetModuleInfoList(const char *pattern,
225     unsigned long *number_modules,ExceptionInfo *exception)
226 </pre>
227
228 <p>A description of each parameter follows:</p></ol>
229
230 <h5>pattern</h5>
231 <ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
232
233 <h5>number_modules</h5>
234 <ol><p>This integer returns the number of modules in the list.</p></ol>
235
236 <h5>exception</h5>
237 <ol><p>return any errors or warnings in this structure.</p></ol>
238
239  </div>
240 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
241 _8c.html" target="source" name="GetModuleList">GetModuleList</a></h2>
242 <div class="doc-section">
243
244 <p>GetModuleList() returns any image format modules that match the specified pattern.</p></ol>
245
246 <p>The format of the GetModuleList function is:</p>
247
248 <pre class="text">
249   char **GetModuleList(const char *pattern,unsigned long *number_modules,
250     ExceptionInfo *exception)
251 </pre>
252
253 <p>A description of each parameter follows:</p></ol>
254
255 <h5>pattern</h5>
256 <ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
257
258 <h5>number_modules</h5>
259 <ol><p>This integer returns the number of modules in the list.</p></ol>
260
261 <h5>exception</h5>
262 <ol><p>return any errors or warnings in this structure.</p></ol>
263
264  </div>
265 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
266 _8c.html" target="source" name="GetMagickModulePath">GetMagickModulePath</a></h2>
267 <div class="doc-section">
268
269 <p>GetMagickModulePath() finds a module with the specified module type and filename.</p></ol>
270
271 <p>The format of the GetMagickModulePath module is:</p>
272
273 <pre class="text">
274   MagickBooleanType GetMagickModulePath(const char *filename,
275     MagickModuleType module_type,char *path,ExceptionInfo *exception)
276 </pre>
277
278 <p>A description of each parameter follows:</p></ol>
279
280 <h5>filename</h5>
281 <ol><p>the module file name.</p></ol>
282
283 <h5>module_type</h5>
284 <ol><p>the module type: MagickImageCoderModule or MagickImageFilterModule.</p></ol>
285
286 <h5>path</h5>
287 <ol><p>the path associated with the filename.</p></ol>
288
289 <h5>exception</h5>
290 <ol><p>return any errors or warnings in this structure.</p></ol>
291
292  </div>
293 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
294 _8c.html" target="source" name="InitializeModuleList">InitializeModuleList</a></h2>
295 <div class="doc-section">
296
297 <p>InitializeModuleList() initializes the module loader.</p></ol>
298
299 <p>The format of the InitializeModuleList() method is:</p>
300
301 <pre class="code">
302   InitializeModuleList(Exceptioninfo *exception)
303 </pre>
304
305 <p>A description of each parameter follows.</p></ol>
306
307 <h5>exception</h5>
308 <ol><p>return any errors or warnings in this structure.</p></ol>
309
310  </div>
311 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
312 _8c.html" target="source" name="InvokeDynamicImageFilter">InvokeDynamicImageFilter</a></h2>
313 <div class="doc-section">
314
315 <p>InvokeDynamicImageFilter() invokes a dynamic image filter.</p></ol>
316
317 <p>The format of the InvokeDynamicImageFilter module is:</p>
318
319 <pre class="text">
320   MagickBooleanType InvokeDynamicImageFilter(const char *tag,Image **image,
321     const int argc,const char **argv,ExceptionInfo *exception)
322 </pre>
323
324 <p>A description of each parameter follows:</p></ol>
325
326 <h5>tag</h5>
327 <ol><p>a character string that represents the name of the particular module.</p></ol>
328
329 <h5>image</h5>
330 <ol><p>the image.</p></ol>
331
332 <h5>argc</h5>
333 <ol><p>a pointer to an integer describing the number of elements in the argument vector.</p></ol>
334
335 <h5>argv</h5>
336 <ol><p>a pointer to a text array containing the command line arguments.</p></ol>
337
338 <h5>exception</h5>
339 <ol><p>return any errors or warnings in this structure.</p></ol>
340
341  </div>
342 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
343 _8c.html" target="source" name="ListModuleInfo">ListModuleInfo</a></h2>
344 <div class="doc-section">
345
346 <p>ListModuleInfo() lists the module info to a file.</p></ol>
347
348 <p>The format of the ListModuleInfo module is:</p>
349
350 <pre class="text">
351   MagickBooleanType ListModuleInfo(FILE *file,ExceptionInfo *exception)
352 </pre>
353
354 <p>A description of each parameter follows.</p></ol>
355
356 <h5>file</h5>
357 <ol><p>An pointer to a FILE.</p></ol>
358
359 <h5>exception</h5>
360 <ol><p>return any errors or warnings in this structure.</p></ol>
361
362  </div>
363 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
364 _8c.html" target="source" name="OpenModule">OpenModule</a></h2>
365 <div class="doc-section">
366
367 <p>OpenModule() loads a module, and invokes its registration module.  It returns MagickTrue on success, and MagickFalse if there is an error.</p></ol>
368
369 <p>The format of the OpenModule module is:</p>
370
371 <pre class="text">
372   MagickBooleanType OpenModule(const char *module,ExceptionInfo *exception)
373 </pre>
374
375 <p>A description of each parameter follows:</p></ol>
376
377 <h5>module</h5>
378 <ol><p>a character string that indicates the module to load.</p></ol>
379
380 <h5>exception</h5>
381 <ol><p>return any errors or warnings in this structure.</p></ol>
382
383  </div>
384 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
385 _8c.html" target="source" name="OpenModules">OpenModules</a></h2>
386 <div class="doc-section">
387
388 <p>OpenModules() loads all available modules.</p></ol>
389
390 <p>The format of the OpenModules module is:</p>
391
392 <pre class="text">
393   MagickBooleanType OpenModules(ExceptionInfo *exception)
394 </pre>
395
396 <p>A description of each parameter follows:</p></ol>
397
398 <h5>exception</h5>
399 <ol><p>return any errors or warnings in this structure.</p></ol>
400
401  </div>
402 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
403 _8c.html" target="source" name="RegisterModule">RegisterModule</a></h2>
404 <div class="doc-section">
405
406 <p>RegisterModule() adds an entry to the module list.  It returns a pointer to the registered entry on success.</p></ol>
407
408 <p>The format of the RegisterModule module is:</p>
409
410 <pre class="text">
411   ModuleInfo *RegisterModule(const ModuleInfo *module_info,
412     ExceptionInfo *exception)
413 </pre>
414
415 <p>A description of each parameter follows:</p></ol>
416
417 <h5>info</h5>
418 <ol><p>a pointer to the registered entry is returned.</p></ol>
419
420 <h5>module_info</h5>
421 <ol><p>a pointer to the ModuleInfo structure to register.</p></ol>
422
423 <h5>exception</h5>
424 <ol><p>return any errors or warnings in this structure.</p></ol>
425
426  </div>
427 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
428 _8c.html" target="source" name="TagToCoderModuleName">TagToCoderModuleName</a></h2>
429 <div class="doc-section">
430
431 <p>TagToCoderModuleName() munges a module tag and obtains the filename of the corresponding module.</p></ol>
432
433 <p>The format of the TagToCoderModuleName module is:</p>
434
435 <pre class="text">
436   char *TagToCoderModuleName(const char *tag,char *name)
437 </pre>
438
439 <p>A description of each parameter follows:</p></ol>
440
441 <h5>tag</h5>
442 <ol><p>a character string representing the module tag.</p></ol>
443
444 <h5>name</h5>
445 <ol><p>return the module name here.</p></ol>
446
447  </div>
448 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
449 _8c.html" target="source" name="TagToFilterModuleName">TagToFilterModuleName</a></h2>
450 <div class="doc-section">
451
452 <p>TagToFilterModuleName() munges a module tag and returns the filename of the corresponding filter module.</p></ol>
453
454 <p>The format of the TagToFilterModuleName module is:</p>
455
456 <pre class="text">
457   void TagToFilterModuleName(const char *tag,char name)
458 </pre>
459
460 <p>A description of each parameter follows:</p></ol>
461
462 <h5>tag</h5>
463 <ol><p>a character string representing the module tag.</p></ol>
464
465 <h5>name</h5>
466 <ol><p>return the filter name here.</p></ol>
467
468  </div>
469 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
470 _8c.html" target="source" name="TagToModuleName">TagToModuleName</a></h2>
471 <div class="doc-section">
472
473 <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>
474
475 <p>The format of the TagToModuleName module is:</p>
476
477 <pre class="text">
478   TagToModuleName(const char *tag,const char *format,char *module)
479 </pre>
480
481 <p>A description of each parameter follows:</p></ol>
482
483 <h5>tag</h5>
484 <ol><p>the module tag.</p></ol>
485
486 <h5>format</h5>
487 <ol><p>a sprintf-compatible format string containing s where the upper-case tag name is to be inserted.</p></ol>
488
489 <h5>module</h5>
490 <ol><p>pointer to a destination buffer for the formatted result.</p></ol>
491
492  </div>
493 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
494 _8c.html" target="source" name="UnregisterModule">UnregisterModule</a></h2>
495 <div class="doc-section">
496
497 <p>UnregisterModule() unloads a module, and invokes its de-registration module. Returns MagickTrue on success, and MagickFalse if there is an error.</p></ol>
498
499 <p>The format of the UnregisterModule module is:</p>
500
501 <pre class="text">
502   MagickBooleanType UnregisterModule(const ModuleInfo *module_info,
503     ExceptionInfo *exception)
504 </pre>
505
506 <p>A description of each parameter follows:</p></ol>
507
508 <h5>module_info</h5>
509 <ol><p>the module info.</p></ol>
510
511 <h5>exception</h5>
512 <ol><p>return any errors or warnings in this structure.</p></ol>
513
514  </div>
515 \r
516 </div>\r
517 \r
518 <div id="linkbar">\r
519  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
520     <span id="linkbar-center">\r
521       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
522     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
523     </span>\r
524     <span id="linkbar-east">&nbsp;</span>\r
525   </div>\r
526   <div class="footer">\r
527     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
528     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
529   </div>\r
530   <div style="clear: both; margin: 0; width: 100%; "></div>\r
531 </body>\r
532 </html>\r