granicus.if.org Git - imagemagick/blob - www/api/profile.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
   2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\r
   4 <head>\r
   5   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   6   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   7   <style type="text/css" media="screen,projection"><!--\r
   8     @import url("../../www/magick.css");\r
   9   --></style>\r
  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"/>
  26 </head>\r
  27 \r
  28 <body id="www-imagemagick-org">\r
  29 <div class="titlebar">\r
  30 <a href="../../index.html">\r
  31   <img src="../../images/script.png" alt="[ImageMagick]"\r
  32   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  33 <a href="http://www.networkredux.com">\r
  34   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  35   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  36 <a href="http://www.imagemagick.org/discourse-server/">\r
  37   <img src="../../images/logo.jpg" alt=""\r
  38   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  39 <a href="../../index.html">\r
  40   <img src="../../images/sprite.jpg" alt=""\r
  41   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  42 </div>\r
  43 \r
  44 <div class="eastbar">\r
  45 \r
  46 <div class="menu">
  47   <a href="../../index.html">About ImageMagick</a>
  48 </div>
  49 <div class="sep"></div>\r
  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>
  80 <div class="sep"></div>\r
  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>
 105 <div class="sep"></div>\r
 106 <div class="menu">
 107   <a href="../../www/download.html">Download</a>
 108 </div>
 109 <div class="sep"></div>\r
 110 <div class="menu">
 111   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 112 </div>
 113 <div class="sep"></div>\r
 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>
 120 <div class="sep"></div>\r
 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.hygi.de">Reinigungsmittel</a><!-- 201002000400+ -->
 127 </div>
 128 <div  class="sponsor">
 129   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201003010120 Buchhorn -->
 133 </div>
 134 <div  class="sponsor">
 135   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 136 </div>
 137 <div  class="sponsor">
 138    <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 139 </div>
 140 <div  class="sponsor">
 141    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 142 </div>
 143 <div  class="sponsor">
 144   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 145 </div>
 146 </div>
 147 </div>
 148 \r
 149 \r
 150 </div>\r
 151 \r
 152 <div class="main">\r
 153 \r
 154 <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>
 155
 156 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 157 _8c.html" target="source" name="CloneImageProfiles">CloneImageProfiles</a></h2>
 158 <div class="doc-section">
 159
 160 <p>CloneImageProfiles() clones one or more image profiles.</p></ol>
 161
 162 <p>The format of the CloneImageProfiles method is:</p>
 163
 164 <pre class="code">
 165   MagickBooleanType CloneImageProfiles(Image *image,
 166     const Image *clone_image)
 167 </pre>
 168
 169 <p>A description of each parameter follows:</p></ol>
 170
 171 <h5>image</h5>
 172 <ol><p>the image.</p></ol>
 173
 174 <h5>clone_image</h5>
 175 <ol><p>the clone image.</p></ol>
 176
 177  </div>
 178 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 179 _8c.html" target="source" name="DeleteImageProfile">DeleteImageProfile</a></h2>
 180 <div class="doc-section">
 181
 182 <p>DeleteImageProfile() deletes a profile from the image by its name.</p></ol>
 183
 184 <p>The format of the DeleteImageProfile method is:</p>
 185
 186 <pre class="code">
 187   MagickBooleanTyupe DeleteImageProfile(Image *image,const char *name)
 188 </pre>
 189
 190 <p>A description of each parameter follows:</p></ol>
 191
 192 <h5>image</h5>
 193 <ol><p>the image.</p></ol>
 194
 195 <h5>name</h5>
 196 <ol><p>the profile name.</p></ol>
 197
 198  </div>
 199 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 200 _8c.html" target="source" name="DestroyImageProfiles">DestroyImageProfiles</a></h2>
 201 <div class="doc-section">
 202
 203 <p>DestroyImageProfiles() releases memory associated with an image profile map.</p></ol>
 204
 205 <p>The format of the DestroyProfiles method is:</p>
 206
 207 <pre class="code">
 208   void DestroyImageProfiles(Image *image)
 209 </pre>
 210
 211 <p>A description of each parameter follows:</p></ol>
 212
 213 <h5>image</h5>
 214 <ol><p>the image.</p></ol>
 215
 216  </div>
 217 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 218 _8c.html" target="source" name="GetImageProfile">GetImageProfile</a></h2>
 219 <div class="doc-section">
 220
 221 <p>GetImageProfile() gets a profile associated with an image by name.</p></ol>
 222
 223 <p>The format of the GetImageProfile method is:</p>
 224
 225 <pre class="code">
 226   const StringInfo *GetImageProfile(const Image *image,const char *name)
 227 </pre>
 228
 229 <p>A description of each parameter follows:</p></ol>
 230
 231 <h5>image</h5>
 232 <ol><p>the image.</p></ol>
 233
 234 <h5>name</h5>
 235 <ol><p>the profile name.</p></ol>
 236
 237  </div>
 238 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 239 _8c.html" target="source" name="GetNextImageProfile">GetNextImageProfile</a></h2>
 240 <div class="doc-section">
 241
 242 <p>GetNextImageProfile() gets the next profile name for an image.</p></ol>
 243
 244 <p>The format of the GetNextImageProfile method is:</p>
 245
 246 <pre class="code">
 247   char *GetNextImageProfile(const Image *image)
 248 </pre>
 249
 250 <p>A description of each parameter follows:</p></ol>
 251
 252 <h5>hash_info</h5>
 253 <ol><p>the hash info.</p></ol>
 254
 255  </div>
 256 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 257 _8c.html" target="source" name="ProfileImage">ProfileImage</a></h2>
 258 <div class="doc-section">
 259
 260 <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>
 261
 262 <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>
 263
 264 <p>The format of the ProfileImage method is:</p>
 265
 266 <pre class="code">
 267   MagickBooleanType ProfileImage(Image *image,const char *name,
 268     const void *datum,const size_t length,const MagickBooleanType clone)
 269 </pre>
 270
 271 <p>A description of each parameter follows:</p></ol>
 272
 273 <h5>image</h5>
 274 <ol><p>the image.</p></ol>
 275
 276 <h5>name</h5>
 277 <ol><p>Name of profile to add or remove: ICC, IPTC, or generic profile.</p></ol>
 278
 279 <h5>datum</h5>
 280 <ol><p>the profile data.</p></ol>
 281
 282 <h5>length</h5>
 283 <ol><p>the length of the profile.</p></ol>
 284
 285 <h5>clone</h5>
 286 <ol><p>should be MagickFalse.</p></ol>
 287
 288  </div>
 289 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 290 _8c.html" target="source" name="RemoveImageProfile">RemoveImageProfile</a></h2>
 291 <div class="doc-section">
 292
 293 <p>RemoveImageProfile() removes a named profile from the image and returns its value.</p></ol>
 294
 295 <p>The format of the RemoveImageProfile method is:</p>
 296
 297 <pre class="code">
 298   void *RemoveImageProfile(Image *image,const char *name)
 299 </pre>
 300
 301 <p>A description of each parameter follows:</p></ol>
 302
 303 <h5>image</h5>
 304 <ol><p>the image.</p></ol>
 305
 306 <h5>name</h5>
 307 <ol><p>the profile name.</p></ol>
 308
 309  </div>
 310 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 311 _8c.html" target="source" name="ResetImageProfileIterator">ResetImageProfileIterator</a></h2>
 312 <div class="doc-section">
 313
 314 <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>
 315
 316 <p>The format of the ResetImageProfileIterator method is:</p>
 317
 318 <pre class="code">
 319   ResetImageProfileIterator(Image *image)
 320 </pre>
 321
 322 <p>A description of each parameter follows:</p></ol>
 323
 324 <h5>image</h5>
 325 <ol><p>the image.</p></ol>
 326
 327  </div>
 328 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 329 _8c.html" target="source" name="SetImageProfile">SetImageProfile</a></h2>
 330 <div class="doc-section">
 331
 332 <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>
 333
 334 <p>The format of the SetImageProfile method is:</p>
 335
 336 <pre class="code">
 337   MagickBooleanType SetImageProfile(Image *image,const char *name,
 338     const StringInfo *profile)
 339 </pre>
 340
 341 <p>A description of each parameter follows:</p></ol>
 342
 343 <h5>image</h5>
 344 <ol><p>the image.</p></ol>
 345
 346 <h5>name</h5>
 347 <ol><p>the profile name, for example icc, exif, and 8bim (8bim is the Photoshop wrapper for iptc profiles).</p></ol>
 348
 349 <h5>profile</h5>
 350 <ol><p>A StringInfo structure that contains the named profile.</p></ol>
 351
 352  </div>
 353 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 354 _8c.html" target="source" name="SyncImageProfiles">SyncImageProfiles</a></h2>
 355 <div class="doc-section">
 356
 357 <p>SyncImageProfiles() synchronizes image properties with the image profiles. Currently we only support updating the EXIF resolution and orientation.</p></ol>
 358
 359 <p>The format of the SyncImageProfiles method is:</p>
 360
 361 <pre class="code">
 362   MagickBooleanType SyncImageProfiles(Image *image)
 363 </pre>
 364
 365 <p>A description of each parameter follows:</p></ol>
 366
 367 <h5>image</h5>
 368 <ol><p>the image.</p></ol>
 369
 370  </div>
 371 \r
 372 </div>\r
 373 \r
 374 <div id="linkbar">\r
 375  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 376     <span id="linkbar-center">\r
 377       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 378       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 379     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 380     </span>\r
 381     <span id="linkbar-east">&nbsp;</span>\r
 382   </div>\r
 383   <div class="footer">\r
 384     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 385     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 386   </div>\r
 387   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 388 </body>\r
 389 </html>\r