Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 0391e8d2484e0836dfc4131c58641e319c88d4a2 / . / www / api / monitor.html
blob: 72c71d7c39ba73c6b95bf6193fbb0386f6fa9bbe [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame]3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame]5 <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
7 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
8 <style type="text/css" media="screen,projection"><!--
9 @import url("../../www/magick.css");
10 --></style>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]11 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
12 <title>ImageMagick: MagickCore, C API for ImageMagick: Monitor the Progress of an Image Operation</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:, monitor, the, progress, of, an, image, operation, 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"/>
cristy16af1cb2009-12-11 21:38:29 +0000[diff] [blame]25 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]26 <meta name="Distribution" content="Global"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]27</head>
28
29<body id="www-imagemagick-org">
30<div class="titlebar">
31<a href="../../index.html">
32 <img src="../../images/script.png" alt="[ImageMagick]"
33 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
34<a href="http://www.networkredux.com">
35 <img src="../../images/networkredux.png" alt="[sponsor]"
36 style="margin: 45px auto; border: 0px; float: left;" /></a>
37<a href="http://www.imagemagick.org/discourse-server/">
38 <img src="../../images/logo.jpg" alt=""
39 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
40<a href="../../index.html">
41 <img src="../../images/sprite.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43</div>
44
45<div class="eastbar">
46
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]47<div class="menu">
48 <a href="../../index.html">About ImageMagick</a>
49</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]50<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]81<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]106<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107<div class="menu">
108 <a href="../../www/download.html">Download</a>
109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111<div class="menu">
112 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]122<div class="menu">
123 <a href="../../www/sponsors.html">Sponsors:</a>
124
125<div class="sponsbox">
126<div class="sponsor">
cristy0391e8d2010-04-10 01:36:10 +0000[diff] [blame^]127 <a href="http://www.renehornig.com/" title="Webdesign">Webdesign</a><!-- 20110101000120 -->
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame]128</div>
129<div class="sponsor">
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]130 <a href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
131</div>
132<div class="sponsor">
cristy1f9e1ed2009-11-18 04:09:38 +0000[diff] [blame]133 <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
cristycd1da082009-11-11 02:24:40 +0000[diff] [blame]134</div>
135<div class="sponsor">
cristycdbe2742010-02-07 19:30:44 +0000[diff] [blame]136 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
cristy2744bd92009-11-08 22:57:52 +0000[diff] [blame]137</div>
138<div class="sponsor">
139 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
cristy916e1922009-10-01 12:52:47 +0000[diff] [blame]140</div>
141<div class="sponsor">
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]142 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
143</div>
144<div class="sponsor">
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]145 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]146</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]147</div>
148</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]149
150
151</div>
152
153<div class="main">
154
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]155<p class="navigation-index">[<a href="#SetImageProgressMonitor">SetImageProgressMonitor</a> &bull; <a href="#SetImageInfoProgressMonitor">SetImageInfoProgressMonitor</a>]</p>
156
157<h2><a href="http://www.imagemagick.org/api/MagickCore/monitor
158_8c.html" target="source" name="SetImageProgressMonitor">SetImageProgressMonitor</a></h2>
159<div class="doc-section">
160
161<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>
162
163<pre class="text">
164 MagickBooleanType MagickProgressMonitor(const char *text,
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]165 const MagickOffsetType offset,const MagickSizeType extent,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]166 void *client_data)
167</pre>
168
169<p>If the progress monitor returns MagickFalse, the current operation is interrupted.</p></ol>
170
171<p>The format of the SetImageProgressMonitor method is:</p>
172
173<pre class="code">
174 MagickProgressMonitor SetImageProgressMonitor(Image *image,
175 const MagickProgressMonitor progress_monitor,void *client_data)
176</pre>
177
178<p>A description of each parameter follows:</p></ol>
179
180<h5>image</h5>
181<ol><p>the image.</p></ol>
182
183<h5>progress_monitor</h5>
184<ol><p>Specifies a pointer to a method to monitor progress of an image operation.</p></ol>
185
186<h5>client_data</h5>
187<ol><p>Specifies a pointer to any client data.</p></ol>
188
189 </div>
190<h2><a href="http://www.imagemagick.org/api/MagickCore/monitor
191_8c.html" target="source" name="SetImageInfoProgressMonitor">SetImageInfoProgressMonitor</a></h2>
192<div class="doc-section">
193
194<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>
195
196<pre class="text">
197 MagickBooleanType MagickProgressMonitor(const char *text,
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]198 const MagickOffsetType offset,const MagickSizeType extent,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]199 void *client_data)
200</pre>
201
202<p>If the progress monitor returns MagickFalse, the current operation is interrupted.</p></ol>
203
204<p>The format of the SetImageInfoProgressMonitor method is:</p>
205
206<pre class="code">
207 MagickProgressMonitor SetImageInfoProgressMonitor(ImageInfo *image_info,
208 const MagickProgressMonitor progress_monitor,void *client_data)
209</pre>
210
211<p>A description of each parameter follows:</p></ol>
212
213<h5>image_info</h5>
214<ol><p>the image info.</p></ol>
215
216<h5>progress_monitor</h5>
217<ol><p>Specifies a pointer to a method to monitor progress of an image operation.</p></ol>
218
219<h5>client_data</h5>
220<ol><p>Specifies a pointer to any client data.</p></ol>
221
222 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]223
224</div>
225
226<div id="linkbar">
227 <!-- <span id="linkbar-west">&nbsp;</span> -->
228 <span id="linkbar-center">
229 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristy0391e8d2010-04-10 01:36:10 +0000[diff] [blame^]230 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]231 </span>
232 <span id="linkbar-east">&nbsp;</span>
233 </div>
234 <div class="footer">
235 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
236 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
237 </div>
238 <div style="clear: both; margin: 0; width: 100%; "></div>
239</body>
240</html>