profile.html 12.3 KB
Newer Older
Cristy's avatar
Cristy committed
1 2 3 4




cristy's avatar
cristy committed
5
<!DOCTYPE html>
cristy's avatar
cristy committed
6
<html lang="en">
cristy's avatar
cristy committed
7
<head>
Cristy's avatar
Cristy committed
8 9
  <meta charset="utf-8"  />
  <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"  />
Cristy's avatar
Cristy committed
10
  <title>MagickCore, C API: Dealing with Image Profiles @ ImageMagick</title>
Cristy's avatar
Cristy committed
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
  <meta name="application-name" content="ImageMagick" />
  <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." />
  <meta name="application-url" content="https://www.imagemagick.org" />
  <meta name="generator" content="PHP" />
  <meta name="keywords" content="magickcore, c, api:, dealing, with, image, profiles, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert" />
  <meta name="rating" content="GENERAL" />
  <meta name="robots" content="INDEX, FOLLOW" />
  <meta name="generator" content="ImageMagick Studio LLC" />
  <meta name="author" content="ImageMagick Studio LLC" />
  <meta name="revisit-after" content="2 DAYS" />
  <meta name="resource-type" content="document" />
  <meta name="copyright" content="Copyright (c) 1999-2017 ImageMagick Studio LLC" />
  <meta name="distribution" content="Global" />
  <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1" />
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
  <link href="../../api/profile.html" rel="canonical" />
  <link href="../images/wand.png" rel="icon" />
  <link href="../images/wand.ico" rel="shortcut icon" />
  <link href="assets/magick.css" rel="stylesheet" />
cristy's avatar
cristy committed
31
</head>
cristy's avatar
cristy committed
32
<body>
Cristy's avatar
...  
Cristy committed
33 34
  <header>
  <nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top">
Cristy's avatar
...  
Cristy committed
35
    <a class="navbar-brand" href="../index.html"><img class="d-block" id="logo" name="ImageMagick" alt="ImageMagick" width="32" height="32" src="../images/wand.ico"/></a>
Cristy's avatar
...  
Cristy committed
36 37 38 39 40 41 42
    <button class="navbar-toggler collapsed" type="button" data-toggle="collapse" data-target="#navbarsExampleDefault" aria-controls="navbarsExampleDefault" aria-expanded="false" aria-label="Toggle navigation">
    <span class="navbar-toggler-icon"></span>
    </button>

    <div class="navbar-collapse collapse" id="navbarsExampleDefault" style="">
    <ul class="navbar-nav mr-auto">
      <li class="nav-item ">
Cristy's avatar
...  
Cristy committed
43
        <a class="nav-link" href="../index.html">Home <span class="sr-only">(current)</span></a>
Cristy's avatar
...  
Cristy committed
44 45
      </li>
      <li class="nav-item ">
Cristy's avatar
...  
Cristy committed
46
        <a class="nav-link" href="../www/download.html">Download</a>
Cristy's avatar
...  
Cristy committed
47 48
      </li>
      <li class="nav-item ">
Cristy's avatar
...  
Cristy committed
49
        <a class="nav-link" href="../www/command-line-tools.html">Tools</a>
Cristy's avatar
...  
Cristy committed
50 51
      </li>
      <li class="nav-item ">
Cristy's avatar
...  
Cristy committed
52
        <a class="nav-link" href="../www/command-line-processing.html">Command-line</a>
Cristy's avatar
...  
Cristy committed
53 54
      </li>
      <li class="nav-item ">
Cristy's avatar
...  
Cristy committed
55
        <a class="nav-link" href="../www/resources.html">Resources</a>
Cristy's avatar
...  
Cristy committed
56 57
      </li>
      <li class="nav-item ">
Cristy's avatar
...  
Cristy committed
58
        <a class="nav-link" href="../www/develop.html">Develop</a>
Cristy's avatar
...  
Cristy committed
59 60
      </li>
      <li class="nav-item">
Cristy's avatar
...  
Cristy committed
61
        <a class="nav-link" target="_blank" href="https://www.imagemagick.org/discourse-server/">Community</a>
Cristy's avatar
...  
Cristy committed
62 63
      </li>
    </ul>
Cristy's avatar
...  
Cristy committed
64
    <form class="form-inline my-2 my-lg-0" action="https://www.imagemagick.org/script/search.php">
Cristy's avatar
Cristy committed
65
      <input class="form-control mr-sm-2" type="text" name="q" placeholder="Search" aria-label="Search">
Cristy's avatar
...  
Cristy committed
66
      <button class="btn btn-outline-success my-2 my-sm-0" type="submit" name="sa">Search</button>
Cristy's avatar
...  
Cristy committed
67 68 69
    </form>
    </div>
  </nav>
Cristy's avatar
...  
Cristy committed
70
  <div class="container">
Cristy's avatar
...  
Cristy committed
71
   <script async="async" src="http://localhost/pagead/js/adsbygoogle.js"></script>    <ins class="adsbygoogle"
