blob: aa3c9b6a7a3bfc73f4a3fee8387b86c5fa9b0d7c [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +00001<!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 +00003<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" 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"/>
cristyffb69ed2010-12-25 00:06:48 +000012 <meta name="Description" content="ImageMagick is a software suite to create, edit, or compose 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"/>
cristy3c98a4f2010-08-13 20:09:41 +000024 <link rel="icon" href="../../images/wand.png" sizes="32x32"/>
25 <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>
cristy3eaa0ef2010-03-06 20:35:26 +000030</head>
31
32<body id="www-imagemagick-org">
33<div class="titlebar">
34<a href="../../index.html">
35 <img src="../../images/script.png" alt="[ImageMagick]"
36 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
37<a href="http://www.networkredux.com">
38 <img src="../../images/networkredux.png" alt="[sponsor]"
39 style="margin: 45px auto; border: 0px; float: left;" /></a>
40<a href="http://www.imagemagick.org/discourse-server/">
41 <img src="../../images/logo.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43<a href="../../index.html">
44 <img src="../../images/sprite.jpg" alt=""
45 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
46</div>
47
cristyce69bb02010-07-27 19:49:46 +000048<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000049
cristy3ed852e2009-09-05 21:47:34 +000050<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000051 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000052</div>
cristy3eaa0ef2010-03-06 20:35:26 +000053<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000054<div class="menu">
cristybb503372010-05-27 20:51:26 +000055 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
56</div>
57<div class="sub">
58 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
59</div>
60<div class="sub">
61 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
62</div>
63<div class="sub">
64 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
65</div>
66<div class="sep"></div>
67<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000068 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000069</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000071 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000072</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000074 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000075</div>
76<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000077 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000078</div>
79<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000080 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000081</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000083 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000084</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000086 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +000087</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000089 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000090</div>
91<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000092 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +000093</div>
cristy3eaa0ef2010-03-06 20:35:26 +000094<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000095<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000096 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +000097</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000099 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000102 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000103 </div>
104<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000105 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000106</div>
cristybb503372010-05-27 20:51:26 +0000107<div class="menu">
108 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
109</div>
cristy3ed852e2009-09-05 21:47:34 +0000110<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000111 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000112</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000113<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000114<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000115 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000116</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000117<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000118<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000119 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000120</div>
121<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000122 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000123</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000124<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000125<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000126 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000127
128<div class="sponsbox">
129<div class="sponsor">
cristy307ba182010-12-25 01:00:34 +0000130 <a title="Sponsor: alaTest.com" href="http://alatest.com">alaTest.com</a><!-- 20110801000300 -->
cristy7d52cd62010-10-01 17:26:59 +0000131</div>
132<div class="sponsor">
133 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000134</div>
135<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000136 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
137</div>
138<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000139 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000142 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy9b5852d2010-03-08 18:18:01 +0000143</div>
144<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000145 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy1e1fdf52010-02-14 13:53:19 +0000146</div>
147<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000148 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
cristyc1c61662009-09-30 14:04:37 +0000149</div>
cristybac7a162010-06-15 19:57:29 +0000150</div>
cristy3ed852e2009-09-05 21:47:34 +0000151</div>
cristyce69bb02010-07-27 19:49:46 +0000152</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000153
cristyce69bb02010-07-27 19:49:46 +0000154<div class="eastbar">
155 <script type="text/javascript">
156 <!--
157 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000158 google_ad_slot = "0574824969";
159 google_ad_width = 160;
160 google_ad_height = 600;
161 //-->
162 </script>
163 <script type="text/javascript"
164 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
165 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000166</div>
167
168<div class="main">
169
cristy307ba182010-12-25 01:00:34 +0000170<h1>Module profile
171 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000172<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>
173
174<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
175_8c.html" target="source" name="CloneImageProfiles">CloneImageProfiles</a></h2>
176<div class="doc-section">
177
178<p>CloneImageProfiles() clones one or more image profiles.</p></ol>
179
180<p>The format of the CloneImageProfiles method is:</p>
181
182<pre class="code">
183 MagickBooleanType CloneImageProfiles(Image *image,
184 const Image *clone_image)
185</pre>
186
187<p>A description of each parameter follows:</p></ol>
188
189<h5>image</h5>
190<ol><p>the image.</p></ol>
191
192<h5>clone_image</h5>
193<ol><p>the clone image.</p></ol>
194
195 </div>
196<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
197_8c.html" target="source" name="DeleteImageProfile">DeleteImageProfile</a></h2>
198<div class="doc-section">
199
200<p>DeleteImageProfile() deletes a profile from the image by its name.</p></ol>
201
202<p>The format of the DeleteImageProfile method is:</p>
203
204<pre class="code">
205 MagickBooleanTyupe DeleteImageProfile(Image *image,const char *name)
206</pre>
207
208<p>A description of each parameter follows:</p></ol>
209
210<h5>image</h5>
211<ol><p>the image.</p></ol>
212
213<h5>name</h5>
214<ol><p>the profile name.</p></ol>
215
216 </div>
217<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
218_8c.html" target="source" name="DestroyImageProfiles">DestroyImageProfiles</a></h2>
219<div class="doc-section">
220
221<p>DestroyImageProfiles() releases memory associated with an image profile map.</p></ol>
222
223<p>The format of the DestroyProfiles method is:</p>
224
225<pre class="code">
226 void DestroyImageProfiles(Image *image)
227</pre>
228
229<p>A description of each parameter follows:</p></ol>
230
231<h5>image</h5>
232<ol><p>the image.</p></ol>
233
234 </div>
235<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
236_8c.html" target="source" name="GetImageProfile">GetImageProfile</a></h2>
237<div class="doc-section">
238
239<p>GetImageProfile() gets a profile associated with an image by name.</p></ol>
240
241<p>The format of the GetImageProfile method is:</p>
242
243<pre class="code">
244 const StringInfo *GetImageProfile(const Image *image,const char *name)
245</pre>
246
247<p>A description of each parameter follows:</p></ol>
248
249<h5>image</h5>
250<ol><p>the image.</p></ol>
251
252<h5>name</h5>
253<ol><p>the profile name.</p></ol>
254
255 </div>
256<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
257_8c.html" target="source" name="GetNextImageProfile">GetNextImageProfile</a></h2>
258<div class="doc-section">
259
260<p>GetNextImageProfile() gets the next profile name for an image.</p></ol>
261
262<p>The format of the GetNextImageProfile method is:</p>
263
264<pre class="code">
265 char *GetNextImageProfile(const Image *image)
266</pre>
267
268<p>A description of each parameter follows:</p></ol>
269
270<h5>hash_info</h5>
271<ol><p>the hash info.</p></ol>
272
273 </div>
274<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
275_8c.html" target="source" name="ProfileImage">ProfileImage</a></h2>
276<div class="doc-section">
277
278<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>
279
280<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>
281
282<p>The format of the ProfileImage method is:</p>
283
284<pre class="code">
285 MagickBooleanType ProfileImage(Image *image,const char *name,
286 const void *datum,const size_t length,const MagickBooleanType clone)
287</pre>
288
289<p>A description of each parameter follows:</p></ol>
290
291<h5>image</h5>
292<ol><p>the image.</p></ol>
293
294<h5>name</h5>
295<ol><p>Name of profile to add or remove: ICC, IPTC, or generic profile.</p></ol>
296
297<h5>datum</h5>
298<ol><p>the profile data.</p></ol>
299
300<h5>length</h5>
301<ol><p>the length of the profile.</p></ol>
302
303<h5>clone</h5>
304<ol><p>should be MagickFalse.</p></ol>
305
306 </div>
307<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
308_8c.html" target="source" name="RemoveImageProfile">RemoveImageProfile</a></h2>
309<div class="doc-section">
310
311<p>RemoveImageProfile() removes a named profile from the image and returns its value.</p></ol>
312
313<p>The format of the RemoveImageProfile method is:</p>
314
315<pre class="code">
316 void *RemoveImageProfile(Image *image,const char *name)
317</pre>
318
319<p>A description of each parameter follows:</p></ol>
320
321<h5>image</h5>
322<ol><p>the image.</p></ol>
323
324<h5>name</h5>
325<ol><p>the profile name.</p></ol>
326
327 </div>
328<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
329_8c.html" target="source" name="ResetImageProfileIterator">ResetImageProfileIterator</a></h2>
330<div class="doc-section">
331
332<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>
333
334<p>The format of the ResetImageProfileIterator method is:</p>
335
336<pre class="code">
337 ResetImageProfileIterator(Image *image)
338</pre>
339
340<p>A description of each parameter follows:</p></ol>
341
342<h5>image</h5>
343<ol><p>the image.</p></ol>
344
345 </div>
346<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
347_8c.html" target="source" name="SetImageProfile">SetImageProfile</a></h2>
348<div class="doc-section">
349
350<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>
351
352<p>The format of the SetImageProfile method is:</p>
353
354<pre class="code">
355 MagickBooleanType SetImageProfile(Image *image,const char *name,
356 const StringInfo *profile)
357</pre>
358
359<p>A description of each parameter follows:</p></ol>
360
361<h5>image</h5>
362<ol><p>the image.</p></ol>
363
364<h5>name</h5>
365<ol><p>the profile name, for example icc, exif, and 8bim (8bim is the Photoshop wrapper for iptc profiles).</p></ol>
366
367<h5>profile</h5>
368<ol><p>A StringInfo structure that contains the named profile.</p></ol>
369
370 </div>
371<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
372_8c.html" target="source" name="SyncImageProfiles">SyncImageProfiles</a></h2>
373<div class="doc-section">
374
375<p>SyncImageProfiles() synchronizes image properties with the image profiles. Currently we only support updating the EXIF resolution and orientation.</p></ol>
376
377<p>The format of the SyncImageProfiles method is:</p>
378
379<pre class="code">
380 MagickBooleanType SyncImageProfiles(Image *image)
381</pre>
382
383<p>A description of each parameter follows:</p></ol>
384
385<h5>image</h5>
386<ol><p>the image.</p></ol>
387
388 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000389
390</div>
391
392<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000393 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000394 <span id="linkbar-center">
395 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000396 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000397 </span>
398 <span id="linkbar-east">&nbsp;</span>
399 </div>
400 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000401 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000402 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
403 </div>
404 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000405 <script type="text/javascript">
406 var _gaq = _gaq || [];
407 _gaq.push(['_setAccount', 'UA-17690367-1']);
408 _gaq.push(['_trackPageview']);
409
410 (function() {
411 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
412 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
413 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
414 })();
415 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000416</body>
417</html>