Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / d5acfd1575d4281586204dbfd664c5d0a7fdc0d7 / . / www / api / profile.html
blob: f781339d92fd2f77507f41f2797ea8b304c602f7 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]1<!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 +0000[diff] [blame]3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]5 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6 <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 +0000[diff] [blame]8 <style type="text/css" media="all">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]9 @import url("../../www/magick.css");
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]10 </style>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]11 <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 +0000[diff] [blame]25 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]26 <meta name="Distribution" content="Global"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]27</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
45<div class="eastbar">
46
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]47<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]48 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]49</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]50<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]51<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]52 <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 +0000[diff] [blame]65 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]66</div>
67<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]68 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]69</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]71 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]72</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]74 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]75</div>
76<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]77 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]78</div>
79<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]80 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]83 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]84</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]86 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]87</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]89 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]90</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]91<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]92<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]93 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]94</div>
95<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]96 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]97</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]99 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]100 </div>
101<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]104<div class="menu">
105 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
106</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]108 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]112 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Site Map: Links"href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]122<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]123 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124
125<div class="sponsbox">
126<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]127 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy9b5852d2010-03-08 18:18:01 +0000[diff] [blame]128</div>
129<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]130 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy1e1fdf52010-02-14 13:53:19 +0000[diff] [blame]131</div>
132<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]133 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
cristy2744bd92009-11-08 22:57:52 +0000[diff] [blame]134</div>
135<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]136 <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
cristy916e1922009-10-01 12:52:47 +0000[diff] [blame]137</div>
138<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]139 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristyc1c61662009-09-30 14:04:37 +0000[diff] [blame]140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]142 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]143</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]144</div>
145</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]146
147
148</div>
149
150<div class="main">
151
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]152<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>
153
154<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
155_8c.html" target="source" name="CloneImageProfiles">CloneImageProfiles</a></h2>
156<div class="doc-section">
157
158<p>CloneImageProfiles() clones one or more image profiles.</p></ol>
159
160<p>The format of the CloneImageProfiles method is:</p>
161
162<pre class="code">
163 MagickBooleanType CloneImageProfiles(Image *image,
164 const Image *clone_image)
165</pre>
166
167<p>A description of each parameter follows:</p></ol>
168
169<h5>image</h5>
170<ol><p>the image.</p></ol>
171
172<h5>clone_image</h5>
173<ol><p>the clone image.</p></ol>
174
175 </div>
176<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
177_8c.html" target="source" name="DeleteImageProfile">DeleteImageProfile</a></h2>
178<div class="doc-section">
179
180<p>DeleteImageProfile() deletes a profile from the image by its name.</p></ol>
181
182<p>The format of the DeleteImageProfile method is:</p>
183
184<pre class="code">
185 MagickBooleanTyupe DeleteImageProfile(Image *image,const char *name)
186</pre>
187
188<p>A description of each parameter follows:</p></ol>
189
190<h5>image</h5>
191<ol><p>the image.</p></ol>
192
193<h5>name</h5>
194<ol><p>the profile name.</p></ol>
195
196 </div>
197<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
198_8c.html" target="source" name="DestroyImageProfiles">DestroyImageProfiles</a></h2>
199<div class="doc-section">
200
201<p>DestroyImageProfiles() releases memory associated with an image profile map.</p></ol>
202
203<p>The format of the DestroyProfiles method is:</p>
204
205<pre class="code">
206 void DestroyImageProfiles(Image *image)
207</pre>
208
209<p>A description of each parameter follows:</p></ol>
210
211<h5>image</h5>
212<ol><p>the image.</p></ol>
213
214 </div>
215<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
216_8c.html" target="source" name="GetImageProfile">GetImageProfile</a></h2>
217<div class="doc-section">
218
219<p>GetImageProfile() gets a profile associated with an image by name.</p></ol>
220
221<p>The format of the GetImageProfile method is:</p>
222
223<pre class="code">
224 const StringInfo *GetImageProfile(const Image *image,const char *name)
225</pre>
226
227<p>A description of each parameter follows:</p></ol>
228
229<h5>image</h5>
230<ol><p>the image.</p></ol>
231
232<h5>name</h5>
233<ol><p>the profile name.</p></ol>
234
235 </div>
236<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
237_8c.html" target="source" name="GetNextImageProfile">GetNextImageProfile</a></h2>
238<div class="doc-section">
239
240<p>GetNextImageProfile() gets the next profile name for an image.</p></ol>
241
242<p>The format of the GetNextImageProfile method is:</p>
243
244<pre class="code">
245 char *GetNextImageProfile(const Image *image)
246</pre>
247
248<p>A description of each parameter follows:</p></ol>
249
250<h5>hash_info</h5>
251<ol><p>the hash info.</p></ol>
252
253 </div>
254<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
255_8c.html" target="source" name="ProfileImage">ProfileImage</a></h2>
256<div class="doc-section">
257
258<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>
259
260<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>
261
262<p>The format of the ProfileImage method is:</p>
263
264<pre class="code">
265 MagickBooleanType ProfileImage(Image *image,const char *name,
266 const void *datum,const size_t length,const MagickBooleanType clone)
267</pre>
268
269<p>A description of each parameter follows:</p></ol>
270
271<h5>image</h5>
272<ol><p>the image.</p></ol>
273
274<h5>name</h5>
275<ol><p>Name of profile to add or remove: ICC, IPTC, or generic profile.</p></ol>
276
277<h5>datum</h5>
278<ol><p>the profile data.</p></ol>
279
280<h5>length</h5>
281<ol><p>the length of the profile.</p></ol>
282
283<h5>clone</h5>
284<ol><p>should be MagickFalse.</p></ol>
285
286 </div>
287<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
288_8c.html" target="source" name="RemoveImageProfile">RemoveImageProfile</a></h2>
289<div class="doc-section">
290
291<p>RemoveImageProfile() removes a named profile from the image and returns its value.</p></ol>
292
293<p>The format of the RemoveImageProfile method is:</p>
294
295<pre class="code">
296 void *RemoveImageProfile(Image *image,const char *name)
297</pre>
298
299<p>A description of each parameter follows:</p></ol>
300
301<h5>image</h5>
302<ol><p>the image.</p></ol>
303
304<h5>name</h5>
305<ol><p>the profile name.</p></ol>
306
307 </div>
308<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
309_8c.html" target="source" name="ResetImageProfileIterator">ResetImageProfileIterator</a></h2>
310<div class="doc-section">
311
312<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>
313
314<p>The format of the ResetImageProfileIterator method is:</p>
315
316<pre class="code">
317 ResetImageProfileIterator(Image *image)
318</pre>
319
320<p>A description of each parameter follows:</p></ol>
321
322<h5>image</h5>
323<ol><p>the image.</p></ol>
324
325 </div>
326<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
327_8c.html" target="source" name="SetImageProfile">SetImageProfile</a></h2>
328<div class="doc-section">
329
330<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>
331
332<p>The format of the SetImageProfile method is:</p>
333
334<pre class="code">
335 MagickBooleanType SetImageProfile(Image *image,const char *name,
336 const StringInfo *profile)
337</pre>
338
339<p>A description of each parameter follows:</p></ol>
340
341<h5>image</h5>
342<ol><p>the image.</p></ol>
343
344<h5>name</h5>
345<ol><p>the profile name, for example icc, exif, and 8bim (8bim is the Photoshop wrapper for iptc profiles).</p></ol>
346
347<h5>profile</h5>
348<ol><p>A StringInfo structure that contains the named profile.</p></ol>
349
350 </div>
351<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
352_8c.html" target="source" name="SyncImageProfiles">SyncImageProfiles</a></h2>
353<div class="doc-section">
354
355<p>SyncImageProfiles() synchronizes image properties with the image profiles. Currently we only support updating the EXIF resolution and orientation.</p></ol>
356
357<p>The format of the SyncImageProfiles method is:</p>
358
359<pre class="code">
360 MagickBooleanType SyncImageProfiles(Image *image)
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 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]369
370</div>
371
372<div id="linkbar">
373 <!-- <span id="linkbar-west">&nbsp;</span> -->
374 <span id="linkbar-center">
375 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristy85278ed2010-05-31 15:10:05 +0000[diff] [blame]376 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]377 </span>
378 <span id="linkbar-east">&nbsp;</span>
379 </div>
380 <div class="footer">
381 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
382 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
383 </div>
384 <div style="clear: both; margin: 0; width: 100%; "></div>
385</body>
386</html>