blob: 4d1052c7a9192286b05fba4dbb17a67a4e4e08c7 [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>
cristybac7a162010-06-15 19:57:29 +0000141</div>
cristy3ed852e2009-09-05 21:47:34 +0000142</div>
cristyce69bb02010-07-27 19:49:46 +0000143</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000144
cristyce69bb02010-07-27 19:49:46 +0000145<div class="eastbar">
146 <script type="text/javascript">
147 <!--
148 google_ad_client = "pub-3129977114552745";
149 /* 160x600, created 7/27/10 */
150 google_ad_slot = "0574824969";
151 google_ad_width = 160;
152 google_ad_height = 600;
153 //-->
154 </script>
155 <script type="text/javascript"
156 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
157 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000158</div>
159
160<div class="main">
161
cristy3ed852e2009-09-05 21:47:34 +0000162<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>
163
164<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
165_8c.html" target="source" name="CloneImageProfiles">CloneImageProfiles</a></h2>
166<div class="doc-section">
167
168<p>CloneImageProfiles() clones one or more image profiles.</p></ol>
169
170<p>The format of the CloneImageProfiles method is:</p>
171
172<pre class="code">
173 MagickBooleanType CloneImageProfiles(Image *image,
174 const Image *clone_image)
175</pre>
176
177<p>A description of each parameter follows:</p></ol>
178
179<h5>image</h5>
180<ol><p>the image.</p></ol>
181
182<h5>clone_image</h5>
183<ol><p>the clone image.</p></ol>
184
185 </div>
186<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
187_8c.html" target="source" name="DeleteImageProfile">DeleteImageProfile</a></h2>
188<div class="doc-section">
189
190<p>DeleteImageProfile() deletes a profile from the image by its name.</p></ol>
191
192<p>The format of the DeleteImageProfile method is:</p>
193
194<pre class="code">
195 MagickBooleanTyupe DeleteImageProfile(Image *image,const char *name)
196</pre>
197
198<p>A description of each parameter follows:</p></ol>
199
200<h5>image</h5>
201<ol><p>the image.</p></ol>
202
203<h5>name</h5>
204<ol><p>the profile name.</p></ol>
205
206 </div>
207<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
208_8c.html" target="source" name="DestroyImageProfiles">DestroyImageProfiles</a></h2>
209<div class="doc-section">
210
211<p>DestroyImageProfiles() releases memory associated with an image profile map.</p></ol>
212
213<p>The format of the DestroyProfiles method is:</p>
214
215<pre class="code">
216 void DestroyImageProfiles(Image *image)
217</pre>
218
219<p>A description of each parameter follows:</p></ol>
220
221<h5>image</h5>
222<ol><p>the image.</p></ol>
223
224 </div>
225<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
226_8c.html" target="source" name="GetImageProfile">GetImageProfile</a></h2>
227<div class="doc-section">
228
229<p>GetImageProfile() gets a profile associated with an image by name.</p></ol>
230
231<p>The format of the GetImageProfile method is:</p>
232
233<pre class="code">
234 const StringInfo *GetImageProfile(const Image *image,const char *name)
235</pre>
236
237<p>A description of each parameter follows:</p></ol>
238
239<h5>image</h5>
240<ol><p>the image.</p></ol>
241
242<h5>name</h5>
243<ol><p>the profile name.</p></ol>
244
245 </div>
246<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
247_8c.html" target="source" name="GetNextImageProfile">GetNextImageProfile</a></h2>
248<div class="doc-section">
249
250<p>GetNextImageProfile() gets the next profile name for an image.</p></ol>
251
252<p>The format of the GetNextImageProfile method is:</p>
253
254<pre class="code">
255 char *GetNextImageProfile(const Image *image)
256</pre>
257
258<p>A description of each parameter follows:</p></ol>
259
260<h5>hash_info</h5>
261<ol><p>the hash info.</p></ol>
262
263 </div>
264<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
265_8c.html" target="source" name="ProfileImage">ProfileImage</a></h2>
266<div class="doc-section">
267
268<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>
269
270<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>
271
272<p>The format of the ProfileImage method is:</p>
273
274<pre class="code">
275 MagickBooleanType ProfileImage(Image *image,const char *name,
276 const void *datum,const size_t length,const MagickBooleanType clone)
277</pre>
278
279<p>A description of each parameter follows:</p></ol>
280
281<h5>image</h5>
282<ol><p>the image.</p></ol>
283
284<h5>name</h5>
285<ol><p>Name of profile to add or remove: ICC, IPTC, or generic profile.</p></ol>
286
287<h5>datum</h5>
288<ol><p>the profile data.</p></ol>
289
290<h5>length</h5>
291<ol><p>the length of the profile.</p></ol>
292
293<h5>clone</h5>
294<ol><p>should be MagickFalse.</p></ol>
295
296 </div>
297<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
298_8c.html" target="source" name="RemoveImageProfile">RemoveImageProfile</a></h2>
299<div class="doc-section">
300
301<p>RemoveImageProfile() removes a named profile from the image and returns its value.</p></ol>
302
303<p>The format of the RemoveImageProfile method is:</p>
304
305<pre class="code">
306 void *RemoveImageProfile(Image *image,const char *name)
307</pre>
308
309<p>A description of each parameter follows:</p></ol>
310
311<h5>image</h5>
312<ol><p>the image.</p></ol>
313
314<h5>name</h5>
315<ol><p>the profile name.</p></ol>
316
317 </div>
318<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
319_8c.html" target="source" name="ResetImageProfileIterator">ResetImageProfileIterator</a></h2>
320<div class="doc-section">
321
322<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>
323
324<p>The format of the ResetImageProfileIterator method is:</p>
325
326<pre class="code">
327 ResetImageProfileIterator(Image *image)
328</pre>
329
330<p>A description of each parameter follows:</p></ol>
331
332<h5>image</h5>
333<ol><p>the image.</p></ol>
334
335 </div>
336<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
337_8c.html" target="source" name="SetImageProfile">SetImageProfile</a></h2>
338<div class="doc-section">
339
340<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>
341
342<p>The format of the SetImageProfile method is:</p>
343
344<pre class="code">
345 MagickBooleanType SetImageProfile(Image *image,const char *name,
346 const StringInfo *profile)
347</pre>
348
349<p>A description of each parameter follows:</p></ol>
350
351<h5>image</h5>
352<ol><p>the image.</p></ol>
353
354<h5>name</h5>
355<ol><p>the profile name, for example icc, exif, and 8bim (8bim is the Photoshop wrapper for iptc profiles).</p></ol>
356
357<h5>profile</h5>
358<ol><p>A StringInfo structure that contains the named profile.</p></ol>
359
360 </div>
361<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
362_8c.html" target="source" name="SyncImageProfiles">SyncImageProfiles</a></h2>
363<div class="doc-section">
364
365<p>SyncImageProfiles() synchronizes image properties with the image profiles. Currently we only support updating the EXIF resolution and orientation.</p></ol>
366
367<p>The format of the SyncImageProfiles method is:</p>
368
369<pre class="code">
370 MagickBooleanType SyncImageProfiles(Image *image)
371</pre>
372
373<p>A description of each parameter follows:</p></ol>
374
375<h5>image</h5>
376<ol><p>the image.</p></ol>
377
378 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000379
380</div>
381
382<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000383 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000384 <span id="linkbar-center">
385 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristyce69bb02010-07-27 19:49:46 +0000386 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000387 </span>
388 <span id="linkbar-east">&nbsp;</span>
389 </div>
390 <div class="footer">
391 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
392 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
393 </div>
394 <div style="clear: both; margin: 0; width: 100%; "></div>
395</body>
396</html>