Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 3ed852eea50f9d4cd633efb8c2b054b8e33c2530 / . / www / api / cache.html
blob: 3e94c22638ad9a3f0867295af0be4004d86974cd [file] [log] [blame]
cristy3ed852e2009-09-05 21:47:34 +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">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<head>
5 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
6 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
7 <style type="text/css" media="screen,projection"><!--
8 @import url("../../www/magick.css");
9 --></style>
10 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
11 <title>ImageMagick: MagickCore, C API for ImageMagick: Get or Set Image Pixels</title>
12 <meta http-equiv="Content-Language" content="en-US"/>
13 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
14 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
15 <meta name="Generator" content="PHP"/>
16 <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, get, or, set, image, pixels, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
17 <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."/>
18 <meta name="Rating" content="GENERAL"/>
19 <meta name="Robots" content="INDEX, FOLLOW"/>
20 <meta name="Generator" content="ImageMagick Studio LLC"/>
21 <meta name="Author" content="ImageMagick Studio LLC"/>
22 <meta name="Revisit-after" content="2 DAYS"/>
23 <meta name="Resource-type" content="document"/>
24 <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
25 <meta name="Distribution" content="Global"/>
26</head>
27
28<body id="www-imagemagick-org">
29<div class="titlebar">
30<a href="../../index.html">
31 <img src="../../images/script.png" alt="[ImageMagick]"
32 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
33<a href="http://www.networkredux.com">
34 <img src="../../images/networkredux.png" alt="[sponsor]"
35 style="margin: 45px auto; border: 0px; float: left;" /></a>
36<a href="http://www.imagemagick.org/discourse-server/">
37 <img src="../../images/logo.jpg" alt=""
38 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
39<a href="../../index.html">
40 <img src="../../images/sprite.jpg" alt=""
41 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
42</div>
43
44<div class="eastbar">
45
46<div class="menu">
47 <a href="../../index.html">About ImageMagick</a>
48</div>
49<div class="sep"></div>
50<div class="menu">
51 <a href="../../www/command-line-tools.html">Command-line Tools</a>
52</div>
53<div class="sub">
54 <a href="../../www/command-line-processing.html">Processing</a>
55</div>
56<div class="sub">
57 <a href="../../www/command-line-options.html">Options</a>
58</div>
59<div class="sub">
60 <a href="http://www.imagemagick.org/Usage/">Usage</a>
61</div>
62<div class="menu">
63 <a href="../../www/api.html">Program Interfaces</a>
64</div>
65<div class="sub">
66 <a href="../../www/magick-wand.html">MagickWand</a>
67</div>
68<div class="sub">
69 <a href="../../www/magick-core.html">MagickCore</a>
70</div>
71<div class="sub">
72 <a href="../../www/perl-magick.html">PerlMagick</a>
73</div>
74<div class="sub">
75 <a href="../../Magick++/">Magick++</a>
76</div>
77<div class="menu">
78 <a href="../../www/architecture.html">Architecture</a>
79</div>
80<div class="sep"></div>
81<div class="menu">
82 <a href="../../www/install-source.html">Install from Source</a>
83</div>
84<div class="sub">
85 <a href="../../www/install-source.html#unix">Unix</a>
86</div>
87<div class="sub">
88 <a href="../../www/install-source.html#windows">Windows</a>
89 </div>
90<div class="menu">
91 <a href="../../www/binary-releases.html">Binary Releases</a>
92</div>
93<div class="sub">
94 <a href="../../www/binary-releases.html#unix">Unix</a>
95</div>
96<div class="sub">
97 <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
98</div>
99<div class="sub">
100 <a href="../../www/binary-releases.html#windows">Windows</a>
101</div>
102<div class="menu">
103 <a href="../../www/resources.html">Resources</a>
104</div>
105<div class="sep"></div>
106<div class="menu">
107 <a href="../../www/download.html">Download</a>
108</div>
109<div class="sep"></div>
110<div class="menu">
111 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
112</div>
113<div class="sep"></div>
114<div class="menu">
115 <a href="../../www/sitemap.html">Site Map</a>
116</div>
117<div class="sub">
118 <a href="../../www/links.html">Links</a>
119</div>
120<div class="sep"></div>
121<div class="menu">
122 <a href="../../www/sponsors.html">Sponsors:</a>
123
124<div class="sponsbox">
125<div class="sponsor">
126 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
127</div>
128<div class="sponsor">
129 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
130</div>
131<div class="sponsor">
132 <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
133</div>
134<div class="sponsor">
135 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
136</div>
137<div class="sponsor">
138 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201001010120 Buchhorn -->
139</div>
140</div>
141</div>
142
143
144</div>
145
146<div class="main">
147
148<p class="navigation-index">[<a href="#AcquirePixelCacheNexus">AcquirePixelCacheNexus</a> &bull; <a href="#GetAuthenticIndexQueue">GetAuthenticIndexQueue</a> &bull; <a href="#GetAuthenticPixelQueue">GetAuthenticPixelQueue</a> &bull; <a href="#GetAuthenticPixels">GetAuthenticPixels</a> &bull; <a href="#GetOneAuthenticPixel">GetOneAuthenticPixel</a> &bull; <a href="#GetOneVirtualMagickPixel">GetOneVirtualMagickPixel</a> &bull; <a href="#GetOneVirtualMethodPixel">GetOneVirtualMethodPixel</a> &bull; <a href="#GetOneVirtualPixel">GetOneVirtualPixel</a> &bull; <a href="#GetVirtualIndexQueue">GetVirtualIndexQueue</a> &bull; <a href="#VirtualPixelModulo">VirtualPixelModulo</a> &bull; <a href="#GetVirtualPixelQueue">GetVirtualPixelQueue</a> &bull; <a href="#GetVirtualPixels">GetVirtualPixels</a> &bull; <a href="#QueueAuthenticPixels">QueueAuthenticPixels</a> &bull; <a href="#SetPixelCacheVirtualMethod">SetPixelCacheVirtualMethod</a> &bull; <a href="#SyncAuthenticPixels">SyncAuthenticPixels</a>]</p>
149
150<h2><a href="http://www.imagemagick.org/api/MagickCore/cache
151_8c.html" target="source" name="AcquirePixelCacheNexus">AcquirePixelCacheNexus</a></h2>
152<div class="doc-section">
153
154<p>AcquirePixelCacheNexus() allocates the NexusInfo structure.</p></ol>
155
156<p>The format of the AcquirePixelCacheNexus method is:</p>
157
158<pre class="code">
159 NexusInfo **AcquirePixelCacheNexus(const unsigned long number_threads)
160</pre>
161
162<p>A description of each parameter follows:</p></ol>
163
164<h5>number_threads</h5>
165<ol><p>the number of nexus threads.</p></ol>
166
167 </div>
168<h2><a href="http://www.imagemagick.org/api/MagickCore/cache
169_8c.html" target="source" name="GetAuthenticIndexQueue">GetAuthenticIndexQueue</a></h2>
170<div class="doc-section">
171
172<p>GetAuthenticIndexQueue() returns the authentic black channel or the colormap indexes associated with the last call to QueueAuthenticPixels() or GetVirtualPixels(). NULL is returned if the black channel or colormap indexes are not available.</p></ol>
173
174<p>The format of the GetAuthenticIndexQueue() method is:</p>
175
176<pre class="code">
177 IndexPacket *GetAuthenticIndexQueue(const Image *image)
178</pre>
179
180<p>A description of each parameter follows:</p></ol>
181
182<h5>image</h5>
183<ol><p>the image.</p></ol>
184
185 </div>
186<h2><a href="http://www.imagemagick.org/api/MagickCore/cache
187_8c.html" target="source" name="GetAuthenticPixelQueue">GetAuthenticPixelQueue</a></h2>
188<div class="doc-section">
189
190<p>GetAuthenticPixelQueue() returns the authentic pixels associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p></ol>
191
192<p>The format of the GetAuthenticPixelQueue() method is:</p>
193
194<pre class="code">
195 PixelPacket *GetAuthenticPixelQueue(const Image image)
196</pre>
197
198<p>A description of each parameter follows:</p></ol>
199
200<h5>image</h5>
201<ol><p>the image.</p></ol>
202
203 </div>
204<h2><a href="http://www.imagemagick.org/api/MagickCore/cache
205_8c.html" target="source" name="GetAuthenticPixels">GetAuthenticPixels</a></h2>
206<div class="doc-section">
207
208<p>GetAuthenticPixels() obtains a pixel region for read/write access. If the region is successfully accessed, a pointer to a PixelPacket array representing the region is returned, otherwise NULL is returned.</p></ol>
209
210<p>The returned pointer may point to a temporary working copy of the pixels or it may point to the original pixels in memory. Performance is maximized if the selected region is part of one row, or one or more full rows, since then there is opportunity to access the pixels in-place (without a copy) if the image is in RAM, or in a memory-mapped file. The returned pointer should *never* be deallocated by the user.</p></ol>
211
212<p>Pixels accessed via the returned pointer represent a simple array of type PixelPacket. If the image type is CMYK or if the storage class is PseduoClass, call GetAuthenticIndexQueue() after invoking GetAuthenticPixels() to obtain the black color component or colormap indexes (of type IndexPacket) corresponding to the region. Once the PixelPacket (and/or IndexPacket) array has been updated, the changes must be saved back to the underlying image using SyncAuthenticPixels() or they may be lost.</p></ol>
213
214<p>The format of the GetAuthenticPixels() method is:</p>
215
216<pre class="code">
217 PixelPacket *GetAuthenticPixels(Image *image,const long x,const long y,
218 const unsigned long columns,const unsigned long rows,
219 ExceptionInfo *exception)
220</pre>
221
222<p>A description of each parameter follows:</p></ol>
223
224<h5>image</h5>
225<ol><p>the image.</p></ol>
226
227<h5>x,y,columns,rows</h5>
228<ol><p>These values define the perimeter of a region of pixels.</p></ol>
229
230<h5>exception</h5>
231<ol><p>return any errors or warnings in this structure.</p></ol>
232
233 </div>
234<h2><a href="http://www.imagemagick.org/api/MagickCore/cache
235_8c.html" target="source" name="GetOneAuthenticPixel">GetOneAuthenticPixel</a></h2>
236<div class="doc-section">
237
238<p>GetOneAuthenticPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.</p></ol>
239
240<p>The format of the GetOneAuthenticPixel() method is:</p>
241
242<pre class="code">
243 MagickBooleanType GetOneAuthenticPixel(const Image image,const long x,
244 const long y,PixelPacket *pixel,ExceptionInfo *exception)
245</pre>
246
247<p>A description of each parameter follows:</p></ol>
248
249<h5>image</h5>
250<ol><p>the image.</p></ol>
251
252<h5>x,y</h5>
253<ol><p>These values define the location of the pixel to return.</p></ol>
254
255<h5>pixel</h5>
256<ol><p>return a pixel at the specified (x,y) location.</p></ol>
257
258<h5>exception</h5>
259<ol><p>return any errors or warnings in this structure.</p></ol>
260
261 </div>
262<h2><a href="http://www.imagemagick.org/api/MagickCore/cache
263_8c.html" target="source" name="GetOneVirtualMagickPixel">GetOneVirtualMagickPixel</a></h2>
264<div class="doc-section">
265
266<p>GetOneVirtualMagickPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs. If you plan to modify the pixel, use GetOneAuthenticPixel() instead.</p></ol>
267
268<p>The format of the GetOneVirtualMagickPixel() method is:</p>
269
270<pre class="code">
271 MagickBooleanType GetOneVirtualMagickPixel(const Image image,
272 const long x,const long y,MagickPixelPacket *pixel,
273 ExceptionInfo exception)
274</pre>
275
276<p>A description of each parameter follows:</p></ol>
277
278<h5>image</h5>
279<ol><p>the image.</p></ol>
280
281<h5>x,y</h5>
282<ol><p>these values define the location of the pixel to return.</p></ol>
283
284<h5>pixel</h5>
285<ol><p>return a pixel at the specified (x,y) location.</p></ol>
286
287<h5>exception</h5>
288<ol><p>return any errors or warnings in this structure.</p></ol>
289
290 </div>
291<h2><a href="http://www.imagemagick.org/api/MagickCore/cache
292_8c.html" target="source" name="GetOneVirtualMethodPixel">GetOneVirtualMethodPixel</a></h2>
293<div class="doc-section">
294
295<p>GetOneVirtualMethodPixel() returns a single pixel at the specified (x,y) location as defined by specified pixel method. The image background color is returned if an error occurs. If you plan to modify the pixel, use GetOneAuthenticPixel() instead.</p></ol>
296
297<p>The format of the GetOneVirtualMethodPixel() method is:</p>
298
299<pre class="code">
300 MagickBooleanType GetOneVirtualMethodPixel(const Image image,
301 const VirtualPixelMethod virtual_pixel_method,const long x,
302 const long y,Pixelpacket *pixel,ExceptionInfo exception)
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>virtual_pixel_method</h5>
311<ol><p>the virtual pixel method.</p></ol>
312
313<h5>x,y</h5>
314<ol><p>These values define the location of the pixel to return.</p></ol>
315
316<h5>pixel</h5>
317<ol><p>return a pixel at the specified (x,y) location.</p></ol>
318
319<h5>exception</h5>
320<ol><p>return any errors or warnings in this structure.</p></ol>
321
322 </div>
323<h2><a href="http://www.imagemagick.org/api/MagickCore/cache
324_8c.html" target="source" name="GetOneVirtualPixel">GetOneVirtualPixel</a></h2>
325<div class="doc-section">
326
327<p>GetOneVirtualPixel() returns a single virtual pixel at the specified (x,y) location. The image background color is returned if an error occurs. If you plan to modify the pixel, use GetOneAuthenticPixel() instead.</p></ol>
328
329<p>The format of the GetOneVirtualPixel() method is:</p>
330
331<pre class="code">
332 MagickBooleanType GetOneVirtualPixel(const Image image,const long x,
333 const long y,PixelPacket *pixel,ExceptionInfo exception)
334</pre>
335
336<p>A description of each parameter follows:</p></ol>
337
338<h5>image</h5>
339<ol><p>the image.</p></ol>
340
341<h5>x,y</h5>
342<ol><p>These values define the location of the pixel to return.</p></ol>
343
344<h5>pixel</h5>
345<ol><p>return a pixel at the specified (x,y) location.</p></ol>
346
347<h5>exception</h5>
348<ol><p>return any errors or warnings in this structure.</p></ol>
349
350 </div>
351<h2><a href="http://www.imagemagick.org/api/MagickCore/cache
352_8c.html" target="source" name="GetVirtualIndexQueue">GetVirtualIndexQueue</a></h2>
353<div class="doc-section">
354
355<p>GetVirtualIndexQueue() returns the virtual black channel or the colormap indexes associated with the last call to QueueAuthenticPixels() or GetVirtualPixels(). NULL is returned if the black channel or colormap indexes are not available.</p></ol>
356
357<p>The format of the GetVirtualIndexQueue() method is:</p>
358
359<pre class="code">
360 const IndexPacket *GetVirtualIndexQueue(const Image *image)
361</pre>
362
363<p>A description of each parameter follows:</p></ol>
364
365<h5>image</h5>
366<ol><p>the image.</p></ol>
367
368 </div>
369<h2><a href="http://www.imagemagick.org/api/MagickCore/cache
370_8c.html" target="source" name="VirtualPixelModulo">VirtualPixelModulo</a></h2>
371<div class="doc-section">
372
373<p>VirtualPixelModulo() computes the remainder of dividing offset by extent. It returns not only the quotient (tile the offset falls in) but also the positive remainer within that tile such that 0 <= remainder < extent. This method is essentially a ldiv() using a floored modulo division rather than the normal default truncated modulo division. </p>
374 </div>
375<h2><a href="http://www.imagemagick.org/api/MagickCore/cache
376_8c.html" target="source" name="GetVirtualPixelQueue">GetVirtualPixelQueue</a></h2>
377<div class="doc-section">
378
379<p>GetVirtualPixelQueue() returns the virtual pixels associated with the last call to QueueAuthenticPixels() or GetVirtualPixels().</p></ol>
380
381<p>The format of the GetVirtualPixelQueue() method is:</p>
382
383<pre class="code">
384 const PixelPacket *GetVirtualPixelQueue(const Image image)
385</pre>
386
387<p>A description of each parameter follows:</p></ol>
388
389<h5>image</h5>
390<ol><p>the image.</p></ol>
391
392 </div>
393<h2><a href="http://www.imagemagick.org/api/MagickCore/cache
394_8c.html" target="source" name="GetVirtualPixels">GetVirtualPixels</a></h2>
395<div class="doc-section">
396
397<p>GetVirtualPixels() returns an immutable pixel region. If the region is successfully accessed, a pointer to it is returned, otherwise NULL is returned. The returned pointer may point to a temporary working copy of the pixels or it may point to the original pixels in memory. Performance is maximized if the selected region is part of one row, or one or more full rows, since there is opportunity to access the pixels in-place (without a copy) if the image is in RAM, or in a memory-mapped file. The returned pointer should *never* be deallocated by the user.</p></ol>
398
399<p>Pixels accessed via the returned pointer represent a simple array of type PixelPacket. If the image type is CMYK or the storage class is PseudoClass, call GetAuthenticIndexQueue() after invoking GetAuthenticPixels() to access the black color component or to obtain the colormap indexes (of type IndexPacket) corresponding to the region.</p></ol>
400
401<p>If you plan to modify the pixels, use GetAuthenticPixels() instead.</p></ol>
402
403<p>Note, the GetVirtualPixels() and GetAuthenticPixels() methods are not thread- safe. In a threaded environment, use GetCacheViewVirtualPixels() or GetCacheViewAuthenticPixels() instead.</p></ol>
404
405<p>The format of the GetVirtualPixels() method is:</p>
406
407<pre class="code">
408 const PixelPacket *GetVirtualPixels(const Image *image,const long x,
409 const long y,const unsigned long columns,const unsigned long rows,
410 ExceptionInfo *exception)
411</pre>
412
413<p>A description of each parameter follows:</p></ol>
414
415<h5>image</h5>
416<ol><p>the image.</p></ol>
417
418<h5>x,y,columns,rows</h5>
419<ol><p>These values define the perimeter of a region of pixels.</p></ol>
420
421<h5>exception</h5>
422<ol><p>return any errors or warnings in this structure.</p></ol>
423
424 </div>
425<h2><a href="http://www.imagemagick.org/api/MagickCore/cache
426_8c.html" target="source" name="QueueAuthenticPixels">QueueAuthenticPixels</a></h2>
427<div class="doc-section">
428
429<p>QueueAuthenticPixels() queues a mutable pixel region. If the region is successfully intialized a pointer to a PixelPacket array representing the region is returned, otherwise NULL is returned. The returned pointer may point to a temporary working buffer for the pixels or it may point to the final location of the pixels in memory.</p></ol>
430
431<p>Write-only access means that any existing pixel values corresponding to the region are ignored. This is useful if the initial image is being created from scratch, or if the existing pixel values are to be completely replaced without need to refer to their pre-existing values. The application is free to read and write the pixel buffer returned by QueueAuthenticPixels() any way it pleases. QueueAuthenticPixels() does not initialize the pixel array values. Initializing pixel array values is the application's responsibility.</p></ol>
432
433<p>Performance is maximized if the selected region is part of one row, or one or more full rows, since then there is opportunity to access the pixels in-place (without a copy) if the image is in RAM, or in a memory-mapped file. The returned pointer should *never* be deallocated by the user.</p></ol>
434
435<p>Pixels accessed via the returned pointer represent a simple array of type PixelPacket. If the image type is CMYK or the storage class is PseudoClass, call GetAuthenticIndexQueue() after invoking GetAuthenticPixels() to obtain the black color component or the colormap indexes (of type IndexPacket) corresponding to the region. Once the PixelPacket (and/or IndexPacket) array has been updated, the changes must be saved back to the underlying image using SyncAuthenticPixels() or they may be lost.</p></ol>
436
437<p>The format of the QueueAuthenticPixels() method is:</p>
438
439<pre class="code">
440 PixelPacket *QueueAuthenticPixels(Image *image,const long x,const long y,
441 const unsigned long columns,const unsigned long rows,
442 ExceptionInfo *exception)
443</pre>
444
445<p>A description of each parameter follows:</p></ol>
446
447<h5>image</h5>
448<ol><p>the image.</p></ol>
449
450<h5>x,y,columns,rows</h5>
451<ol><p>These values define the perimeter of a region of pixels.</p></ol>
452
453<h5>exception</h5>
454<ol><p>return any errors or warnings in this structure.</p></ol>
455
456 </div>
457<h2><a href="http://www.imagemagick.org/api/MagickCore/cache
458_8c.html" target="source" name="SetPixelCacheVirtualMethod">SetPixelCacheVirtualMethod</a></h2>
459<div class="doc-section">
460
461<p>SetPixelCacheVirtualMethod() sets the "virtual pixels" method for the pixel cache and returns the previous setting. A virtual pixel is any pixel access that is outside the boundaries of the image cache.</p></ol>
462
463<p>The format of the SetPixelCacheVirtualMethod() method is:</p>
464
465<pre class="code">
466 VirtualPixelMethod SetPixelCacheVirtualMethod(const Image *image,
467 const VirtualPixelMethod virtual_pixel_method)
468</pre>
469
470<p>A description of each parameter follows:</p></ol>
471
472<h5>image</h5>
473<ol><p>the image.</p></ol>
474
475<h5>virtual_pixel_method</h5>
476<ol><p>choose the type of virtual pixel.</p></ol>
477
478 </div>
479<h2><a href="http://www.imagemagick.org/api/MagickCore/cache
480_8c.html" target="source" name="SyncAuthenticPixels">SyncAuthenticPixels</a></h2>
481<div class="doc-section">
482
483<p>SyncAuthenticPixels() saves the image pixels to the in-memory or disk cache. The method returns MagickTrue if the pixel region is flushed, otherwise MagickFalse.</p></ol>
484
485<p>The format of the SyncAuthenticPixels() method is:</p>
486
487<pre class="code">
488 MagickBooleanType SyncAuthenticPixels(Image *image,
489 ExceptionInfo *exception)
490</pre>
491
492<p>A description of each parameter follows:</p></ol>
493
494<h5>image</h5>
495<ol><p>the image.</p></ol>
496
497<h5>exception</h5>
498<ol><p>return any errors or warnings in this structure.</p></ol>
499
500 </div>
501
502</div>
503
504<div id="linkbar">
505 <!-- <span id="linkbar-west">&nbsp;</span> -->
506 <span id="linkbar-center">
507 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
508 <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
509 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
510 </span>
511 <span id="linkbar-east">&nbsp;</span>
512 </div>
513 <div class="footer">
514 <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
515 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
516 </div>
517 <div style="clear: both; margin: 0; width: 100%; "></div>
518</body>
519</html>