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