Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / de27d7631fa4cbb36c8bde6001d2c522774b3712 / . / www / api / profile.html
blob: c90edc061fce2a0b2c8299984550efa3508ead05 [file] [log] [blame]
Cristy594d2772015-11-15 10:47:42 -0500[diff] [blame]1
2
3
4
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5<!DOCTYPE html>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]6<html lang="en">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]7<head>
Cristy594d2772015-11-15 10:47:42 -0500[diff] [blame]8 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]9 <title>ImageMagick: MagickCore, C API for ImageMagick: Dealing with Image Profiles</title>
Cristy594d2772015-11-15 10:47:42 -0500[diff] [blame]10 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
11 <meta name="application-name" content="ImageMagick"/>
12 <meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves."/>
13 <meta name="application-url" content="http://www.imagemagick.org"/>
14 <meta name="generator" content="PHP"/>
15 <meta name="keywords" content="magickcore, c, api, for, imagemagick:, dealing, with, image, profiles, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert"/>
16 <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"/>
Cristyce4a3552015-12-14 13:53:35 -0500[diff] [blame]22 <meta name="copyright" content="Copyright (c) 1999-2015 ImageMagick Studio LLC"/>
Cristy594d2772015-11-15 10:47:42 -0500[diff] [blame]23 <meta name="distribution" content="Global"/>
24 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1"/>
25 <link rel="icon" href="../images/wand.png"/>
26 <link rel="shortcut icon" href="../images/wand.ico"/>
27 <link rel="stylesheet" href="../css/magick.html"/>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]28</head>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]29<body>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]30<div class="main">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]31<div class="magick-masthead">
32 <div class="container">
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]33 <script async="async" src="http://localhost/pagead/js/adsbygoogle.js"></script> <ins class="adsbygoogle"
Cristy594d2772015-11-15 10:47:42 -0500[diff] [blame]34 style="display:block"
35 data-ad-client="ca-pub-3129977114552745"
36 data-ad-slot="6345125851"
37 data-ad-format="auto"></ins>
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]38 <script>
Cristy542697a2015-10-12 20:10:32 -0400[diff] [blame]39 (adsbygoogle = window.adsbygoogle || []).push({});
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]40 </script>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]41 <nav class="magick-nav">
cristy2f563d42015-05-06 23:36:51 +0000[diff] [blame]42 <a class="magick-nav-item " href="../index.html">Home</a>
cristyea2793e2015-05-31 16:52:26 +0000[diff] [blame]43 <a class="magick-nav-item " href="../binary-releases.html">Download</a>
cristy38185362015-05-07 20:09:56 +0000[diff] [blame]44 <a class="magick-nav-item " href="../command-line-tools.html">Tools</a>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]45 <a class="magick-nav-item " href="../command-line-processing.html">Command-line</a>
cristyea2793e2015-05-31 16:52:26 +0000[diff] [blame]46 <a class="magick-nav-item " href="../resources.html">Resources</a>
47 <a class="magick-nav-item " href="api.html">Develop</a>
cristy5b8fe762015-06-09 16:24:03 +0000[diff] [blame]48 <a class="magick-nav-item " href="http://nextgen.imagemagick.org/script/search.php">Search</a>
cristya1890f02015-05-15 23:32:44 +0000[diff] [blame]49 <a class="magick-nav-item pull-right" href="http://www.imagemagick.org/discourse-server/">Community</a>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]50 </nav>
51 </div>
52</div>
53<div class="container">
cristy4e638cd2015-05-07 16:47:40 +0000[diff] [blame]54<div class="magick-header">
Cristy594d2772015-11-15 10:47:42 -0500[diff] [blame]55<p class="text-center"><a href="profile.html#CloneImageProfiles">CloneImageProfiles</a> &#8226; <a href="profile.html#DeleteImageProfile">DeleteImageProfile</a> &#8226; <a href="profile.html#DestroyImageProfiles">DestroyImageProfiles</a> &#8226; <a href="profile.html#GetImageProfile">GetImageProfile</a> &#8226; <a href="profile.html#GetNextImageProfile">GetNextImageProfile</a> &#8226; <a href="profile.html#ProfileImage">ProfileImage</a> &#8226; <a href="profile.html#RemoveImageProfile">RemoveImageProfile</a> &#8226; <a href="profile.html#ResetImageProfileIterator">ResetImageProfileIterator</a> &#8226; <a href="profile.html#SetImageProfile">SetImageProfile</a> &#8226; <a href="profile.html#SyncImageProfiles">SyncImageProfiles</a></p>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]56
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]57<h2><a href="http://www.imagemagick.org/api/MagickCore/profile_8c.html" id="CloneImageProfiles">CloneImageProfiles</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]58
59<p>CloneImageProfiles() clones one or more image profiles.</p>
60
61<p>The format of the CloneImageProfiles method is:</p>
62
63<pre class="text">
64MagickBooleanType CloneImageProfiles(Image *image,
65 const Image *clone_image)
66</pre>
67
68<p>A description of each parameter follows:</p>
69
70<dd>
71</dd>
72
73<dd> </dd>
74<dl class="dl-horizontal">
75<dt>image</dt>
76<dd>the image. </dd>
77
78<dd> </dd>
79<dt>clone_image</dt>
80<dd>the clone image. </dd>
81
82<dd> </dd>
83</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]84<h2><a href="http://www.imagemagick.org/api/MagickCore/profile_8c.html" id="DeleteImageProfile">DeleteImageProfile</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]85
86<p>DeleteImageProfile() deletes a profile from the image by its name.</p>
87
88<p>The format of the DeleteImageProfile method is:</p>
89
90<pre class="text">
91MagickBooleanTyupe DeleteImageProfile(Image *image,const char *name)
92</pre>
93
94<p>A description of each parameter follows:</p>
95
96<dd>
97</dd>
98
99<dd> </dd>
100<dl class="dl-horizontal">
101<dt>image</dt>
102<dd>the image. </dd>
103
104<dd> </dd>
105<dt>name</dt>
106<dd>the profile name. </dd>
107
108<dd> </dd>
109</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]110<h2><a href="http://www.imagemagick.org/api/MagickCore/profile_8c.html" id="DestroyImageProfiles">DestroyImageProfiles</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]111
112<p>DestroyImageProfiles() releases memory associated with an image profile map.</p>
113
114<p>The format of the DestroyProfiles method is:</p>
115
116<pre class="text">
117void DestroyImageProfiles(Image *image)
118</pre>
119
120<p>A description of each parameter follows:</p>
121
122<dd>
123</dd>
124
125<dd> </dd>
126<dl class="dl-horizontal">
127<dt>image</dt>
128<dd>the image. </dd>
129
130<dd> </dd>
131</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]132<h2><a href="http://www.imagemagick.org/api/MagickCore/profile_8c.html" id="GetImageProfile">GetImageProfile</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]133
134<p>GetImageProfile() gets a profile associated with an image by name.</p>
135
136<p>The format of the GetImageProfile method is:</p>
137
138<pre class="text">
139const StringInfo *GetImageProfile(const Image *image,const char *name)
140</pre>
141
142<p>A description of each parameter follows:</p>
143
144<dd>
145</dd>
146
147<dd> </dd>
148<dl class="dl-horizontal">
149<dt>image</dt>
150<dd>the image. </dd>
151
152<dd> </dd>
153<dt>name</dt>
154<dd>the profile name. </dd>
155
156<dd> </dd>
157</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]158<h2><a href="http://www.imagemagick.org/api/MagickCore/profile_8c.html" id="GetNextImageProfile">GetNextImageProfile</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]159
160<p>GetNextImageProfile() gets the next profile name for an image.</p>
161
162<p>The format of the GetNextImageProfile method is:</p>
163
164<pre class="text">
165char *GetNextImageProfile(const Image *image)
166</pre>
167
168<p>A description of each parameter follows:</p>
169
170<dd>
171</dd>
172
173<dd> </dd>
174<dl class="dl-horizontal">
175<dt>hash_info</dt>
176<dd>the hash info. </dd>
177
178<dd> </dd>
179</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]180<h2><a href="http://www.imagemagick.org/api/MagickCore/profile_8c.html" id="ProfileImage">ProfileImage</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]181
182<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>
183
184<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>
185
186<p>The format of the ProfileImage method is:</p>
187
188<pre class="text">
189MagickBooleanType ProfileImage(Image *image,const char *name,
190 const void *datum,const size_t length,const MagickBooleanType clone)
191</pre>
192
193<p>A description of each parameter follows:</p>
194
195<dd>
196</dd>
197
198<dd> </dd>
199<dl class="dl-horizontal">
200<dt>image</dt>
201<dd>the image. </dd>
202
203<dd> </dd>
204<dt>name</dt>
205<dd>Name of profile to add or remove: ICC, IPTC, or generic profile. </dd>
206
207<dd> </dd>
208<dt>datum</dt>
209<dd>the profile data. </dd>
210
211<dd> </dd>
212<dt>length</dt>
213<dd>the length of the profile. </dd>
214
215<dd> </dd>
216<dt>clone</dt>
217<dd>should be MagickFalse. </dd>
218
219<dd> </dd>
220</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]221<h2><a href="http://www.imagemagick.org/api/MagickCore/profile_8c.html" id="RemoveImageProfile">RemoveImageProfile</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]222
223<p>RemoveImageProfile() removes a named profile from the image and returns its value.</p>
224
225<p>The format of the RemoveImageProfile method is:</p>
226
227<pre class="text">
228void *RemoveImageProfile(Image *image,const char *name)
229</pre>
230
231<p>A description of each parameter follows:</p>
232
233<dd>
234</dd>
235
236<dd> </dd>
237<dl class="dl-horizontal">
238<dt>image</dt>
239<dd>the image. </dd>
240
241<dd> </dd>
242<dt>name</dt>
243<dd>the profile name. </dd>
244
245<dd> </dd>
246</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]247<h2><a href="http://www.imagemagick.org/api/MagickCore/profile_8c.html" id="ResetImageProfileIterator">ResetImageProfileIterator</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]248
249<p>ResetImageProfileIterator() resets the image profile iterator. Use it in conjunction with GetNextImageProfile() to iterate over all the profiles associated with an image.</p>
250
251<p>The format of the ResetImageProfileIterator method is:</p>
252
253<pre class="text">
254ResetImageProfileIterator(Image *image)
255</pre>
256
257<p>A description of each parameter follows:</p>
258
259<dd>
260</dd>
261
262<dd> </dd>
263<dl class="dl-horizontal">
264<dt>image</dt>
265<dd>the image. </dd>
266
267<dd> </dd>
268</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]269<h2><a href="http://www.imagemagick.org/api/MagickCore/profile_8c.html" id="SetImageProfile">SetImageProfile</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]270
271<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>
272
273<p>The format of the SetImageProfile method is:</p>
274
275<pre class="text">
276MagickBooleanType SetImageProfile(Image *image,const char *name,
277 const StringInfo *profile)
278</pre>
279
280<p>A description of each parameter follows:</p>
281
282<dd>
283</dd>
284
285<dd> </dd>
286<dl class="dl-horizontal">
287<dt>image</dt>
288<dd>the image. </dd>
289
290<dd> </dd>
291<dt>name</dt>
292<dd>the profile name, for example icc, exif, and 8bim (8bim is the Photoshop wrapper for iptc profiles). </dd>
293
294<dd> </dd>
295<dt>profile</dt>
296<dd>A StringInfo structure that contains the named profile. </dd>
297
298<dd> </dd>
299</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]300<h2><a href="http://www.imagemagick.org/api/MagickCore/profile_8c.html" id="SyncImageProfiles">SyncImageProfiles</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]301
302<p>SyncImageProfiles() synchronizes image properties with the image profiles. Currently we only support updating the EXIF resolution and orientation.</p>
303
304<p>The format of the SyncImageProfiles method is:</p>
305
306<pre class="text">
307MagickBooleanType SyncImageProfiles(Image *image)
308</pre>
309
310<p>A description of each parameter follows:</p>
311
312<dd>
313</dd>
314
315<dd> </dd>
316<dl class="dl-horizontal">
317<dt>image</dt>
318<dd>the image. </dd>
319
320<dd> </dd>
321</dl>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]322</div>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]323 <footer class="magick-footer">
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]324 <p><a href="../support.html">Donate</a> •
325 <a href="../sitemap.html">Sitemap</a> •
cristy38185362015-05-07 20:09:56 +0000[diff] [blame]326 <a href="../links.html">Related</a> •
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]327 <a href="../architecture.html">Architecture</a>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]328</p>
329 <p><a href="profile.html#">Back to top</a> •
cristyea2793e2015-05-31 16:52:26 +0000[diff] [blame]330 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
cristy5b8fe762015-06-09 16:24:03 +0000[diff] [blame]331 <a href="http://nextgen.imagemagick.org/script/contact.php">Contact Us</a></p>
Cristyce4a3552015-12-14 13:53:35 -0500[diff] [blame]332 <p><small>© 1999-2015 ImageMagick Studio LLC</small></p>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]333 </footer>
334</div><!-- /.container -->
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]335
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]336 <script src="https://localhost/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]337 <script src="http://nextgen.imagemagick.org/js/magick.html"></script>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]338</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]339</body>
cristy5a367e42015-05-05 12:39:18 +0000[diff] [blame]340</html>