blob: 3c70723c8856c5354c8485310fa3fe01284ae789 [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>
cristy3de29cc2010-04-15 02:34:44 +00005 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +00006 <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 +00008 <style type="text/css" media="all">
cristy3eaa0ef2010-03-06 20:35:26 +00009 @import url("../../www/magick.css");
cristy3de29cc2010-04-15 02:34:44 +000010 </style>
cristy3ed852e2009-09-05 21:47:34 +000011 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
12 <title>ImageMagick: MagickCore, C API for ImageMagick: Dealing with Image Profiles</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:, dealing, with, image, profiles, 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 +000025 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000026 <meta name="Distribution" content="Global"/>
cristy3eaa0ef2010-03-06 20:35:26 +000027</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
cristyce69bb02010-07-27 19:49:46 +000045<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000046
cristy3ed852e2009-09-05 21:47:34 +000047<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000048 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000049</div>
cristy3eaa0ef2010-03-06 20:35:26 +000050<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000051<div class="menu">
cristybb503372010-05-27 20:51:26 +000052 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
53</div>
54<div class="sub">
55 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
56</div>
57<div class="sub">
58 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
59</div>
60<div class="sub">
61 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
62</div>
63<div class="sep"></div>
64<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000065 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000066</div>
67<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000068 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</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: Options" href="../../www/command-line-options.html">Options</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: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000075</div>
76<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000077 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000078</div>
79<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000080 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000081</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000083 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +000084</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000086 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000087</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000089 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +000090</div>
cristy3eaa0ef2010-03-06 20:35:26 +000091<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000092<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000093 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +000094</div>
95<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000096 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</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: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000100 </div>
101<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000102 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000103</div>
cristybb503372010-05-27 20:51:26 +0000104<div class="menu">
105 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
106</div>
cristy3ed852e2009-09-05 21:47:34 +0000107<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000108 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000111<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000112 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000115<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000116 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000119 <a title="Site Map: Links"href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000120</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000122<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000123 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000124
125<div class="sponsbox">
126<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000127 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy9b5852d2010-03-08 18:18:01 +0000128</div>
129<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000130 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy1e1fdf52010-02-14 13:53:19 +0000131</div>
132<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000133 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
cristy2744bd92009-11-08 22:57:52 +0000134</div>
135<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000136 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristyc1c61662009-09-30 14:04:37 +0000137</div>
138<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000139 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristyb4c03bb2009-09-27 13:55:46 +0000140</div>
cristya8902942010-07-30 00:49:52 +0000141<div class="sponsor">
142 <a title="Sponsor: Online-Magazin" href="http://www.unkostenbeitrag.de/">Online-Magazin</a><!-- 20101101000200 -->
143</div>
cristybac7a162010-06-15 19:57:29 +0000144</div>
cristy3ed852e2009-09-05 21:47:34 +0000145</div>
cristyce69bb02010-07-27 19:49:46 +0000146</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000147
cristyce69bb02010-07-27 19:49:46 +0000148<div class="eastbar">
149 <script type="text/javascript">
150 <!--
151 google_ad_client = "pub-3129977114552745";
152 /* 160x600, created 7/27/10 */
153 google_ad_slot = "0574824969";
154 google_ad_width = 160;
155 google_ad_height = 600;
156 //-->
157 </script>
158 <script type="text/javascript"
159 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
160 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000161</div>
162
163<div class="main">
164
cristy3ed852e2009-09-05 21:47:34 +0000165<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>
166
167<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
168_8c.html" target="source" name="CloneImageProfiles">CloneImageProfiles</a></h2>
169<div class="doc-section">
170
171<p>CloneImageProfiles() clones one or more image profiles.</p></ol>
172
173<p>The format of the CloneImageProfiles method is:</p>
174
175<pre class="code">
176 MagickBooleanType CloneImageProfiles(Image *image,
177 const Image *clone_image)
178</pre>
179
180<p>A description of each parameter follows:</p></ol>
181
182<h5>image</h5>
183<ol><p>the image.</p></ol>
184
185<h5>clone_image</h5>
186<ol><p>the clone image.</p></ol>
187
188 </div>
189<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
190_8c.html" target="source" name="DeleteImageProfile">DeleteImageProfile</a></h2>
191<div class="doc-section">
192
193<p>DeleteImageProfile() deletes a profile from the image by its name.</p></ol>
194
195<p>The format of the DeleteImageProfile method is:</p>
196
197<pre class="code">
198 MagickBooleanTyupe DeleteImageProfile(Image *image,const char *name)
199</pre>
200
201<p>A description of each parameter follows:</p></ol>
202
203<h5>image</h5>
204<ol><p>the image.</p></ol>
205
206<h5>name</h5>
207<ol><p>the profile name.</p></ol>
208
209 </div>
210<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
211_8c.html" target="source" name="DestroyImageProfiles">DestroyImageProfiles</a></h2>
212<div class="doc-section">
213
214<p>DestroyImageProfiles() releases memory associated with an image profile map.</p></ol>
215
216<p>The format of the DestroyProfiles method is:</p>
217
218<pre class="code">
219 void DestroyImageProfiles(Image *image)
220</pre>
221
222<p>A description of each parameter follows:</p></ol>
223
224<h5>image</h5>
225<ol><p>the image.</p></ol>
226
227 </div>
228<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
229_8c.html" target="source" name="GetImageProfile">GetImageProfile</a></h2>
230<div class="doc-section">
231
232<p>GetImageProfile() gets a profile associated with an image by name.</p></ol>
233
234<p>The format of the GetImageProfile method is:</p>
235
236<pre class="code">
237 const StringInfo *GetImageProfile(const Image *image,const char *name)
238</pre>
239
240<p>A description of each parameter follows:</p></ol>
241
242<h5>image</h5>
243<ol><p>the image.</p></ol>
244
245<h5>name</h5>
246<ol><p>the profile name.</p></ol>
247
248 </div>
249<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
250_8c.html" target="source" name="GetNextImageProfile">GetNextImageProfile</a></h2>
251<div class="doc-section">
252
253<p>GetNextImageProfile() gets the next profile name for an image.</p></ol>
254
255<p>The format of the GetNextImageProfile method is:</p>
256
257<pre class="code">
258 char *GetNextImageProfile(const Image *image)
259</pre>
260
261<p>A description of each parameter follows:</p></ol>
262
263<h5>hash_info</h5>
264<ol><p>the hash info.</p></ol>
265
266 </div>
267<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
268_8c.html" target="source" name="ProfileImage">ProfileImage</a></h2>
269<div class="doc-section">
270
271<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>
272
273<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>
274
275<p>The format of the ProfileImage method is:</p>
276
277<pre class="code">
278 MagickBooleanType ProfileImage(Image *image,const char *name,
279 const void *datum,const size_t length,const MagickBooleanType clone)
280</pre>
281
282<p>A description of each parameter follows:</p></ol>
283
284<h5>image</h5>
285<ol><p>the image.</p></ol>
286
287<h5>name</h5>
288<ol><p>Name of profile to add or remove: ICC, IPTC, or generic profile.</p></ol>
289
290<h5>datum</h5>
291<ol><p>the profile data.</p></ol>
292
293<h5>length</h5>
294<ol><p>the length of the profile.</p></ol>
295
296<h5>clone</h5>
297<ol><p>should be MagickFalse.</p></ol>
298
299 </div>
300<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
301_8c.html" target="source" name="RemoveImageProfile">RemoveImageProfile</a></h2>
302<div class="doc-section">
303
304<p>RemoveImageProfile() removes a named profile from the image and returns its value.</p></ol>
305
306<p>The format of the RemoveImageProfile method is:</p>
307
308<pre class="code">
309 void *RemoveImageProfile(Image *image,const char *name)
310</pre>
311
312<p>A description of each parameter follows:</p></ol>
313
314<h5>image</h5>
315<ol><p>the image.</p></ol>
316
317<h5>name</h5>
318<ol><p>the profile name.</p></ol>
319
320 </div>
321<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
322_8c.html" target="source" name="ResetImageProfileIterator">ResetImageProfileIterator</a></h2>
323<div class="doc-section">
324
325<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>
326
327<p>The format of the ResetImageProfileIterator method is:</p>
328
329<pre class="code">
330 ResetImageProfileIterator(Image *image)
331</pre>
332
333<p>A description of each parameter follows:</p></ol>
334
335<h5>image</h5>
336<ol><p>the image.</p></ol>
337
338 </div>
339<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
340_8c.html" target="source" name="SetImageProfile">SetImageProfile</a></h2>
341<div class="doc-section">
342
343<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>
344
345<p>The format of the SetImageProfile method is:</p>
346
347<pre class="code">
348 MagickBooleanType SetImageProfile(Image *image,const char *name,
349 const StringInfo *profile)
350</pre>
351
352<p>A description of each parameter follows:</p></ol>
353
354<h5>image</h5>
355<ol><p>the image.</p></ol>
356
357<h5>name</h5>
358<ol><p>the profile name, for example icc, exif, and 8bim (8bim is the Photoshop wrapper for iptc profiles).</p></ol>
359
360<h5>profile</h5>
361<ol><p>A StringInfo structure that contains the named profile.</p></ol>
362
363 </div>
364<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
365_8c.html" target="source" name="SyncImageProfiles">SyncImageProfiles</a></h2>
366<div class="doc-section">
367
368<p>SyncImageProfiles() synchronizes image properties with the image profiles. Currently we only support updating the EXIF resolution and orientation.</p></ol>
369
370<p>The format of the SyncImageProfiles method is:</p>
371
372<pre class="code">
373 MagickBooleanType SyncImageProfiles(Image *image)
374</pre>
375
376<p>A description of each parameter follows:</p></ol>
377
378<h5>image</h5>
379<ol><p>the image.</p></ol>
380
381 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000382
383</div>
384
385<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000386 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000387 <span id="linkbar-center">
388 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000389 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000390 </span>
391 <span id="linkbar-east">&nbsp;</span>
392 </div>
393 <div class="footer">
394 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
395 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
396 </div>
397 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000398 <script type="text/javascript">
399 var _gaq = _gaq || [];
400 _gaq.push(['_setAccount', 'UA-17690367-1']);
401 _gaq.push(['_trackPageview']);
402
403 (function() {
404 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
405 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
406 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
407 })();
408 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000409</body>
410</html>