Cristy's avatar
...  
Cristy committed
72 73 74 75 76 77 78 79
         style="display:block"
         data-ad-client="ca-pub-3129977114552745"
         data-ad-slot="6345125851"
         data-ad-format="auto"></ins>
    <script>
      (adsbygoogle = window.adsbygoogle || []).push({});
    </script>
  </div>
Cristy's avatar
...  
Cristy committed
80
  </header>
Cristy's avatar
...  
Cristy committed
81
  <main role="main" class="container">
Cristy's avatar
...  
Cristy committed
82
    <div class="magick-template">
cristy's avatar
cristy committed
83
<div class="magick-header">
Cristy's avatar
Cristy committed
84
<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>
cristy's avatar
cristy committed
85

Cristy's avatar
...  
Cristy committed
86
<h2><a href="../../api/MagickCore/profile_8c.html" id="CloneImageProfiles">CloneImageProfiles</a></h2>
cristy's avatar
cristy committed
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112

<p>CloneImageProfiles() clones one or more image profiles.</p>

<p>The format of the CloneImageProfiles method is:</p>

<pre class="text">
MagickBooleanType CloneImageProfiles(Image *image,
  const Image *clone_image)
</pre>

<p>A description of each parameter follows:</p>

<dd>
</dd>

<dd> </dd>
<dl class="dl-horizontal">
<dt>image</dt>
<dd>the image. </dd>

<dd> </dd>
<dt>clone_image</dt>
<dd>the clone image. </dd>

<dd>  </dd>
</dl>
Cristy's avatar
...  
Cristy committed
113
<h2><a href="../../api/MagickCore/profile_8c.html" id="DeleteImageProfile">DeleteImageProfile</a></h2>
cristy's avatar
cristy committed
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138

<p>DeleteImageProfile() deletes a profile from the image by its name.</p>

<p>The format of the DeleteImageProfile method is:</p>

<pre class="text">
MagickBooleanTyupe DeleteImageProfile(Image *image,const char *name)
</pre>

<p>A description of each parameter follows:</p>

<dd>
</dd>

<dd> </dd>
<dl class="dl-horizontal">
<dt>image</dt>
<dd>the image. </dd>

<dd> </dd>
<dt>name</dt>
<dd>the profile name. </dd>

<dd>  </dd>
</dl>
Cristy's avatar
...  
Cristy committed
139
<h2><a href="../../api/MagickCore/profile_8c.html" id="DestroyImageProfiles">DestroyImageProfiles</a></h2>
cristy's avatar
cristy committed
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160

<p>DestroyImageProfiles() releases memory associated with an image profile map.</p>

<p>The format of the DestroyProfiles method is:</p>

<pre class="text">
void DestroyImageProfiles(Image *image)
</pre>

<p>A description of each parameter follows:</p>

<dd>
</dd>

<dd> </dd>
<dl class="dl-horizontal">
<dt>image</dt>
<dd>the image. </dd>

<dd>  </dd>
</dl>
Cristy's avatar
...  
Cristy committed
161
<h2><a href="../../api/MagickCore/profile_8c.html" id="GetImageProfile">GetImageProfile</a></h2>
cristy's avatar
cristy committed
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186

<p>GetImageProfile() gets a profile associated with an image by name.</p>

<p>The format of the GetImageProfile method is:</p>

<pre class="text">
const StringInfo *GetImageProfile(const Image *image,const char *name)
</pre>

<p>A description of each parameter follows:</p>

<dd>
</dd>

<dd> </dd>
<dl class="dl-horizontal">
<dt>image</dt>
<dd>the image. </dd>

<dd> </dd>
<dt>name</dt>
<dd>the profile name. </dd>

<dd>  </dd>
</dl>
Cristy's avatar
...  
Cristy committed
187
<h2><a href="../../api/MagickCore/profile_8c.html" id="GetNextImageProfile">GetNextImageProfile</a></h2>
cristy's avatar
cristy committed
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208

<p>GetNextImageProfile() gets the next profile name for an image.</p>

<p>The format of the GetNextImageProfile method is:</p>

<pre class="text">
char *GetNextImageProfile(const Image *image)
</pre>

<p>A description of each parameter follows:</p>

<dd>
</dd>

<dd> </dd>
<dl class="dl-horizontal">
<dt>hash_info</dt>
<dd>the hash info. </dd>

<dd>  </dd>
</dl>
Cristy's avatar
...  
Cristy committed
209
<h2><a href="../../api/MagickCore/profile_8c.html" id="ProfileImage">ProfileImage</a></h2>
cristy's avatar
cristy committed
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249

<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>

<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>

<p>The format of the ProfileImage method is:</p>

<pre class="text">
MagickBooleanType ProfileImage(Image *image,const char *name,
  const void *datum,const size_t length,const MagickBooleanType clone)
</pre>

<p>A description of each parameter follows:</p>

<dd>
</dd>

<dd> </dd>
<dl class="dl-horizontal">
<dt>image</dt>
<dd>the image. </dd>

<dd> </dd>
<dt>name</dt>
<dd>Name of profile to add or remove: ICC, IPTC, or generic profile. </dd>

<dd> </dd>
<dt>datum</dt>
<dd>the profile data. </dd>

