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: Monitor the Progress of an Image Operation @ 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:, monitor, the, progress, of, an, image, operation, 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-2019 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="monitor.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="monitor.html#SetImageProgress">SetImageProgress</a> &#8226; <a href="monitor.html#SetImageProgressMonitor">SetImageProgressMonitor</a> &#8226; <a href="monitor.html#SetImageInfoProgressMonitor">SetImageInfoProgressMonitor</a></p>
     85 
     86 <h2><a href="../../api/MagickCore/monitor_8c.html" id="SetImageProgress">SetImageProgress</a></h2>
     87 
     88 <p>SetImageProgress() returns the progress of an image processing operation.</p>
     89 
     90 <p>The format of the SetImageProgress method is:</p>
     91 
     92 <pre class="text">
     93     MagickBooleanType SetImageProgress(const char *text,
     94 const MagickOffsetType offset,const MagickSizeType extent)
     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>text</dt>
    109 <dd>description of the image processing operation. </dd>
    110 
    111 <dd> </dd>
    112 <dt>offset</dt>
    113 <dd>the offset relative to the extent parameter. </dd>
    114 
    115 <dd> </dd>
    116 <dt>extent</dt>
    117 <dd>the extent of the progress. </dd>
    118 
    119 <dd>  </dd>
    120 </dl>
    121 <h2><a href="../../api/MagickCore/monitor_8c.html" id="SetImageProgressMonitor">SetImageProgressMonitor</a></h2>
    122 
    123 <p>SetImageProgressMonitor() sets the image progress monitor to the specified method and returns the previous progress monitor if any.  The progress monitor method looks like this:</p>
    124 
    125 <pre class="text">
    126     MagickBooleanType MagickProgressMonitor(const char *text,
    127 const MagickOffsetType offset,const MagickSizeType extent,
    128 void *client_data)
    129 </pre>
    130 
    131 <p>If the progress monitor returns MagickFalse, the current operation is interrupted.</p>
    132 
    133 <p>The format of the SetImageProgressMonitor method is:</p>
    134 
    135 <pre class="text">
    136 MagickProgressMonitor SetImageProgressMonitor(Image *image,
    137   const MagickProgressMonitor progress_monitor,void *client_data)
    138 </pre>
    139 
    140 <p>A description of each parameter follows:</p>
    141 
    142 <dd>
    143 </dd>
    144 
    145 <dd> </dd>
    146 <dl class="dl-horizontal">
    147 <dt>image</dt>
    148 <dd>the image. </dd>
    149 
    150 <dd> </dd>
    151 <dt>progress_monitor</dt>
    152 <dd>Specifies a pointer to a method to monitor progress of an image operation. </dd>
    153 
    154 <dd> </dd>
    155 <dt>client_data</dt>
    156 <dd>Specifies a pointer to any client data. </dd>
    157 
    158 <dd>  </dd>
    159 </dl>
    160 <h2><a href="../../api/MagickCore/monitor_8c.html" id="SetImageInfoProgressMonitor">SetImageInfoProgressMonitor</a></h2>
    161 
    162 <p>SetImageInfoProgressMonitor() sets the image_info progress monitor to the specified method and returns the previous progress monitor if any.  The progress monitor method looks like this:</p>
    163 
    164 <pre class="text">
    165     MagickBooleanType MagickProgressMonitor(const char *text,
    166 const MagickOffsetType offset,const MagickSizeType extent,
    167 void *client_data)
    168 </pre>
    169 
    170 <p>If the progress monitor returns MagickFalse, the current operation is interrupted.</p>
    171 
    172 <p>The format of the SetImageInfoProgressMonitor method is:</p>
    173 
    174 <pre class="text">
    175 MagickProgressMonitor SetImageInfoProgressMonitor(ImageInfo *image_info,
    176   const MagickProgressMonitor progress_monitor,void *client_data)
    177 </pre>
    178 
    179 <p>A description of each parameter follows:</p>
    180 
    181 <dd>
    182 </dd>
    183 
    184 <dd> </dd>
    185 <dl class="dl-horizontal">
    186 <dt>image_info</dt>
    187 <dd>the image info. </dd>
    188 
    189 <dd> </dd>
    190 <dt>progress_monitor</dt>
    191 <dd>Specifies a pointer to a method to monitor progress of an image operation. </dd>
    192 
    193 <dd> </dd>
    194 <dt>client_data</dt>
    195 <dd>Specifies a pointer to any client data. </dd>
    196 
    197 <dd>  </dd>
    198 </dl>
    199 </div>
    200     </div>
    201   </main><!-- /.container -->
    202   <footer class="magick-footer">
    203     <p><a href="../../www/security-policy.html">Security</a> 
    204     <a href="../../www/architecture.html">Architecture</a> 
    205     <a href="../../www/links.html">Related</a> 
    206      <a href="../../www/sitemap.html">Sitemap</a>
    207        
    208     <a href="monitor.html#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../../images/wand.ico"/></a>
    209        
    210     <a href="http://pgp.mit.edu/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> 
    211     <a href="../../www/support.html">Donate</a> 
    212     <a href="../../www/contact.html">Contact Us</a>
    213     <br/>
    214     <small> 1999-2019 ImageMagick Studio LLC</small></p>
    215   </footer>
    216 
    217   <!-- Javascript assets -->
    218   <script src="../assets/magick.js" crossorigin="anonymous"></script>
    219   <script>window.jQuery || document.write('<script src="https://localhost/ajax/libs/jquery/3.3.1/jquery.min.js"><\/script>')</script>
    220 </body>
    221 </html>
    222 <!-- Magick Cache 3rd January 2019 20:55 -->