Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 350dea44cca73cc46ce2183e1851c5b254c7921e / . / www / api / module.html
blob: a386f426cae3b2ebea6d1a5dd774002b6725ac09 [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
cristy2bd2a982011-02-15 00:52:58 +0000[diff] [blame]3<html version="-//W3C//DTD XHTML 1.1//EN"
4 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:schemaLocation="http://www.w3.org/1999/xhtml
7 http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]8<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]9 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
10 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]11 <title>ImageMagick: MagickCore, C API for ImageMagick: Loadable Modules</title>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]12 <meta http-equiv="Content-Language" content="en-US"/>
13 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
14 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]15 <meta name="Application-name" content="ImageMagick"/>
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]16 <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition resize, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]17 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]18 <meta name="Generator" content="PHP"/>
19 <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"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]20 <meta name="Rating" content="GENERAL"/>
21 <meta name="Robots" content="INDEX, FOLLOW"/>
22 <meta name="Generator" content="ImageMagick Studio LLC"/>
23 <meta name="Author" content="ImageMagick Studio LLC"/>
24 <meta name="Revisit-after" content="2 DAYS"/>
25 <meta name="Resource-type" content="document"/>
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]26 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]27 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]28 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]29 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
30 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]31 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]32 <style type="text/css" media="all">
33 @import url("../../www/magick.css");
34 </style>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]35 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +0000[diff] [blame]36 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
37 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
38 <script type="text/javascript">
39 $(document).ready(function() {
40 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
41 'transitionIn' : 'elastic',
42 'transitionOut' : 'elastic',
43 'overlayShow' : false,
44 'opacity' : true
45 });
46 });
47 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]48</head>
49
50<body id="www-imagemagick-org">
51<div class="titlebar">
52<a href="../../index.html">
53 <img src="../../images/script.png" alt="[ImageMagick]"
54 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
55<a href="http://www.networkredux.com">
56 <img src="../../images/networkredux.png" alt="[sponsor]"
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]57 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]58<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]59 <img src="../../images/logo.jpg"
60 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]61 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]62<a href="../../index.html">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]63 <img src="../../images/sprite.jpg"
64 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]65 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
66</div>
67
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]68<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]69
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]70<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]71 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]72</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]73<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]74<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]75 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
76</div>
77<div class="sub">
78 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
79</div>
80<div class="sub">
81 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
82</div>
83<div class="sub">
84 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
85</div>
86<div class="sep"></div>
87<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]88 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]89</div>
90<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]91 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]92</div>
93<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]94 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]95</div>
96<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]97 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]98</div>
99<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]100 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]103 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]104</div>
105<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]106 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107</div>
108<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]109 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]110</div>
111<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]112 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
121<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]122 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]123 </div>
124<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]125 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]126</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]127<div class="menu">
128 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
129</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]130<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]131 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]132</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]133<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]135 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]136</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]137<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]138<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]139 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]140</div>
141<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]142 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]143</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]144<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]145<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]146 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]147
148<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]149<div class="sponsor">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]150 <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
151</div>
152<div class="sponsor">
153 <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
154</div>
155<div class="sponsor">
cristy2bd2a982011-02-15 00:52:58 +0000[diff] [blame]156 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201107010240 r.leo -->
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]157</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]158<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]159 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy5c4585b2010-11-11 00:13:57 +0000[diff] [blame]160</div>
161<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]162 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
163</div>
164<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]165 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
166</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]167<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]168 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
169</div>
170<div class="sponsor">
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]171 <a title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]172</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]173</div>
174</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]175</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]176
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]177<div class="eastbar">
178 <script type="text/javascript">
179 <!--
180 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]181 google_ad_slot = "0574824969";
182 google_ad_width = 160;
183 google_ad_height = 600;
184 //-->
185 </script>
186 <script type="text/javascript"
187 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
188 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]189</div>
190
191<div class="main">
192
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]193<h1>Module module Methods</h1>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]194<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]195
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]196<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="AcquireModuleInfo">AcquireModuleInfo</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]197<div class="doc-section">
198
199<p>AcquireModuleInfo() allocates the ModuleInfo structure.</p>
200
201<p>The format of the AcquireModuleInfo method is:</p>
202
203<pre class="code">
204 ModuleInfo *AcquireModuleInfo(const char *path,const char *tag)
205</pre>
206
207<p>A description of each parameter follows:</p>
208
209<h5>path</h5>
210<p>the path associated with the tag.</p>
211
212<h5>tag</h5>
213<p>a character string that represents the image format we are looking for.</p>
214
215 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]216<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="DestroyModuleList">DestroyModuleList</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]217<div class="doc-section">
218
219<p>DestroyModuleList() unregisters any previously loaded modules and exits the module loaded environment.</p>
220
221<p>The format of the DestroyModuleList module is:</p>
222
223<pre class="text">
224 void DestroyModuleList(void)
225</pre>
226
227 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]228<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="GetModuleInfo">GetModuleInfo</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]229<div class="doc-section">
230
231<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>
232
233<p>The format of the GetModuleInfo module is:</p>
234
235<pre class="text">
236 ModuleInfo *GetModuleInfo(const char *tag,ExceptionInfo *exception)
237</pre>
238
239<p>A description of each parameter follows:</p>
240
241<h5>tag</h5>
242<p>a character string that represents the image format we are looking for.</p>
243
244<h5>exception</h5>
245<p>return any errors or warnings in this structure.</p>
246
247 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]248<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="GetModuleInfoList">GetModuleInfoList</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]249<div class="doc-section">
250
251<p>GetModuleInfoList() returns any modules that match the specified pattern.</p>
252
253<p>The format of the GetModuleInfoList function is:</p>
254
255<pre class="text">
256 const ModuleInfo **GetModuleInfoList(const char *pattern,
257 size_t *number_modules,ExceptionInfo *exception)
258</pre>
259
260<p>A description of each parameter follows:</p>
261
262<h5>pattern</h5>
263<p>Specifies a pointer to a text string containing a pattern.</p>
264
265<h5>number_modules</h5>
266<p>This integer returns the number of modules in the list.</p>
267
268<h5>exception</h5>
269<p>return any errors or warnings in this structure.</p>
270
271 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]272<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="GetModuleList">GetModuleList</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]273<div class="doc-section">
274
275<p>GetModuleList() returns any image format modules that match the specified pattern.</p>
276
277<p>The format of the GetModuleList function is:</p>
278
279<pre class="text">
280 char **GetModuleList(const char *pattern,const MagickModuleType type,
281 size_t *number_modules,ExceptionInfo *exception)
282</pre>
283
284<p>A description of each parameter follows:</p>
285
286<h5>pattern</h5>
287<p>Specifies a pointer to a text string containing a pattern.</p>
288
289<h5>type</h5>
290<p>choose from MagickImageCoderModule or MagickImageFilterModule.</p>
291
292<h5>number_modules</h5>
293<p>This integer returns the number of modules in the list.</p>
294
295<h5>exception</h5>
296<p>return any errors or warnings in this structure.</p>
297
298 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]299<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="GetMagickModulePath">GetMagickModulePath</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]300<div class="doc-section">
301
302<p>GetMagickModulePath() finds a module with the specified module type and filename.</p>
303
304<p>The format of the GetMagickModulePath module is:</p>
305
306<pre class="text">
307 MagickBooleanType GetMagickModulePath(const char *filename,
308 MagickModuleType module_type,char *path,ExceptionInfo *exception)
309</pre>
310
311<p>A description of each parameter follows:</p>
312
313<h5>filename</h5>
314<p>the module file name.</p>
315
316<h5>module_type</h5>
317<p>the module type: MagickImageCoderModule or MagickImageFilterModule.</p>
318
319<h5>path</h5>
320<p>the path associated with the filename.</p>
321
322<h5>exception</h5>
323<p>return any errors or warnings in this structure.</p>
324
325 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]326<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="InitializeModuleList">InitializeModuleList</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]327<div class="doc-section">
328
329<p>InitializeModuleList() initializes the module loader.</p>
330
331<p>The format of the InitializeModuleList() method is:</p>
332
333<pre class="code">
334 InitializeModuleList(Exceptioninfo *exception)
335</pre>
336
337<p>A description of each parameter follows.</p>
338
339<h5>exception</h5>
340<p>return any errors or warnings in this structure.</p>
341
342 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]343<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="InvokeDynamicImageFilter">InvokeDynamicImageFilter</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]344<div class="doc-section">
345
346<p>InvokeDynamicImageFilter() invokes a dynamic image filter.</p>
347
348<p>The format of the InvokeDynamicImageFilter module is:</p>
349
350<pre class="text">
351 MagickBooleanType InvokeDynamicImageFilter(const char *tag,Image **image,
352 const int argc,const char **argv,ExceptionInfo *exception)
353</pre>
354
355<p>A description of each parameter follows:</p>
356
357<h5>tag</h5>
358<p>a character string that represents the name of the particular module.</p>
359
360<h5>image</h5>
361<p>the image.</p>
362
363<h5>argc</h5>
364<p>a pointer to an integer describing the number of elements in the argument vector.</p>
365
366<h5>argv</h5>
367<p>a pointer to a text array containing the command line arguments.</p>
368
369<h5>exception</h5>
370<p>return any errors or warnings in this structure.</p>
371
372 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]373<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="ListModuleInfo">ListModuleInfo</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]374<div class="doc-section">
375
376<p>ListModuleInfo() lists the module info to a file.</p>
377
378<p>The format of the ListModuleInfo module is:</p>
379
380<pre class="text">
381 MagickBooleanType ListModuleInfo(FILE *file,ExceptionInfo *exception)
382</pre>
383
384<p>A description of each parameter follows.</p>
385
386<h5>file</h5>
387<p>An pointer to a FILE.</p>
388
389<h5>exception</h5>
390<p>return any errors or warnings in this structure.</p>
391
392 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]393<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="OpenModule">OpenModule</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]394<div class="doc-section">
395
396<p>OpenModule() loads a module, and invokes its registration module. It returns MagickTrue on success, and MagickFalse if there is an error.</p>
397
398<p>The format of the OpenModule module is:</p>
399
400<pre class="text">
401 MagickBooleanType OpenModule(const char *module,ExceptionInfo *exception)
402</pre>
403
404<p>A description of each parameter follows:</p>
405
406<h5>module</h5>
407<p>a character string that indicates the module to load.</p>
408
409<h5>exception</h5>
410<p>return any errors or warnings in this structure.</p>
411
412 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]413<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="OpenModules">OpenModules</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]414<div class="doc-section">
415
416<p>OpenModules() loads all available modules.</p>
417
418<p>The format of the OpenModules module is:</p>
419
420<pre class="text">
421 MagickBooleanType OpenModules(ExceptionInfo *exception)
422</pre>
423
424<p>A description of each parameter follows:</p>
425
426<h5>exception</h5>
427<p>return any errors or warnings in this structure.</p>
428
429 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]430<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="RegisterModule">RegisterModule</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]431<div class="doc-section">
432
433<p>RegisterModule() adds an entry to the module list. It returns a pointer to the registered entry on success.</p>
434
435<p>The format of the RegisterModule module is:</p>
436
437<pre class="text">
438 ModuleInfo *RegisterModule(const ModuleInfo *module_info,
439 ExceptionInfo *exception)
440</pre>
441
442<p>A description of each parameter follows:</p>
443
444<h5>info</h5>
445<p>a pointer to the registered entry is returned.</p>
446
447<h5>module_info</h5>
448<p>a pointer to the ModuleInfo structure to register.</p>
449
450<h5>exception</h5>
451<p>return any errors or warnings in this structure.</p>
452
453 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]454<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="TagToCoderModuleName">TagToCoderModuleName</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]455<div class="doc-section">
456
457<p>TagToCoderModuleName() munges a module tag and obtains the filename of the corresponding module.</p>
458
459<p>The format of the TagToCoderModuleName module is:</p>
460
461<pre class="text">
462 char *TagToCoderModuleName(const char *tag,char *name)
463</pre>
464
465<p>A description of each parameter follows:</p>
466
467<h5>tag</h5>
468<p>a character string representing the module tag.</p>
469
470<h5>name</h5>
471<p>return the module name here.</p>
472
473 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]474<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="TagToFilterModuleName">TagToFilterModuleName</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]475<div class="doc-section">
476
477<p>TagToFilterModuleName() munges a module tag and returns the filename of the corresponding filter module.</p>
478
479<p>The format of the TagToFilterModuleName module is:</p>
480
481<pre class="text">
482 void TagToFilterModuleName(const char *tag,char name)
483</pre>
484
485<p>A description of each parameter follows:</p>
486
487<h5>tag</h5>
488<p>a character string representing the module tag.</p>
489
490<h5>name</h5>
491<p>return the filter name here.</p>
492
493 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]494<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="TagToModuleName">TagToModuleName</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]495<div class="doc-section">
496
497<p>TagToModuleName() munges the module tag name and returns an upper-case tag name as the input string, and a user-provided format.</p>
498
499<p>The format of the TagToModuleName module is:</p>
500
501<pre class="text">
502 TagToModuleName(const char *tag,const char *format,char *module)
503</pre>
504
505<p>A description of each parameter follows:</p>
506
507<h5>tag</h5>
508<p>the module tag.</p>
509
510<h5>format</h5>
511<p>a sprintf-compatible format string containing s where the upper-case tag name is to be inserted.</p>
512
513<h5>module</h5>
514<p>pointer to a destination buffer for the formatted result.</p>
515
516 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]517<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="UnregisterModule">UnregisterModule</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]518<div class="doc-section">
519
520<p>UnregisterModule() unloads a module, and invokes its de-registration module. Returns MagickTrue on success, and MagickFalse if there is an error.</p>
521
522<p>The format of the UnregisterModule module is:</p>
523
524<pre class="text">
525 MagickBooleanType UnregisterModule(const ModuleInfo *module_info,
526 ExceptionInfo *exception)
527</pre>
528
529<p>A description of each parameter follows:</p>
530
531<h5>module_info</h5>
532<p>the module info.</p>
533
534<h5>exception</h5>
535<p>return any errors or warnings in this structure.</p>
536
537 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]538
539</div>
540
541<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]542 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]543 <span id="linkbar-center">
544 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]545 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]546 </span>
547 <span id="linkbar-east">&nbsp;</span>
548 </div>
549 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]550 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]551 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
552 </div>
553 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]554 <script type="text/javascript">
555 var _gaq = _gaq || [];
556 _gaq.push(['_setAccount', 'UA-17690367-1']);
557 _gaq.push(['_trackPageview']);
558
559 (function() {
560 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
561 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
562 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
563 })();
564 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]565</body>
566</html>