<dd> </dd>
<dt>length</dt>
<dd>the length of the profile. </dd>

<dd> </dd>
<dt>clone</dt>
<dd>should be MagickFalse. </dd>

<dd>  </dd>
</dl>
Cristy's avatar
...  
Cristy committed
250
<h2><a href="../../api/MagickCore/profile_8c.html" id="RemoveImageProfile">RemoveImageProfile</a></h2>
cristy's avatar
cristy committed
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275

<p>RemoveImageProfile() removes a named profile from the image and returns its value.</p>

<p>The format of the RemoveImageProfile method is:</p>

<pre class="text">
void *RemoveImageProfile(Image *image,const char *name)
</pre>

<p>A description of each parameter follows:</p>

<dd>
</dd>

<dd> </dd>
<dl class="dl-horizontal">
<dt>image</dt>
<dd>the image. </dd>

<dd> </dd>
<dt>name</dt>
<dd>the profile name. </dd>

<dd>  </dd>
</dl>
Cristy's avatar
...  
Cristy committed
276
<h2><a href="../../api/MagickCore/profile_8c.html" id="ResetImageProfileIterator">ResetImageProfileIterator</a></h2>
cristy's avatar
cristy committed
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297

<p>ResetImageProfileIterator() resets the image profile iterator.  Use it in conjunction with GetNextImageProfile() to iterate over all the profiles associated with an image.</p>

<p>The format of the ResetImageProfileIterator method is:</p>

<pre class="text">
ResetImageProfileIterator(Image *image)
</pre>

<p>A description of each parameter follows:</p>

<dd>
</dd>

<dd> </dd>
<dl class="dl-horizontal">
<dt>image</dt>
<dd>the image. </dd>

<dd>  </dd>
</dl>
Cristy's avatar
...  
Cristy committed
298
<h2><a href="../../api/MagickCore/profile_8c.html" id="SetImageProfile">SetImageProfile</a></h2>
cristy's avatar
cristy committed
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328

<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>

<p>The format of the SetImageProfile method is:</p>

<pre class="text">
MagickBooleanType SetImageProfile(Image *image,const char *name,
  const StringInfo *profile)
</pre>

<p>A description of each parameter follows:</p>

<dd>
</dd>

<dd> </dd>
<dl class="dl-horizontal">
<dt>image</dt>
<dd>the image. </dd>

<dd> </dd>
<dt>name</dt>
<dd>the profile name, for example icc, exif, and 8bim (8bim is the Photoshop wrapper for iptc profiles). </dd>

<dd> </dd>
<dt>profile</dt>
<dd>A StringInfo structure that contains the named profile. </dd>

<dd>  </dd>
</dl>
Cristy's avatar
...  
Cristy committed
329
<h2><a href="../../api/MagickCore/profile_8c.html" id="SyncImageProfiles">SyncImageProfiles</a></h2>
cristy's avatar
cristy committed
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350

<p>SyncImageProfiles() synchronizes image properties with the image profiles. Currently we only support updating the EXIF resolution and orientation.</p>

<p>The format of the SyncImageProfiles method is:</p>

<pre class="text">
MagickBooleanType SyncImageProfiles(Image *image)
</pre>

<p>A description of each parameter follows:</p>

<dd>
</dd>

<dd> </dd>
<dl class="dl-horizontal">
<dt>image</dt>
<dd>the image. </dd>

<dd>  </dd>
</dl>
cristy's avatar
cristy committed
351
</div>
Cristy's avatar
...  
Cristy committed
352 353
    </div>
  </main><!-- /.container -->
cristy's avatar
cristy committed
354
  <footer class="magick-footer">
Cristy's avatar
...  
Cristy committed
355 356 357
    <p><a href="../www/security-policy.html">Security</a>
    <a href="../www/architecture.html">Architecture</a>
    <a href="../www/links.html">Related</a>
Cristy's avatar
...  
Cristy committed
358 359
     <a href="../www/sitemap.html">Sitemap</a>
       
Cristy's avatar
...  
Cristy committed
360
    <a href="profile.html#"><img class="d-inline" id="logo" alt="And Now a Touch of Magick" width="16" height="16" src="../images/wand.ico"/></a>
Cristy's avatar
...  
Cristy committed
361 362 363 364 365 366
       
    <a href="http://pgp.mit.edu/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a>
    <a href="../www/support.html">Donate</a>
    <a href="../www/contact.html">Contact Us</a>
    <br/>
        <small>© 1999-2018 ImageMagick Studio LLC</small></p>
cristy's avatar
cristy committed
367 368
  </footer>

Cristy's avatar
...  
Cristy committed
369
  <!-- Javascript assets -->
Cristy's avatar
...  
Cristy committed
370 371
  <script src="assets/magick.js" crossorigin="anonymous"></script>
  <script>window.jQuery || document.write('<script src="assets/jquery.min.js"><\/script>')</script>
cristy's avatar
cristy committed
372
</body>
cristy's avatar
cristy committed
373
</html>
Cristy's avatar
...  
Cristy committed
374
<!-- Magick Cache 14th February 2018 12:10 -->