Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 4e638cd1496a8f25940979b0086e1c7c4ef31290 / . / www / api / magick.html
blob: e264680ad5e8feeba2e5ac41d6bb0a0abb2ba350 [file] [log] [blame]
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2<html lang="en">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]3<head>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]4 <meta charset="utf-8">
5 <meta http-equiv="X-UA-Compatible" content="IE=edge">
6 <meta name="viewport" content="width=device-width, initial-scale=1">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]7 <title>ImageMagick: MagickCore, C API for ImageMagick: Read or List Image formats</title>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]8 <meta http-equiv="content-language" content="en-US">
9 <meta http-equiv="content-type" content="text/html; charset=utf-8">
10 <meta http-equiv="reply-to" content="magick-users@imagemagick.org">
11 <meta name="application-name" content="ImageMagick">
12 <meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.">
13 <meta name="application-url" content="http://www.imagemagick.org">
14 <meta name="generator" content="PHP">
15 <meta name="keywords" content="magickcore, c, api, for, imagemagick:, read, or, list, image, formats, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert">
16 <meta name="rating" content="GENERAL">
17 <meta name="robots" content="INDEX, FOLLOW">
18 <meta name="generator" content="ImageMagick Studio LLC">
19 <meta name="author" content="ImageMagick Studio LLC">
20 <meta name="revisit-after" content="2 DAYS">
21 <meta name="resource-type" content="document">
cristy4e638cd2015-05-07 16:47:40 +0000[diff] [blame^]22 <meta name="copyright" content="Copyright (c) 1999-2015 ImageMagick Studio LLC">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]23 <meta name="distribution" content="Global">
24 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1">
cristy2f563d42015-05-06 23:36:51 +0000[diff] [blame]25 <link rel="icon" href="../images/wand.png">
26 <link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon">
27 <link rel="stylesheet" href="../css/bootstrap.min.css">
28 <link rel="stylesheet" href="../css/magick.css">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]29</head>
30
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]31<body>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]32<div class="main">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]33<div class="magick-masthead">
34 <div class="container">
35 <script type="text/javascript">
36 <!--
37 google_ad_client = "pub-3129977114552745";
38 google_ad_slot = "5439289906";
39 google_ad_width = 728;
40 google_ad_height = 90;
41 //-->
42 </script>
43 <center><script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
44 </script></center>
45 <nav class="magick-nav">
cristy2f563d42015-05-06 23:36:51 +0000[diff] [blame]46 <a class="magick-nav-item " href="../index.html">Home</a>
47 <a class="magick-nav-item " href="../www/binary-releases.html">Downloads</a>
48 <a class="magick-nav-item " href="../www/command-line-tools.html">Tools</a>
49 <a class="magick-nav-item " href="../www/command-line-options.html">Options</a>
50 <a class="magick-nav-item " href="../www/api.html">Development</a>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]51 <a class="magick-nav-item" href="http://www.imagemagick.org/discourse-server/">Community</a>
cristyabed55c2015-05-06 17:07:00 +0000[diff] [blame]52 <a class="magick-nav-item navbar-right " href="http://www.imagemagick.org/script/search.php">Search</a>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]53 </nav>
54 </div>
55</div>
56<div class="container">
cristy4e638cd2015-05-07 16:47:40 +0000[diff] [blame^]57<div class="magick-header">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]58<p class="text-center"><a href="magick.html#AcquireMagickInfo">AcquireMagickInfo</a> • <a href="magick.html#GetMagickPrecision">GetMagickPrecision</a> • <a href="magick.html#IsMagickCoreInstantiated">IsMagickCoreInstantiated</a> • <a href="magick.html#MagickCoreGenesis">MagickCoreGenesis</a> • <a href="magick.html#MagickCoreTerminus">MagickCoreTerminus</a> • <a href="magick.html#SetMagickPrecision">SetMagickPrecision</a></p>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]59
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]60<h2><a href="http://www.imagemagick.org/api/MagickCore/magick_8c.html" id="AcquireMagickInfo">AcquireMagickInfo</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]61
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]62<p>AcquireMagickInfo() allocates a MagickInfo structure and initializes the members to default values.</p>
63
64<p>The format of the AcquireMagickInfo method is:</p>
65
66<pre class="text">
67MagickInfo *AcquireMagickInfo(const char *module, const char *name,)
68</pre>
69
70<p>A description of each parameter follows:</p>
71
72<dd>
73</dd>
74
75<dd> </dd>
76<dl class="dl-horizontal">
77<dt>module</dt>
78<dd>a character string that represents the module associated with the MagickInfo structure. </dd>
79
80<dd> </dd>
81<dt>name</dt>
82<dd>a character string that represents the image format associated with the MagickInfo structure. </dd>
83
84<dd> </dd>
85<dt>description</dt>
86<dd>a character string that represents the image format associated with the MagickInfo structure. </dd>
87
88<dd> </dd>
89</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]90<h2><a href="http://www.imagemagick.org/api/MagickCore/magick_8c.html" id="GetMagickPrecision">GetMagickPrecision</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]91
92<p>GetMagickPrecision() returns the maximum number of significant digits to be printed.</p>
93
94<p>The format of the GetMagickPrecision method is:</p>
95
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]96<pre class="text">
97int GetMagickPrecision(void)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]98</pre>
99
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]100<h2><a href="http://www.imagemagick.org/api/MagickCore/magick_8c.html" id="IsMagickCoreInstantiated">IsMagickCoreInstantiated</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]101
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]102<p>IsMagickCoreInstantiated() returns MagickTrue if the ImageMagick environment is currently instantiated: MagickCoreGenesis() has been called but MagickDestroy() has not.</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]103
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]104<p>The format of the IsMagickCoreInstantiated method is:</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]105
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]106<pre class="text">
107MagickBooleanType IsMagickCoreInstantiated(void)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]108</pre>
109
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]110<h2><a href="http://www.imagemagick.org/api/MagickCore/magick_8c.html" id="MagickCoreGenesis">MagickCoreGenesis</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]111
112<p>MagickCoreGenesis() initializes the MagickCore environment.</p>
113
114<p>The format of the MagickCoreGenesis function is:</p>
115
116<pre class="text">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]117MagickCoreGenesis(const char *path,
118 const MagickBooleanType establish_signal_handlers)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]119</pre>
120
121<p>A description of each parameter follows:</p>
122
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]123<dd>
124</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]125
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]126<dd> </dd>
127<dl class="dl-horizontal">
128<dt>path</dt>
129<dd>the execution path of the current ImageMagick client. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]130
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]131<dd> </dd>
132<dt>establish_signal_handlers</dt>
133<dd>set to MagickTrue to use MagickCore's own signal handlers for common signals. </dd>
134
135<dd> </dd>
136</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]137<h2><a href="http://www.imagemagick.org/api/MagickCore/magick_8c.html" id="MagickCoreTerminus">MagickCoreTerminus</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]138
139<p>MagickCoreTerminus() destroys the MagickCore environment.</p>
140
141<p>The format of the MagickCoreTerminus function is:</p>
142
143<pre class="text">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]144MagickCoreTerminus(void)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]145</pre>
146
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]147<h2><a href="http://www.imagemagick.org/api/MagickCore/magick_8c.html" id="SetMagickPrecision">SetMagickPrecision</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]148
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame]149<p>SetMagickPrecision() sets the maximum number of significant digits to be printed.</p>
150
151<p>An input argument of 0 returns the current precision setting.</p>
152
153<p>A negative value forces the precision to reset to a default value according to the environment variable "MAGICK_PRECISION", the current 'policy' configuration setting, or the default value of '6', in that order.</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]154
155<p>The format of the SetMagickPrecision method is:</p>
156
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]157<pre class="text">
158int SetMagickPrecision(const int precision)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]159</pre>
160
161<p>A description of each parameter follows:</p>
162
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]163<dd>
164</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]165
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]166<dd> </dd>
167<dl class="dl-horizontal">
168<dt>precision</dt>
169<dd>set the maximum number of significant digits to be printed. </dd>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]170
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]171<dd> </dd>
172</dl>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]173</div>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]174 <footer class="magick-footer">
175 <div class="magick-nav-item navbar-left">
cristy2f563d42015-05-06 23:36:51 +0000[diff] [blame]176 <a href="../www/support.html">Donate</a>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]177 </div>
cristy2f563d42015-05-06 23:36:51 +0000[diff] [blame]178 <p><a href="../www/sitemap.html">Sitemap</a> •
179 <a href="../www/links.html">Related</a> •
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]180 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Image Studio</a> •
181 <a href="http://jqmagick.imagemagick.org/">JqMagick</a> •
182 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a>
183</p>
184 <p><a href="magick.html#">Back to top</a> •
cristyabed55c2015-05-06 17:07:00 +0000[diff] [blame]185 <a href="http://www.imagemagick.org/script/contact.php">Contact Us</a></p>
cristy4e638cd2015-05-07 16:47:40 +0000[diff] [blame^]186 <p class="small">© 1999-2015 ImageMagick Studio LLC</p>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]187 </footer>
188</div><!-- /.container -->
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]189
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]190 <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
cristy2f563d42015-05-06 23:36:51 +0000[diff] [blame]191 <script src="../js/bootstrap.min.js"></script>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]192 <script type="text/javascript">
193 /* */
194 (function() {
195 var s = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0];
196 s.type = 'text/javascript';
197 s.async = true;
198 s.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
199 t.parentNode.insertBefore(s, t);
200 })();
201 /* */
202 </script>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]203</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]204</body>
cristy5a367e42015-05-05 12:39:18 +0000[diff] [blame]205</html>