Home | History | Annotate | Download | only in api
      1 
      2 
      3 
      4 
      5 <!DOCTYPE html>
      6 <html lang="en">
      7 <head>
      8   <meta charset="utf-8"  />
      9   <meta name="viewport" content="width=device-width,minimum-scale=1,initial-scale=1,shrink-to-fit=no"  />
     10   <title>MagickCore, C API: Dealing with Image Profiles @ ImageMagick</title>
     11   <meta name="application-name" content="ImageMagick" />
     12   <meta name="description" content="Use ImageMagick to create, edit, compose, or convert bitmap images. You can resize your image, crop it, change its shades and colors, add captions, among other operations." />
     13   <meta name="application-url" content="https://imagemagick.org" />
     14   <meta name="generator" content="PHP" />
     15   <meta name="keywords" content="magickcore, c, api:, 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" />
     22   <meta name="copyright" content="Copyright (c) 1999-2017 ImageMagick Studio LLC" />
     23   <meta name="distribution" content="Global" />
     24   <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1" />
     25   <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
     26   <link href="profile.html" rel="canonical" />
     27   <link href="../../images/wand.png" rel="icon" />
     28   <link href="../../images/wand.ico" rel="shortcut icon" />
     29   <link href="../assets/magick.css" rel="stylesheet" />
     30 </head>
     31 <body>
     32   <header>
     33   <nav class="navbar navbar-expand-md navbar-dark fixed-top bg-dark">
     34     <a class="navbar-brand" href="../../"><img class="d-block" id="icon" alt="ImageMagick" width="32" height="32" src="../../images/wand.ico"/></a>
     35     <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarsMagick" aria-controls="navbarsMagick" aria-expanded="false" aria-label="Toggle navigation">
     36       <span class="navbar-toggler-icon"></span>
     37     </button>
     38 
     39     <div class="navbar-collapse collapse" id="navbarsMagick" style="">
     40     <ul class="navbar-nav mr-auto">
     41       <li class="nav-item ">
     42         <a class="nav-link" href="quantize.html">Home <span class="sr-only">(current)</span></a>
     43       </li>
     44       <li class="nav-item ">
     45         <a class="nav-link" href="../../www/download.html">Download</a>
     46       </li>
     47       <li class="nav-item ">
     48         <a class="nav-link" href="../../www/command-line-tools.html">Tools</a>
     49       </li>
     50       <li class="nav-item ">
     51         <a class="nav-link" href="../../www/command-line-processing.html">Command-line</a>
     52       </li>
     53       <li class="nav-item ">
     54         <a class="nav-link" href="../../www/resources.html">Resources</a>
     55       </li>
     56       <li class="nav-item ">
     57         <a class="nav-link" href="../../www/develop.html">Develop</a>
     58       </li>
     59       <li class="nav-item">
     60         <a class="nav-link" target="_blank" href="https://imagemagick.org/discourse-server/">Community</a>
     61       </li>
     62     </ul>
     63     <form class="form-inline my-2 my-lg-0" action="https://imagemagick.org/script/search.php">
     64       <input class="form-control mr-sm-2" type="text" name="q" placeholder="Search" aria-label="Search">
     65       <button class="btn btn-outline-success my-2 my-sm-0" type="submit" name="sa">Search</button>
     66     </form>
     67     </div>
     68   </nav>
     69   <div class="container">
     70    <script async="async" src="https://localhost/pagead/js/adsbygoogle.js"></script>    <ins class="adsbygoogle"
     71          style="display:block"
     72          data-ad-client="ca-pub-3129977114552745"
     73          data-ad-slot="6345125851"
     74          data-ad-format="auto"></ins>
     75     <script>
     76       (adsbygoogle = window.adsbygoogle || []).push({});
     77     </script>
     78 
     79   </div>
     80   </header>
     81   <main class="container">
     82     <div class="magick-template">
     83 <div class="magick-header">
     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>
     85 
     86 <h2><a href="../../api/MagickCore/profile_8c.html" id="CloneImageProfiles">CloneImageProfiles</a></h2>
     87 
     88 <p>CloneImageProfiles() clones one or more image profiles.</p>
     89 
     90 <p>The format of the CloneImageProfiles method is:</p>
     91 
     92 <pre class="text">
     93 MagickBooleanType CloneImageProfiles(Image *image,
     94   const Image *clone_image)
     95 </pre>
     96 
     97 <p>A description of each parameter follows:</p>
     98 
     99 <dd>
    100 </dd>
    101 
    102 <dd> </dd>
    103 <dl class="dl-horizontal">
    104 <dt>image</dt>
    105 <dd>the image. </dd>
    106 
    107 <dd> </dd>
    108 <dt>clone_image</dt>
    109 <dd>the clone image. </dd>
    110 
    111 <dd>  </dd>
    112 </dl>
    113 <h2><a href="../../api/MagickCore/profile_8c.html" id="DeleteImageProfile">DeleteImageProfile</a></h2>
    114 
    115 <p>DeleteImageProfile() deletes a profile from the image by its name.</p>
    116 
    117 <p>The format of the DeleteImageProfile method is:</p>
    118 
    119 <pre class="text">
    120 MagickBooleanTyupe DeleteImageProfile(Image *image,const char *name)
    121 </pre>
    122 
    123 <p>A description of each parameter follows:</p>
    124 
    125 <dd>
    126 </dd>
    127 
    128 <dd> </dd>
    129 <dl class="dl-horizontal">
    130 <dt>image</dt>
    131 <dd>the image. </dd>
    132 
    133 <dd> </dd>
    134 <dt>name</dt>
    135 <dd>the profile name. </dd>
    136 
    137 <dd>  </dd>
    138 </dl>
    139 <h2><a href="../../api/MagickCore/profile_8c.html" id="DestroyImageProfiles">DestroyImageProfiles</a></h2>
    140 
    141 <p>DestroyImageProfiles() releases memory associated with an image profile map.</p>
    142 
    143 <p>The format of the DestroyProfiles method is:</p>
    144 
    145 <pre class="text">
    146 void DestroyImageProfiles(Image *image)
    147 </pre>
    148 
    149 <p>A description of each parameter follows:</p>
    150 
    151 <dd>
    152 </dd>
    153 
    154 <dd> </dd>
    155 <dl class="dl-horizontal">
    156 <dt>image</dt>
    157 <dd>the image. </dd>
    158 
    159 <dd>  </dd>
    160 </dl>
    161 <h2><a href="../../api/MagickCore/profile_8c.html" id="GetImageProfile">GetImageProfile</a></h2>
    162 
    163 <p>GetImageProfile() gets a profile associated with an image by name.</p>
    164 
    165 <p>The format of the GetImageProfile method is:</p>
    166 
    167 <pre class="text">
    168 const StringInfo *GetImageProfile(const Image *image,const char *name)
    169 </pre>
    170 
    171 <p>A description of each parameter follows:</p>
    172 
    173 <dd>
    174 </dd>
    175 
    176 <dd> </dd>
    177 <dl class="dl-horizontal">
    178 <dt>image</dt>
    179 <dd>the image. </dd>
    180 
    181 <dd> </dd>
    182 <dt>name</dt>
    183 <dd>the profile name. </dd>
    184 
    185 <dd>  </dd>
    186 </dl>
    187 <h2><a href="../../api/MagickCore/profile_8c.html" id="GetNextImageProfile">GetNextImageProfile</a></h2>
    188 
    189 <p>GetNextImageProfile() gets the next profile name for an image.</p>
    190 
    191 <p>The format of the GetNextImageProfile method is:</p>
    192 
    193 <pre class="text">
    194 char *GetNextImageProfile(const Image *image)
    195 </pre>
    196 
    197 <p>A description of each parameter follows:</p>
    198 
    199 <dd>
    200 </dd>
    201 
    202 <dd> </dd>
    203 <dl class="dl-horizontal">
    204 <dt>hash_info</dt>
    205 <dd>the hash info. </dd>
    206 
    207 <dd>  </dd>
    208 </dl>
    209 <h2><a href="../../api/MagickCore/profile_8c.html" id="ProfileImage">ProfileImage</a></h2>
    210 
    211 <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>
    212 
    213 <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>
    214 
    215 <p>The format of the ProfileImage method is:</p>
    216 
    217 <pre class="text">
    218 MagickBooleanType ProfileImage(Image *image,const char *name,
    219   const void *datum,const size_t length,const MagickBooleanType clone)
    220 </pre>
    221 
    222 <p>A description of each parameter follows:</p>
    223 
    224 <dd>
    225 </dd>
    226 
    227 <dd> </dd>
    228 <dl class="dl-horizontal">
    229 <dt>image</dt>
    230 <dd>the image. </dd>
    231 
    232 <dd> </dd>
    233 <dt>name</dt>
    234 <dd>Name of profile to add or remove: ICC, IPTC, or generic profile. </dd>
    235 
    236 <dd> </dd>
    237 <dt>datum</dt>
    238 <dd>the profile data. </dd>
    239 
    240 <dd> </dd>
    241 <dt>length</dt>
    242 <dd>the length of the profile. </dd>
    243 
    244 <dd> </dd>
    245 <dt>clone</dt>
    246 <dd>should be MagickFalse. </dd>
    247 
    248 <dd>  </dd>
    249 </dl>
    250 <h2><a href="../../api/MagickCore/profile_8c.html" id="RemoveImageProfile">RemoveImageProfile</a></h2>
    251 
    252 <p>RemoveImageProfile() removes a named profile from the image and returns its value.</p>
    253 
    254 <p>The format of the RemoveImageProfile method is:</p>
    255 
    256 <pre class="text">
    257 void *RemoveImageProfile(Image *image,const char *name)
    258 </pre>
    259 
    260 <p>A description of each parameter follows:</p>
    261 
    262 <dd>
    263 </dd>
    264 
    265 <dd> </dd>
    266 <dl class="dl-horizontal">
    267 <dt>image</dt>
    268 <dd>the image. </dd>
    269 
    270 <dd> </dd>
    271 <dt>name</dt>
    272 <dd>the profile name. </dd>
    273 
    274 <dd>  </dd>
    275 </dl>
    276 <h2><a href="../../api/MagickCore/profile_8c.html" id="ResetImageProfileIterator">ResetImageProfileIterator</a></h2>
    277 
    278 <p>ResetImageProfileIterator() resets the image profile iterator.  Use it in conjunction with GetNextImageProfile() to iterate over all the profiles associated with an image.</p>
    279 
    280 <p>The format of the ResetImageProfileIterator method is:</p>
    281 
    282 <pre class="text">
    283 ResetImageProfileIterator(Image *image)
    284 </pre>
    285 
    286 <p>A description of each parameter follows:</p>
    287 
    288 <dd>
    289 </dd>
    290 
    291 <dd> </dd>
    292 <dl class="dl-horizontal">
    293 <dt>image</dt>
    294 <dd>the image. </dd>
    295 
    296 <dd>  </dd>
    297 </dl>
    298 <h2><a href="../../api/MagickCore/profile_8c.html" id="SetImageProfile">SetImageProfile</a></h2>
    299 
    300 <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>
    301 
    302 <p>The format of the SetImageProfile method is:</p>
    303 
    304 <pre class="text">
    305 MagickBooleanType SetImageProfile(Image *image,const char *name,
    306   const StringInfo *profile)
    307 </pre>
    308 
    309 <p>A description of each parameter follows:</p>
    310 
    311 <dd>
    312 </dd>
    313 
    314 <dd> </dd>
    315 <dl class="dl-horizontal">
    316 <dt>image</dt>
    317 <dd>the image. </dd>
    318 
    319 <dd> </dd>
    320 <dt>name</dt>
    321 <dd>the profile name, for example icc, exif, and 8bim (8bim is the Photoshop wrapper for iptc profiles). </dd>
    322 
    323 <dd> </dd>
    324 <dt>profile</dt>
    325 <dd>A StringInfo structure that contains the named profile. </dd>
    326 
    327 <dd>  </dd>
    328 </dl>
    329 <h2><a href="../../api/MagickCore/profile_8c.html" id="SyncImageProfiles">SyncImageProfiles</a></h2>
    330 
    331 <p>SyncImageProfiles() synchronizes image properties with the image profiles. Currently we only support updating the EXIF resolution and orientation.</p>
    332 
    333 <p>The format of the SyncImageProfiles method is:</p>
    334 
    335 <pre class="text">
    336 MagickBooleanType SyncImageProfiles(Image *image)
    337 </pre>
    338 
    339 <p>A description of each parameter follows:</p>
    340 
    341 <dd>
    342 </dd>
    343 
    344 <dd> </dd>
    345 <dl class="dl-horizontal">
    346 <dt>image</dt>
    347 <dd>the image. </dd>
    348 
    349 <dd>  </dd>
    350 </dl>
    351 </div>
    352     </div>
    353   </main><!-- /.container -->
    354   <footer class="magick-footer">
    355     <p><a href="../../www/security-policy.html">Security</a> 
    356     <a href="../../www/architecture.html">Architecture</a> 
    357     <a href="../../www/links.html">Related</a> 
    358      <a href="../../www/sitemap.html">Sitemap</a>
    359        
    360     <a href="profile.html#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../../images/wand.ico"/></a>
    361        
    362     <a href="http://pgp.mit.edu/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> 
    363     <a href="../../www/support.html">Donate</a> 
    364     <a href="../../www/contact.html">Contact Us</a>
    365     <br/>
    366     <small> 1999-2019 ImageMagick Studio LLC</small></p>
    367   </footer>
    368 
    369   <!-- Javascript assets -->
    370   <script src="../assets/magick.js" crossorigin="anonymous"></script>
    371   <script>window.jQuery || document.write('<script src="https://localhost/ajax/libs/jquery/3.3.1/jquery.min.js"><\/script>')</script>
    372 </body>
    373 </html>
    374 <!-- Magick Cache 30th December 2018 16:18 -->