Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 745c33bedb7adf2679753c548bf7c4e1d658f99c / . / www / api / profile.html
blob: 28a5af23a8fdc991afbf19c6720c70eb90d7b4aa [file] [log] [blame]
cristyb32b90a2009-09-07 21:45:48 +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">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<head>
5 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
6 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
7 <style type="text/css" media="screen,projection"><!--
8 @import url("../../www/magick.css");
9 --></style>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]10 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
11 <title>ImageMagick: MagickCore, C API for ImageMagick: Dealing with Image Profiles</title>
12 <meta http-equiv="Content-Language" content="en-US"/>
13 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
14 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
15 <meta name="Generator" content="PHP"/>
16 <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"/>
17 <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."/>
18 <meta name="Rating" content="GENERAL"/>
19 <meta name="Robots" content="INDEX, FOLLOW"/>
20 <meta name="Generator" content="ImageMagick Studio LLC"/>
21 <meta name="Author" content="ImageMagick Studio LLC"/>
22 <meta name="Revisit-after" content="2 DAYS"/>
23 <meta name="Resource-type" content="document"/>
24 <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
25 <meta name="Distribution" content="Global"/>
cristyb32b90a2009-09-07 21:45:48 +0000[diff] [blame]26</head>
27
28<body id="www-imagemagick-org">
29<div class="titlebar">
30<a href="../../index.html">
31 <img src="../../images/script.png" alt="[ImageMagick]"
32 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
33<a href="http://www.networkredux.com">
34 <img src="../../images/networkredux.png" alt="[sponsor]"
35 style="margin: 45px auto; border: 0px; float: left;" /></a>
36<a href="http://www.imagemagick.org/discourse-server/">
37 <img src="../../images/logo.jpg" alt=""
38 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
39<a href="../../index.html">
40 <img src="../../images/sprite.jpg" alt=""
41 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
42</div>
43
44<div class="eastbar">
45
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]46<div class="menu">
47 <a href="../../index.html">About ImageMagick</a>
48</div>
cristyb32b90a2009-09-07 21:45:48 +0000[diff] [blame]49<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]50<div class="menu">
51 <a href="../../www/command-line-tools.html">Command-line Tools</a>
52</div>
53<div class="sub">
54 <a href="../../www/command-line-processing.html">Processing</a>
55</div>
56<div class="sub">
57 <a href="../../www/command-line-options.html">Options</a>
58</div>
59<div class="sub">
60 <a href="http://www.imagemagick.org/Usage/">Usage</a>
61</div>
62<div class="menu">
63 <a href="../../www/api.html">Program Interfaces</a>
64</div>
65<div class="sub">
66 <a href="../../www/magick-wand.html">MagickWand</a>
67</div>
68<div class="sub">
69 <a href="../../www/magick-core.html">MagickCore</a>
70</div>
71<div class="sub">
72 <a href="../../www/perl-magick.html">PerlMagick</a>
73</div>
74<div class="sub">
75 <a href="../../Magick++/">Magick++</a>
76</div>
77<div class="menu">
78 <a href="../../www/architecture.html">Architecture</a>
79</div>
cristyb32b90a2009-09-07 21:45:48 +0000[diff] [blame]80<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81<div class="menu">
82 <a href="../../www/install-source.html">Install from Source</a>
83</div>
84<div class="sub">
85 <a href="../../www/install-source.html#unix">Unix</a>
86</div>
87<div class="sub">
88 <a href="../../www/install-source.html#windows">Windows</a>
89 </div>
90<div class="menu">
91 <a href="../../www/binary-releases.html">Binary Releases</a>
92</div>
93<div class="sub">
94 <a href="../../www/binary-releases.html#unix">Unix</a>
95</div>
96<div class="sub">
97 <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
98</div>
99<div class="sub">
100 <a href="../../www/binary-releases.html#windows">Windows</a>
101</div>
102<div class="menu">
103 <a href="../../www/resources.html">Resources</a>
104</div>
cristyb32b90a2009-09-07 21:45:48 +0000[diff] [blame]105<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106<div class="menu">
107 <a href="../../www/download.html">Download</a>
108</div>
cristyb32b90a2009-09-07 21:45:48 +0000[diff] [blame]109<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]110<div class="menu">
111 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
112</div>
cristyb32b90a2009-09-07 21:45:48 +0000[diff] [blame]113<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114<div class="menu">
115 <a href="../../www/sitemap.html">Site Map</a>
116</div>
117<div class="sub">
118 <a href="../../www/links.html">Links</a>
119</div>
cristyb32b90a2009-09-07 21:45:48 +0000[diff] [blame]120<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]121<div class="menu">
122 <a href="../../www/sponsors.html">Sponsors:</a>
123
124<div class="sponsbox">
125<div class="sponsor">
126 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
127</div>
128<div class="sponsor">
129 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
130</div>
131<div class="sponsor">
132 <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
133</div>
134<div class="sponsor">
135 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
136</div>
137<div class="sponsor">
138 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201001010120 Buchhorn -->
139</div>
140</div>
141</div>
cristyb32b90a2009-09-07 21:45:48 +0000[diff] [blame]142
143
144</div>
145
146<div class="main">
147
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]148<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>
149
150<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
151_8c.html" target="source" name="CloneImageProfiles">CloneImageProfiles</a></h2>
152<div class="doc-section">
153
154<p>CloneImageProfiles() clones one or more image profiles.</p></ol>
155
156<p>The format of the CloneImageProfiles method is:</p>
157
158<pre class="code">
159 MagickBooleanType CloneImageProfiles(Image *image,
160 const Image *clone_image)
161</pre>
162
163<p>A description of each parameter follows:</p></ol>
164
165<h5>image</h5>
166<ol><p>the image.</p></ol>
167
168<h5>clone_image</h5>
169<ol><p>the clone image.</p></ol>
170
171 </div>
172<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
173_8c.html" target="source" name="DeleteImageProfile">DeleteImageProfile</a></h2>
174<div class="doc-section">
175
176<p>DeleteImageProfile() deletes a profile from the image by its name.</p></ol>
177
178<p>The format of the DeleteImageProfile method is:</p>
179
180<pre class="code">
181 MagickBooleanTyupe DeleteImageProfile(Image *image,const char *name)
182</pre>
183
184<p>A description of each parameter follows:</p></ol>
185
186<h5>image</h5>
187<ol><p>the image.</p></ol>
188
189<h5>name</h5>
190<ol><p>the profile name.</p></ol>
191
192 </div>
193<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
194_8c.html" target="source" name="DestroyImageProfiles">DestroyImageProfiles</a></h2>
195<div class="doc-section">
196
197<p>DestroyImageProfiles() releases memory associated with an image profile map.</p></ol>
198
199<p>The format of the DestroyProfiles method is:</p>
200
201<pre class="code">
202 void DestroyImageProfiles(Image *image)
203</pre>
204
205<p>A description of each parameter follows:</p></ol>
206
207<h5>image</h5>
208<ol><p>the image.</p></ol>
209
210 </div>
211<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
212_8c.html" target="source" name="GetImageProfile">GetImageProfile</a></h2>
213<div class="doc-section">
214
215<p>GetImageProfile() gets a profile associated with an image by name.</p></ol>
216
217<p>The format of the GetImageProfile method is:</p>
218
219<pre class="code">
220 const StringInfo *GetImageProfile(const Image *image,const char *name)
221</pre>
222
223<p>A description of each parameter follows:</p></ol>
224
225<h5>image</h5>
226<ol><p>the image.</p></ol>
227
228<h5>name</h5>
229<ol><p>the profile name.</p></ol>
230
231 </div>
232<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
233_8c.html" target="source" name="GetNextImageProfile">GetNextImageProfile</a></h2>
234<div class="doc-section">
235
236<p>GetNextImageProfile() gets the next profile name for an image.</p></ol>
237
238<p>The format of the GetNextImageProfile method is:</p>
239
240<pre class="code">
241 char *GetNextImageProfile(const Image *image)
242</pre>
243
244<p>A description of each parameter follows:</p></ol>
245
246<h5>hash_info</h5>
247<ol><p>the hash info.</p></ol>
248
249 </div>
250<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
251_8c.html" target="source" name="ProfileImage">ProfileImage</a></h2>
252<div class="doc-section">
253
254<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>
255
256<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>
257
258<p>The format of the ProfileImage method is:</p>
259
260<pre class="code">
261 MagickBooleanType ProfileImage(Image *image,const char *name,
262 const void *datum,const size_t length,const MagickBooleanType clone)
263</pre>
264
265<p>A description of each parameter follows:</p></ol>
266
267<h5>image</h5>
268<ol><p>the image.</p></ol>
269
270<h5>name</h5>
271<ol><p>Name of profile to add or remove: ICC, IPTC, or generic profile.</p></ol>
272
273<h5>datum</h5>
274<ol><p>the profile data.</p></ol>
275
276<h5>length</h5>
277<ol><p>the length of the profile.</p></ol>
278
279<h5>clone</h5>
280<ol><p>should be MagickFalse.</p></ol>
281
282 </div>
283<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
284_8c.html" target="source" name="RemoveImageProfile">RemoveImageProfile</a></h2>
285<div class="doc-section">
286
287<p>RemoveImageProfile() removes a named profile from the image and returns its value.</p></ol>
288
289<p>The format of the RemoveImageProfile method is:</p>
290
291<pre class="code">
292 void *RemoveImageProfile(Image *image,const char *name)
293</pre>
294
295<p>A description of each parameter follows:</p></ol>
296
297<h5>image</h5>
298<ol><p>the image.</p></ol>
299
300<h5>name</h5>
301<ol><p>the profile name.</p></ol>
302
303 </div>
304<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
305_8c.html" target="source" name="ResetImageProfileIterator">ResetImageProfileIterator</a></h2>
306<div class="doc-section">
307
308<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>
309
310<p>The format of the ResetImageProfileIterator method is:</p>
311
312<pre class="code">
313 ResetImageProfileIterator(Image *image)
314</pre>
315
316<p>A description of each parameter follows:</p></ol>
317
318<h5>image</h5>
319<ol><p>the image.</p></ol>
320
321 </div>
322<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
323_8c.html" target="source" name="SetImageProfile">SetImageProfile</a></h2>
324<div class="doc-section">
325
326<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>
327
328<p>The format of the SetImageProfile method is:</p>
329
330<pre class="code">
331 MagickBooleanType SetImageProfile(Image *image,const char *name,
332 const StringInfo *profile)
333</pre>
334
335<p>A description of each parameter follows:</p></ol>
336
337<h5>image</h5>
338<ol><p>the image.</p></ol>
339
340<h5>name</h5>
341<ol><p>the profile name, for example icc, exif, and 8bim (8bim is the Photoshop wrapper for iptc profiles).</p></ol>
342
343<h5>profile</h5>
344<ol><p>A StringInfo structure that contains the named profile.</p></ol>
345
346 </div>
347<h2><a href="http://www.imagemagick.org/api/MagickCore/profile
348_8c.html" target="source" name="SyncImageProfiles">SyncImageProfiles</a></h2>
349<div class="doc-section">
350
351<p>SyncImageProfiles() synchronizes image properties with the image profiles. Currently we only support updating the EXIF resolution and orientation.</p></ol>
352
353<p>The format of the SyncImageProfiles method is:</p>
354
355<pre class="code">
356 MagickBooleanType SyncImageProfiles(Image *image)
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 </div>
cristyb32b90a2009-09-07 21:45:48 +0000[diff] [blame]365
366</div>
367
368<div id="linkbar">
369 <!-- <span id="linkbar-west">&nbsp;</span> -->
370 <span id="linkbar-center">
371 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
372 <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
373 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
374 </span>
375 <span id="linkbar-east">&nbsp;</span>
376 </div>
377 <div class="footer">
378 <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
379 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
380 </div>
381 <div style="clear: both; margin: 0; width: 100%; "></div>
382</body>
383</html>