blob: 155607b99e8cc145c3c3ce9e61c74657c8f63b17 [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +00001<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +00004<head>
cristy3c98a4f2010-08-13 20:09:41 +00005 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +00007 <title>ImageMagick: MagickCore, C API for ImageMagick: Dealing with Image Profiles</title>
cristy3ed852e2009-09-05 21:47:34 +00008 <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"/>
cristy3c98a4f2010-08-13 20:09:41 +000011 <meta name="Application-name" content="ImageMagick"/>
cristydcca3fa2010-12-29 21:50:07 +000012 <meta name="Description" content="ImageMagick is a software suite to create, edit, compose, or convert bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +000013 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +000014 <meta name="Generator" content="PHP"/>
15 <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, dealing, with, image, profiles, 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 +000016 <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"/>
cristy4103d562010-12-10 01:38:54 +000022 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000023 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +000024 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +000025 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
27 <style type="text/css" media="all">
28 @import url("../../www/magick.css");
29 </style>
cristydcca3fa2010-12-29 21:50:07 +000030 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +000031 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
32 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
33 <script type="text/javascript">
34 $(document).ready(function() {
35 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
36 'transitionIn' : 'elastic',
37 'transitionOut' : 'elastic',
38 'overlayShow' : false,
39 'opacity' : true
40 });
41 });
42 </script>
cristy3eaa0ef2010-03-06 20:35:26 +000043</head>
44
45<body id="www-imagemagick-org">
46<div class="titlebar">
47<a href="../../index.html">
48 <img src="../../images/script.png" alt="[ImageMagick]"
49 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
50<a href="http://www.networkredux.com">
51 <img src="../../images/networkredux.png" alt="[sponsor]"
52 style="margin: 45px auto; border: 0px; float: left;" /></a>
53<a href="http://www.imagemagick.org/discourse-server/">
54 <img src="../../images/logo.jpg" alt=""
55 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
56<a href="../../index.html">
57 <img src="../../images/sprite.jpg" alt=""
58 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
59</div>
60
cristyce69bb02010-07-27 19:49:46 +000061<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000062
cristy3ed852e2009-09-05 21:47:34 +000063<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000064 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000065</div>
cristy3eaa0ef2010-03-06 20:35:26 +000066<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000067<div class="menu">
cristybb503372010-05-27 20:51:26 +000068 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
69</div>
70<div class="sub">
71 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
72</div>
73<div class="sub">
74 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
75</div>
76<div class="sub">
77 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
78</div>
79<div class="sep"></div>
80<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000081 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000082</div>
83<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000084 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000085</div>
86<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000087 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000088</div>
89<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000090 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000091</div>
92<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000093 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000094</div>
95<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000096 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000097</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000099 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000102 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000103</div>
104<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000105 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000106</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000107<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000108<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000109 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000110</div>
111<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000112 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000113</div>
114<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000115 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000116 </div>
117<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000118 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000119</div>
cristybb503372010-05-27 20:51:26 +0000120<div class="menu">
121 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
122</div>
cristy3ed852e2009-09-05 21:47:34 +0000123<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000124 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000125</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000126<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000127<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000128 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000129</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000130<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000131<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000132 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000133</div>
134<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000135 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000136</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000137<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000138<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000139 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000140
141<div class="sponsbox">
cristyec6b4752011-01-08 03:16:23 +0000142<div class="sponsor">
143 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.html">Web Hosting</a><!-- 201104010090 -->
cristy7d52cd62010-10-01 17:26:59 +0000144</div>
145<div class="sponsor">
146 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000147</div>
148<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000149 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
150</div>
151<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000152 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
153</div>
cristyec6b4752011-01-08 03:16:23 +0000154<div class="sponsor">
155 <a title="Sponsor: Notebook Reparatur Berlin" href="http://www.notebook-reparaturen-berlin.de">Notebook Reparatur Berlin</a><!-- 2011050100025 gabi.schulze-->
156</div>
cristybac7a162010-06-15 19:57:29 +0000157</div>
cristy3ed852e2009-09-05 21:47:34 +0000158</div>
cristyce69bb02010-07-27 19:49:46 +0000159</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000160
cristyce69bb02010-07-27 19:49:46 +0000161<div class="eastbar">
162 <script type="text/javascript">
163 <!--
164 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000165 google_ad_slot = "0574824969";
166 google_ad_width = 160;
167 google_ad_height = 600;
168 //-->
169 </script>
170 <script type="text/javascript"
171 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
172 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000173</div>
174
175<div class="main">
176
cristy307ba182010-12-25 01:00:34 +0000177<h1>Module profile
178 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000179<p class="navigation-index">[<a href="#CloneImageProfiles">CloneImageProfiles</a> &bull; <a href="#DeleteImageProfile">DeleteImageProfile</a> &bull; <a href="#DestroyImageProfiles">DestroyImageProfiles</a> &bull; <a href="#GetImageProfile">GetImageProfile</a> &bull; <a href="#GetNextImageProfile">GetNextImageProfile</a> &bull; <a href="#ProfileImage">ProfileImage</a> &bull; <a href="#RemoveImageProfile">RemoveImageProfile</a> &bull; <a href="#ResetImageProfileIterator">ResetImageProfileIterator</a> &bull; <a href="#SetImageProfile">SetImageProfile</a> &bull; <a href="#SyncImageProfiles">SyncImageProfiles</a>]</p>
180
181<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
182_8c.html" target="source" name="CloneImageProfiles">CloneImageProfiles</a></h2>
183<div class="doc-section">
184
185<p>CloneImageProfiles() clones one or more image profiles.</p></ol>
186
187<p>The format of the CloneImageProfiles method is:</p>
188
189<pre class="code">
190 MagickBooleanType CloneImageProfiles(Image *image,
191 const Image *clone_image)
192</pre>
193
194<p>A description of each parameter follows:</p></ol>
195
196<h5>image</h5>
197<ol><p>the image.</p></ol>
198
199<h5>clone_image</h5>
200<ol><p>the clone image.</p></ol>
201
202 </div>
203<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
204_8c.html" target="source" name="DeleteImageProfile">DeleteImageProfile</a></h2>
205<div class="doc-section">
206
207<p>DeleteImageProfile() deletes a profile from the image by its name.</p></ol>
208
209<p>The format of the DeleteImageProfile method is:</p>
210
211<pre class="code">
212 MagickBooleanTyupe DeleteImageProfile(Image *image,const char *name)
213</pre>
214
215<p>A description of each parameter follows:</p></ol>
216
217<h5>image</h5>
218<ol><p>the image.</p></ol>
219
220<h5>name</h5>
221<ol><p>the profile name.</p></ol>
222
223 </div>
224<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
225_8c.html" target="source" name="DestroyImageProfiles">DestroyImageProfiles</a></h2>
226<div class="doc-section">
227
228<p>DestroyImageProfiles() releases memory associated with an image profile map.</p></ol>
229
230<p>The format of the DestroyProfiles method is:</p>
231
232<pre class="code">
233 void DestroyImageProfiles(Image *image)
234</pre>
235
236<p>A description of each parameter follows:</p></ol>
237
238<h5>image</h5>
239<ol><p>the image.</p></ol>
240
241 </div>
242<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
243_8c.html" target="source" name="GetImageProfile">GetImageProfile</a></h2>
244<div class="doc-section">
245
246<p>GetImageProfile() gets a profile associated with an image by name.</p></ol>
247
248<p>The format of the GetImageProfile method is:</p>
249
250<pre class="code">
251 const StringInfo *GetImageProfile(const Image *image,const char *name)
252</pre>
253
254<p>A description of each parameter follows:</p></ol>
255
256<h5>image</h5>
257<ol><p>the image.</p></ol>
258
259<h5>name</h5>
260<ol><p>the profile name.</p></ol>
261
262 </div>
263<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
264_8c.html" target="source" name="GetNextImageProfile">GetNextImageProfile</a></h2>
265<div class="doc-section">
266
267<p>GetNextImageProfile() gets the next profile name for an image.</p></ol>
268
269<p>The format of the GetNextImageProfile method is:</p>
270
271<pre class="code">
272 char *GetNextImageProfile(const Image *image)
273</pre>
274
275<p>A description of each parameter follows:</p></ol>
276
277<h5>hash_info</h5>
278<ol><p>the hash info.</p></ol>
279
280 </div>
281<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
282_8c.html" target="source" name="ProfileImage">ProfileImage</a></h2>
283<div class="doc-section">
284
285<p>ProfileImage() associates, applies, or removes an ICM, IPTC, or generic profile with / to / from an image. If the profile is NULL, it is removed from the image otherwise added or applied. Use a name of '*' and a profile of NULL to remove all profiles from the image.</p></ol>
286
287<p>ICC and ICM profiles are handled as follows: If the image does not have an associated color profile, the one you provide is associated with the image and the image pixels are not transformed. Otherwise, the colorspace transform defined by the existing and new profile are applied to the image pixels and the new profile is associated with the image.</p></ol>
288
289<p>The format of the ProfileImage method is:</p>
290
291<pre class="code">
292 MagickBooleanType ProfileImage(Image *image,const char *name,
293 const void *datum,const size_t length,const MagickBooleanType clone)
294</pre>
295
296<p>A description of each parameter follows:</p></ol>
297
298<h5>image</h5>
299<ol><p>the image.</p></ol>
300
301<h5>name</h5>
302<ol><p>Name of profile to add or remove: ICC, IPTC, or generic profile.</p></ol>
303
304<h5>datum</h5>
305<ol><p>the profile data.</p></ol>
306
307<h5>length</h5>
308<ol><p>the length of the profile.</p></ol>
309
310<h5>clone</h5>
311<ol><p>should be MagickFalse.</p></ol>
312
313 </div>
314<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
315_8c.html" target="source" name="RemoveImageProfile">RemoveImageProfile</a></h2>
316<div class="doc-section">
317
318<p>RemoveImageProfile() removes a named profile from the image and returns its value.</p></ol>
319
320<p>The format of the RemoveImageProfile method is:</p>
321
322<pre class="code">
323 void *RemoveImageProfile(Image *image,const char *name)
324</pre>
325
326<p>A description of each parameter follows:</p></ol>
327
328<h5>image</h5>
329<ol><p>the image.</p></ol>
330
331<h5>name</h5>
332<ol><p>the profile name.</p></ol>
333
334 </div>
335<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
336_8c.html" target="source" name="ResetImageProfileIterator">ResetImageProfileIterator</a></h2>
337<div class="doc-section">
338
339<p>ResetImageProfileIterator() resets the image profile iterator. Use it in conjunction with GetNextImageProfile() to iterate over all the profiles associated with an image.</p></ol>
340
341<p>The format of the ResetImageProfileIterator method is:</p>
342
343<pre class="code">
344 ResetImageProfileIterator(Image *image)
345</pre>
346
347<p>A description of each parameter follows:</p></ol>
348
349<h5>image</h5>
350<ol><p>the image.</p></ol>
351
352 </div>
353<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
354_8c.html" target="source" name="SetImageProfile">SetImageProfile</a></h2>
355<div class="doc-section">
356
357<p>SetImageProfile() adds a named profile to the image. If a profile with the same name already exists, it is replaced. This method differs from the ProfileImage() method in that it does not apply CMS color profiles.</p></ol>
358
359<p>The format of the SetImageProfile method is:</p>
360
361<pre class="code">
362 MagickBooleanType SetImageProfile(Image *image,const char *name,
363 const StringInfo *profile)
364</pre>
365
366<p>A description of each parameter follows:</p></ol>
367
368<h5>image</h5>
369<ol><p>the image.</p></ol>
370
371<h5>name</h5>
372<ol><p>the profile name, for example icc, exif, and 8bim (8bim is the Photoshop wrapper for iptc profiles).</p></ol>
373
374<h5>profile</h5>
375<ol><p>A StringInfo structure that contains the named profile.</p></ol>
376
377 </div>
378<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
379_8c.html" target="source" name="SyncImageProfiles">SyncImageProfiles</a></h2>
380<div class="doc-section">
381
382<p>SyncImageProfiles() synchronizes image properties with the image profiles. Currently we only support updating the EXIF resolution and orientation.</p></ol>
383
384<p>The format of the SyncImageProfiles method is:</p>
385
386<pre class="code">
387 MagickBooleanType SyncImageProfiles(Image *image)
388</pre>
389
390<p>A description of each parameter follows:</p></ol>
391
392<h5>image</h5>
393<ol><p>the image.</p></ol>
394
395 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000396
397</div>
398
399<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000400 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000401 <span id="linkbar-center">
402 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000403 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000404 </span>
405 <span id="linkbar-east">&nbsp;</span>
406 </div>
407 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000408 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000409 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
410 </div>
411 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000412 <script type="text/javascript">
413 var _gaq = _gaq || [];
414 _gaq.push(['_setAccount', 'UA-17690367-1']);
415 _gaq.push(['_trackPageview']);
416
417 (function() {
418 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
419 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
420 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
421 })();
422 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000423</body>
424</html>