blob: e2e2d3c2bca7b6abef85493184d509a4639558e7 [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>
31 <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">
142<div class="sponsor">
cristydcca3fa2010-12-29 21:50:07 +0000143 <a title="Sponsor: Notebook Reparatur Berlin" href="http://www.notebook-reparaturen-berlin.de">Notebook Reparatur Berlin</a><!-- 2011040100025 gabi.schulze-->
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>
cristybac7a162010-06-15 19:57:29 +0000154</div>
cristy3ed852e2009-09-05 21:47:34 +0000155</div>
cristyce69bb02010-07-27 19:49:46 +0000156</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000157
cristyce69bb02010-07-27 19:49:46 +0000158<div class="eastbar">
159 <script type="text/javascript">
160 <!--
161 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000162 google_ad_slot = "0574824969";
163 google_ad_width = 160;
164 google_ad_height = 600;
165 //-->
166 </script>
167 <script type="text/javascript"
168 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
169 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000170</div>
171
172<div class="main">
173
cristy307ba182010-12-25 01:00:34 +0000174<h1>Module profile
175 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000176<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>
177
178<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
179_8c.html" target="source" name="CloneImageProfiles">CloneImageProfiles</a></h2>
180<div class="doc-section">
181
182<p>CloneImageProfiles() clones one or more image profiles.</p></ol>
183
184<p>The format of the CloneImageProfiles method is:</p>
185
186<pre class="code">
187 MagickBooleanType CloneImageProfiles(Image *image,
188 const Image *clone_image)
189</pre>
190
191<p>A description of each parameter follows:</p></ol>
192
193<h5>image</h5>
194<ol><p>the image.</p></ol>
195
196<h5>clone_image</h5>
197<ol><p>the clone image.</p></ol>
198
199 </div>
200<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
201_8c.html" target="source" name="DeleteImageProfile">DeleteImageProfile</a></h2>
202<div class="doc-section">
203
204<p>DeleteImageProfile() deletes a profile from the image by its name.</p></ol>
205
206<p>The format of the DeleteImageProfile method is:</p>
207
208<pre class="code">
209 MagickBooleanTyupe DeleteImageProfile(Image *image,const char *name)
210</pre>
211
212<p>A description of each parameter follows:</p></ol>
213
214<h5>image</h5>
215<ol><p>the image.</p></ol>
216
217<h5>name</h5>
218<ol><p>the profile name.</p></ol>
219
220 </div>
221<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
222_8c.html" target="source" name="DestroyImageProfiles">DestroyImageProfiles</a></h2>
223<div class="doc-section">
224
225<p>DestroyImageProfiles() releases memory associated with an image profile map.</p></ol>
226
227<p>The format of the DestroyProfiles method is:</p>
228
229<pre class="code">
230 void DestroyImageProfiles(Image *image)
231</pre>
232
233<p>A description of each parameter follows:</p></ol>
234
235<h5>image</h5>
236<ol><p>the image.</p></ol>
237
238 </div>
239<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
240_8c.html" target="source" name="GetImageProfile">GetImageProfile</a></h2>
241<div class="doc-section">
242
243<p>GetImageProfile() gets a profile associated with an image by name.</p></ol>
244
245<p>The format of the GetImageProfile method is:</p>
246
247<pre class="code">
248 const StringInfo *GetImageProfile(const Image *image,const char *name)
249</pre>
250
251<p>A description of each parameter follows:</p></ol>
252
253<h5>image</h5>
254<ol><p>the image.</p></ol>
255
256<h5>name</h5>
257<ol><p>the profile name.</p></ol>
258
259 </div>
260<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
261_8c.html" target="source" name="GetNextImageProfile">GetNextImageProfile</a></h2>
262<div class="doc-section">
263
264<p>GetNextImageProfile() gets the next profile name for an image.</p></ol>
265
266<p>The format of the GetNextImageProfile method is:</p>
267
268<pre class="code">
269 char *GetNextImageProfile(const Image *image)
270</pre>
271
272<p>A description of each parameter follows:</p></ol>
273
274<h5>hash_info</h5>
275<ol><p>the hash info.</p></ol>
276
277 </div>
278<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
279_8c.html" target="source" name="ProfileImage">ProfileImage</a></h2>
280<div class="doc-section">
281
282<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>
283
284<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>
285
286<p>The format of the ProfileImage method is:</p>
287
288<pre class="code">
289 MagickBooleanType ProfileImage(Image *image,const char *name,
290 const void *datum,const size_t length,const MagickBooleanType clone)
291</pre>
292
293<p>A description of each parameter follows:</p></ol>
294
295<h5>image</h5>
296<ol><p>the image.</p></ol>
297
298<h5>name</h5>
299<ol><p>Name of profile to add or remove: ICC, IPTC, or generic profile.</p></ol>
300
301<h5>datum</h5>
302<ol><p>the profile data.</p></ol>
303
304<h5>length</h5>
305<ol><p>the length of the profile.</p></ol>
306
307<h5>clone</h5>
308<ol><p>should be MagickFalse.</p></ol>
309
310 </div>
311<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
312_8c.html" target="source" name="RemoveImageProfile">RemoveImageProfile</a></h2>
313<div class="doc-section">
314
315<p>RemoveImageProfile() removes a named profile from the image and returns its value.</p></ol>
316
317<p>The format of the RemoveImageProfile method is:</p>
318
319<pre class="code">
320 void *RemoveImageProfile(Image *image,const char *name)
321</pre>
322
323<p>A description of each parameter follows:</p></ol>
324
325<h5>image</h5>
326<ol><p>the image.</p></ol>
327
328<h5>name</h5>
329<ol><p>the profile name.</p></ol>
330
331 </div>
332<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
333_8c.html" target="source" name="ResetImageProfileIterator">ResetImageProfileIterator</a></h2>
334<div class="doc-section">
335
336<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>
337
338<p>The format of the ResetImageProfileIterator method is:</p>
339
340<pre class="code">
341 ResetImageProfileIterator(Image *image)
342</pre>
343
344<p>A description of each parameter follows:</p></ol>
345
346<h5>image</h5>
347<ol><p>the image.</p></ol>
348
349 </div>
350<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
351_8c.html" target="source" name="SetImageProfile">SetImageProfile</a></h2>
352<div class="doc-section">
353
354<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>
355
356<p>The format of the SetImageProfile method is:</p>
357
358<pre class="code">
359 MagickBooleanType SetImageProfile(Image *image,const char *name,
360 const StringInfo *profile)
361</pre>
362
363<p>A description of each parameter follows:</p></ol>
364
365<h5>image</h5>
366<ol><p>the image.</p></ol>
367
368<h5>name</h5>
369<ol><p>the profile name, for example icc, exif, and 8bim (8bim is the Photoshop wrapper for iptc profiles).</p></ol>
370
371<h5>profile</h5>
372<ol><p>A StringInfo structure that contains the named profile.</p></ol>
373
374 </div>
375<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
376_8c.html" target="source" name="SyncImageProfiles">SyncImageProfiles</a></h2>
377<div class="doc-section">
378
379<p>SyncImageProfiles() synchronizes image properties with the image profiles. Currently we only support updating the EXIF resolution and orientation.</p></ol>
380
381<p>The format of the SyncImageProfiles method is:</p>
382
383<pre class="code">
384 MagickBooleanType SyncImageProfiles(Image *image)
385</pre>
386
387<p>A description of each parameter follows:</p></ol>
388
389<h5>image</h5>
390<ol><p>the image.</p></ol>
391
392 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000393
394</div>
395
396<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000397 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000398 <span id="linkbar-center">
399 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000400 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000401 </span>
402 <span id="linkbar-east">&nbsp;</span>
403 </div>
404 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000405 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000406 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
407 </div>
408 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000409 <script type="text/javascript">
410 var _gaq = _gaq || [];
411 _gaq.push(['_setAccount', 'UA-17690367-1']);
412 _gaq.push(['_trackPageview']);
413
414 (function() {
415 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
416 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
417 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
418 })();
419 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000420</body>
421</html>