Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / c70de514ab2ec97e7c3d4365d137b0dc16386d28 / . / www / api / magick.html
blob: 5994ac9d7037b1e05f5bccf8fc27d72a96036df7 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame]3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]5 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
7 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]8 <style type="text/css" media="all">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]9 @import url("../../www/magick.css");
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]10 </style>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]11 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
12 <title>ImageMagick: MagickCore, C API for ImageMagick: Read or List Image formats</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:, read, or, list, image, formats, 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"/>
cristy16af1cb2009-12-11 21:38:29 +0000[diff] [blame]25 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]26 <meta name="Distribution" content="Global"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]27</head>
28
29<body id="www-imagemagick-org">
30<div class="titlebar">
31<a href="../../index.html">
32 <img src="../../images/script.png" alt="[ImageMagick]"
33 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
34<a href="http://www.networkredux.com">
35 <img src="../../images/networkredux.png" alt="[sponsor]"
36 style="margin: 45px auto; border: 0px; float: left;" /></a>
37<a href="http://www.imagemagick.org/discourse-server/">
38 <img src="../../images/logo.jpg" alt=""
39 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
40<a href="../../index.html">
41 <img src="../../images/sprite.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43</div>
44
45<div class="eastbar">
46
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]47<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]48 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]49</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]50<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]51<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]52 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]53</div>
54<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]55 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]56</div>
57<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]58 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]59</div>
60<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]61 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]62</div>
63<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]64 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]65</div>
66<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]67 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]68</div>
69<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]70 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]71</div>
72<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]73 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]74</div>
75<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]76 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]77</div>
78<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]79 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]80</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]81<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]82<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]83 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]84</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]86 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]87</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]89 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]90 </div>
91<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]92 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]93</div>
94<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]95 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]96</div>
97<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]98 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]99</div>
100<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]101 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]102</div>
103<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]104 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]105</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]106<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]108 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]112 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</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="Site Map"href="../../www/sitemap.html">Site Map</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="Site Map: Links"href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]122<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]123 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124
125<div class="sponsbox">
126<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]127 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy4bbe0bd2010-04-08 02:07:24 +0000[diff] [blame]128</div>
129<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]130 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy6242f6a2010-02-18 02:20:56 +0000[diff] [blame]131</div>
132<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]133 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
cristyc1c61662009-09-30 14:04:37 +0000[diff] [blame]134</div>
135<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]136 <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
cristy0f61e612009-11-10 20:03:57 +0000[diff] [blame]137</div>
138<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]139 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristy916e1922009-10-01 12:52:47 +0000[diff] [blame]140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]142 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]143</div>
144<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]145 <a title="Sponsor: Online-Magazin" href="http://www.unkostenbeitrag.de/" title="Online-Magazin">Online-Magazin</a><!-- 20101101000200 -->
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]146</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]147</div>
148</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]149
150
151</div>
152
153<div class="main">
154
cristyd43a46b2010-01-21 02:13:41 +0000[diff] [blame]155<p class="navigation-index">[<a href="#GetMagickPrecision">GetMagickPrecision</a> &bull; <a href="#IsMagickInstantiated">IsMagickInstantiated</a> &bull; <a href="#MagickCoreGenesis">MagickCoreGenesis</a> &bull; <a href="#MagickCoreTerminus">MagickCoreTerminus</a> &bull; <a href="#SetMagickPrecision">SetMagickPrecision</a>]</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]156
157<h2><a href="http://www.imagemagick.org/api/MagickCore/magick
cristyd43a46b2010-01-21 02:13:41 +0000[diff] [blame]158_8c.html" target="source" name="GetMagickPrecision">GetMagickPrecision</a></h2>
159<div class="doc-section">
160
161<p>GetMagickPrecision() returns the maximum number of significant digits to be printed.</p></ol>
162
163<p>The format of the GetMagickPrecision method is:</p>
164
165<pre class="code">
166 int GetMagickPrecision(void)
167</pre>
168
169 </div>
170<h2><a href="http://www.imagemagick.org/api/MagickCore/magick
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]171_8c.html" target="source" name="IsMagickInstantiated">IsMagickInstantiated</a></h2>
172<div class="doc-section">
173
174<p>IsMagickInstantiated() returns MagickTrue if the ImageMagick environment is currently instantiated: MagickCoreGenesis() has been called but MagickDestroy() has not.</p></ol>
175
176<p>The format of the IsMagickInstantiated method is:</p>
177
178<pre class="code">
179 MagickBooleanType IsMagickInstantiated(void)
180</pre>
181
182 </div>
183<h2><a href="http://www.imagemagick.org/api/MagickCore/magick
184_8c.html" target="source" name="MagickCoreGenesis">MagickCoreGenesis</a></h2>
185<div class="doc-section">
186
187<p>MagickCoreGenesis() initializes the MagickCore environment.</p></ol>
188
189<p>The format of the MagickCoreGenesis function is:</p>
190
191<pre class="text">
192 MagickCoreGenesis(const char *path,
193 const MagickBooleanType establish_signal_handlers)
194</pre>
195
196<p>A description of each parameter follows:</p></ol>
197
198<h5>path</h5>
199<ol><p>the execution path of the current ImageMagick client.</p></ol>
200
201<h5>establish_signal_handlers</h5>
202<ol><p>set to MagickTrue to use MagickCore's own signal handlers for common signals.</p></ol>
203
204 </div>
205<h2><a href="http://www.imagemagick.org/api/MagickCore/magick
206_8c.html" target="source" name="MagickCoreTerminus">MagickCoreTerminus</a></h2>
207<div class="doc-section">
208
209<p>MagickCoreTerminus() destroys the MagickCore environment.</p></ol>
210
cristye6378132009-10-26 20:05:17 +0000[diff] [blame]211<p>The format of the MagickCoreTerminus function is:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]212
213<pre class="text">
214 MagickCoreTerminus(void)
215</pre>
216
217 </div>
cristyd43a46b2010-01-21 02:13:41 +0000[diff] [blame]218<h2><a href="http://www.imagemagick.org/api/MagickCore/magick
219_8c.html" target="source" name="SetMagickPrecision">SetMagickPrecision</a></h2>
220<div class="doc-section">
221
222<p>SetMagickPrecision() sets the maximum number of significant digits to be printed and returns it.</p></ol>
223
224<p>The format of the SetMagickPrecision method is:</p>
225
226<pre class="code">
227 int SetMagickPrecision(const int precision)
228</pre>
229
230<p>A description of each parameter follows:</p></ol>
231
232<h5>precision</h5>
233<ol><p>set the maximum number of significant digits to be printed.</p></ol>
234
235 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]236
237</div>
238
239<div id="linkbar">
240 <!-- <span id="linkbar-west">&nbsp;</span> -->
241 <span id="linkbar-center">
242 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristybebec402010-04-23 19:19:08 +0000[diff] [blame]243 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]244 </span>
245 <span id="linkbar-east">&nbsp;</span>
246 </div>
247 <div class="footer">
248 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
249 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
250 </div>
251 <div style="clear: both; margin: 0; width: 100%; "></div>
252</body>
253</html>