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" dir="ltr">\r
   4 <head>\r
   5   <meta http-equiv="content-type" content="text/html; charset=utf-8"/>\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="all">\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 title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  49 </div>
  50 <div class="sep"></div>\r
  51 <div class="menu">
  52   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  53 </div>
  54 <div class="sub">
  55     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  56 </div>
  57 <div class="sub">
  58     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  59 </div>
  60 <div class="sub">
  61     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  62 </div>
  63 <div class="sep"></div>\r
  64 <div class="menu">
  65   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  66 </div>
  67 <div class="sub">
  68     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  69 </div>
  70 <div class="sub">
  71     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  72 </div>
  73 <div class="sub">
  74     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  75 </div>
  76 <div class="menu">
  77   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  78 </div>
  79 <div class="sub">
  80     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
  81 </div>
  82 <div class="sub">
  83     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
  84 </div>
  85 <div class="sub">
  86     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
  90 </div>
  91 <div class="sep"></div>\r
  92 <div  class="menu">
  93    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
  94 </div>
  95 <div class="sub">
  96     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
  97 </div>
  98 <div class="sub">
  99     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 100  </div>
 101 <div class="menu">
 102   <a title="Resources" href="../../www/resources.html">Resources</a>
 103 </div>
 104 <div class="menu">
 105   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 106 </div>
 107 <div class="menu">
 108   <a title="Download" href="../../www/download.html">Download</a>
 109 </div>
 110 <div class="sep"></div>\r
 111 <div class="menu">
 112   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
 113 </div>
 114 <div class="sep"></div>\r
 115 <div class="menu">
 116   <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
 117 </div>
 118 <div  class="sub">
 119     <a title="Site Map: Links"href="../../www/links.html">Links</a>
 120 </div>
 121 <div class="sep"></div>\r
 122 <div  class="menu">
 123   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 124
 125 <div class="sponsbox">
 126 <div  class="sponsor">
 127   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 128 </div>
 129 <div  class="sponsor">
 130   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 137 </div>
 138 <div  class="sponsor">
 139   <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 140 </div>
 141 <div  class="sponsor">
 142    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 143 </div>
 144 <div  class="sponsor">
 145    <a title="Sponsor: Webdesign" href="http://www.renehornig.com/" title="Webdesign">Webdesign</a><!-- 20111001000240 -->
 146 </div>
 147 </div>
 148 </div>
 149 \r
 150 \r
 151 </div>\r
 152 \r
 153 <div class="main">\r
 154 \r
 155 <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>
 156
 157 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 158 _8c.html" target="source" name="CloneImageProfiles">CloneImageProfiles</a></h2>
 159 <div class="doc-section">
 160
 161 <p>CloneImageProfiles() clones one or more image profiles.</p></ol>
 162
 163 <p>The format of the CloneImageProfiles method is:</p>
 164
 165 <pre class="code">
 166   MagickBooleanType CloneImageProfiles(Image *image,
 167     const Image *clone_image)
 168 </pre>
 169
 170 <p>A description of each parameter follows:</p></ol>
 171
 172 <h5>image</h5>
 173 <ol><p>the image.</p></ol>
 174
 175 <h5>clone_image</h5>
 176 <ol><p>the clone image.</p></ol>
 177
 178  </div>
 179 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 180 _8c.html" target="source" name="DeleteImageProfile">DeleteImageProfile</a></h2>
 181 <div class="doc-section">
 182
 183 <p>DeleteImageProfile() deletes a profile from the image by its name.</p></ol>
 184
 185 <p>The format of the DeleteImageProfile method is:</p>
 186
 187 <pre class="code">
 188   MagickBooleanTyupe DeleteImageProfile(Image *image,const char *name)
 189 </pre>
 190
 191 <p>A description of each parameter follows:</p></ol>
 192
 193 <h5>image</h5>
 194 <ol><p>the image.</p></ol>
 195
 196 <h5>name</h5>
 197 <ol><p>the profile name.</p></ol>
 198
 199  </div>
 200 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 201 _8c.html" target="source" name="DestroyImageProfiles">DestroyImageProfiles</a></h2>
 202 <div class="doc-section">
 203
 204 <p>DestroyImageProfiles() releases memory associated with an image profile map.</p></ol>
 205
 206 <p>The format of the DestroyProfiles method is:</p>
 207
 208 <pre class="code">
 209   void DestroyImageProfiles(Image *image)
 210 </pre>
 211
 212 <p>A description of each parameter follows:</p></ol>
 213
 214 <h5>image</h5>
 215 <ol><p>the image.</p></ol>
 216
 217  </div>
 218 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 219 _8c.html" target="source" name="GetImageProfile">GetImageProfile</a></h2>
 220 <div class="doc-section">
 221
 222 <p>GetImageProfile() gets a profile associated with an image by name.</p></ol>
 223
 224 <p>The format of the GetImageProfile method is:</p>
 225
 226 <pre class="code">
 227   const StringInfo *GetImageProfile(const Image *image,const char *name)
 228 </pre>
 229
 230 <p>A description of each parameter follows:</p></ol>
 231
 232 <h5>image</h5>
 233 <ol><p>the image.</p></ol>
 234
 235 <h5>name</h5>
 236 <ol><p>the profile name.</p></ol>
 237
 238  </div>
 239 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 240 _8c.html" target="source" name="GetNextImageProfile">GetNextImageProfile</a></h2>
 241 <div class="doc-section">
 242
 243 <p>GetNextImageProfile() gets the next profile name for an image.</p></ol>
 244
 245 <p>The format of the GetNextImageProfile method is:</p>
 246
 247 <pre class="code">
 248   char *GetNextImageProfile(const Image *image)
 249 </pre>
 250
 251 <p>A description of each parameter follows:</p></ol>
 252
 253 <h5>hash_info</h5>
 254 <ol><p>the hash info.</p></ol>
 255
 256  </div>
 257 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 258 _8c.html" target="source" name="ProfileImage">ProfileImage</a></h2>
 259 <div class="doc-section">
 260
 261 <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>
 262
 263 <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>
 264
 265 <p>The format of the ProfileImage method is:</p>
 266
 267 <pre class="code">
 268   MagickBooleanType ProfileImage(Image *image,const char *name,
 269     const void *datum,const size_t length,const MagickBooleanType clone)
 270 </pre>
 271
 272 <p>A description of each parameter follows:</p></ol>
 273
 274 <h5>image</h5>
 275 <ol><p>the image.</p></ol>
 276
 277 <h5>name</h5>
 278 <ol><p>Name of profile to add or remove: ICC, IPTC, or generic profile.</p></ol>
 279
 280 <h5>datum</h5>
 281 <ol><p>the profile data.</p></ol>
 282
 283 <h5>length</h5>
 284 <ol><p>the length of the profile.</p></ol>
 285
 286 <h5>clone</h5>
 287 <ol><p>should be MagickFalse.</p></ol>
 288
 289  </div>
 290 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 291 _8c.html" target="source" name="RemoveImageProfile">RemoveImageProfile</a></h2>
 292 <div class="doc-section">
 293
 294 <p>RemoveImageProfile() removes a named profile from the image and returns its value.</p></ol>
 295
 296 <p>The format of the RemoveImageProfile method is:</p>
 297
 298 <pre class="code">
 299   void *RemoveImageProfile(Image *image,const char *name)
 300 </pre>
 301
 302 <p>A description of each parameter follows:</p></ol>
 303
 304 <h5>image</h5>
 305 <ol><p>the image.</p></ol>
 306
 307 <h5>name</h5>
 308 <ol><p>the profile name.</p></ol>
 309
 310  </div>
 311 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 312 _8c.html" target="source" name="ResetImageProfileIterator">ResetImageProfileIterator</a></h2>
 313 <div class="doc-section">
 314
 315 <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>
 316
 317 <p>The format of the ResetImageProfileIterator method is:</p>
 318
 319 <pre class="code">
 320   ResetImageProfileIterator(Image *image)
 321 </pre>
 322
 323 <p>A description of each parameter follows:</p></ol>
 324
 325 <h5>image</h5>
 326 <ol><p>the image.</p></ol>
 327
 328  </div>
 329 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 330 _8c.html" target="source" name="SetImageProfile">SetImageProfile</a></h2>
 331 <div class="doc-section">
 332
 333 <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>
 334
 335 <p>The format of the SetImageProfile method is:</p>
 336
 337 <pre class="code">
 338   MagickBooleanType SetImageProfile(Image *image,const char *name,
 339     const StringInfo *profile)
 340 </pre>
 341
 342 <p>A description of each parameter follows:</p></ol>
 343
 344 <h5>image</h5>
 345 <ol><p>the image.</p></ol>
 346
 347 <h5>name</h5>
 348 <ol><p>the profile name, for example icc, exif, and 8bim (8bim is the Photoshop wrapper for iptc profiles).</p></ol>
 349
 350 <h5>profile</h5>
 351 <ol><p>A StringInfo structure that contains the named profile.</p></ol>
 352
 353  </div>
 354 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 355 _8c.html" target="source" name="SyncImageProfiles">SyncImageProfiles</a></h2>
 356 <div class="doc-section">
 357
 358 <p>SyncImageProfiles() synchronizes image properties with the image profiles. Currently we only support updating the EXIF resolution and orientation.</p></ol>
 359
 360 <p>The format of the SyncImageProfiles method is:</p>
 361
 362 <pre class="code">
 363   MagickBooleanType SyncImageProfiles(Image *image)
 364 </pre>
 365
 366 <p>A description of each parameter follows:</p></ol>
 367
 368 <h5>image</h5>
 369 <ol><p>the image.</p></ol>
 370
 371  </div>
 372 \r
 373 </div>\r
 374 \r
 375 <div id="linkbar">\r
 376  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 377     <span id="linkbar-center">\r
 378       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</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-2010 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