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
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
\r
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
\r
7 <title>ImageMagick: MagickCore, C API for ImageMagick: Deprecated Methods</title/>
8 <meta http-equiv="Content-Language" content="en-US"/>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
10 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
11 <meta name="Application-name" content="ImageMagick"/>
12 <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."/>
13 <meta name="Application-url" content="http://www.imagemagick.org"/>
14 <meta name="Generator" content="PHP"/>
15 <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, deprecated, methods, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
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-2010 ImageMagick Studio LLC"/>
23 <meta name="Distribution" content="Global"/>
24 <link rel="icon" href="../../images/wand.png" sizes="32x32"/>
25 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
\r
27 <style type="text/css" media="all">
\r
28 @import url("../../www/magick.css");
\r
32 <body id="www-imagemagick-org">
\r
33 <div class="titlebar">
\r
34 <a href="../../index.html">
\r
35 <img src="../../images/script.png" alt="[ImageMagick]"
\r
36 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
\r
37 <a href="http://www.networkredux.com">
\r
38 <img src="../../images/networkredux.png" alt="[sponsor]"
\r
39 style="margin: 45px auto; border: 0px; float: left;" /></a>
\r
40 <a href="http://www.imagemagick.org/discourse-server/">
\r
41 <img src="../../images/logo.jpg" alt=""
\r
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
43 <a href="../../index.html">
\r
44 <img src="../../images/sprite.jpg" alt=""
\r
45 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
48 <div class="westbar">
\r
51 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
53 <div class="sep"></div>
\r
55 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
58 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
61 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
64 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
66 <div class="sep"></div>
\r
68 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
71 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
74 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
77 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
80 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
83 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
86 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
89 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
92 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
94 <div class="sep"></div>
\r
96 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
99 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
102 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
105 <a title="Resources" href="../../www/resources.html">Resources</a>
108 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
111 <a title="Download" href="../../www/download.html">Download</a>
113 <div class="sep"></div>
\r
115 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
117 <div class="sep"></div>
\r
119 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
122 <a title="Site Map: Links"href="../../www/links.html">Links</a>
124 <div class="sep"></div>
\r
126 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
128 <div class="sponsbox">
129 <div class="sponsor">
130 <a title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
132 <div class="sponsor">
133 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
135 <div class="sponsor">
136 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
138 <div class="sponsor">
139 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
141 <div class="sponsor">
142 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
144 <div class="sponsor">
145 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
147 <div class="sponsor">
148 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
154 <div class="eastbar">
\r
155 <script type="text/javascript">
\r
157 google_ad_client = "pub-3129977114552745";
\r
158 google_ad_slot = "0574824969";
\r
159 google_ad_width = 160;
\r
160 google_ad_height = 600;
\r
163 <script type="text/javascript"
\r
164 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
\r
170 <p class="navigation-index">[<a href="#AcquireCacheViewIndexes">AcquireCacheViewIndexes</a> • <a href="#AcquireCacheViewPixels">AcquireCacheViewPixels</a> • <a href="#AcquireImagePixels">AcquireImagePixels</a> • <a href="#AcquireIndexes">AcquireIndexes</a> • <a href="#AcquireMemory">AcquireMemory</a> • <a href="#AcquireOneCacheViewPixel">AcquireOneCacheViewPixel</a> • <a href="#AcquireOneCacheViewVirtualPixel">AcquireOneCacheViewVirtualPixel</a> • <a href="#AcquireOneMagickPixel">AcquireOneMagickPixel</a> • <a href="#AcquireOnePixel">AcquireOnePixel</a> • <a href="#AcquireOneVirtualPixel">AcquireOneVirtualPixel</a> • <a href="#AcquirePixels">AcquirePixels</a> • <a href="#AffinityImage">AffinityImage</a> • <a href="#AffinityImages">AffinityImages</a> • <a href="#AllocateImage">AllocateImage</a> • <a href="#AllocateImageColormap">AllocateImageColormap</a> • <a href="#AllocateNextImage">AllocateNextImage</a> • <a href="#AllocateString">AllocateString</a> • <a href="#AverageImages">AverageImages</a> • <a href="#ChannelThresholdImage">ChannelThresholdImage</a> • <a href="#ClipPathImage">ClipPathImage</a> • <a href="#CloneImageAttributes">CloneImageAttributes</a> • <a href="#CloneMemory">CloneMemory</a> • <a href="#CloseCacheView">CloseCacheView</a> • <a href="#ColorFloodfill">ColorFloodfill</a> • <a href="#DeleteImageAttribute">DeleteImageAttribute</a> • <a href="#DeleteImageList">DeleteImageList</a> • <a href="#DeleteMagickRegistry">DeleteMagickRegistry</a> • <a href="#DescribeImage">DescribeImage</a> • <a href="#DestroyImageAttributes">DestroyImageAttributes</a> • <a href="#DestroyImages">DestroyImages</a> • <a href="#DestroyMagick">DestroyMagick</a> • <a href="#DispatchImage">DispatchImage</a> • <a href="#ExtractSubimageFromImageImage">ExtractSubimageFromImageImage</a> • <a href="#FlattenImages">FlattenImages</a> • <a href="#FormatImageAttribute">FormatImageAttribute</a> • <a href="#FormatString">FormatString</a> • <a href="#GetConfigureBlob">GetConfigureBlob</a> • <a href="#GetCacheView">GetCacheView</a> • <a href="#GetCacheViewIndexes">GetCacheViewIndexes</a> • <a href="#GetCacheViewPixels">GetCacheViewPixels</a> • <a href="#GetImageAttribute">GetImageAttribute</a> • <a href="#GetImageClippingPathAttribute">GetImageClippingPathAttribute</a> • <a href="#GetImageFromMagickRegistry">GetImageFromMagickRegistry</a> • <a href="#GetMagickRegistry">GetMagickRegistry</a> • <a href="#GetImageGeometry">GetImageGeometry</a> • <a href="#GetImageList">GetImageList</a> • <a href="#GetImageListIndex">GetImageListIndex</a> • <a href="#GetImageListSize">GetImageListSize</a> • <a href="#GetImagePixels">GetImagePixels</a> • <a href="#GetIndexes">GetIndexes</a> • <a href="#GetNextImage">GetNextImage</a> • <a href="#GetNextImageAttribute">GetNextImageAttribute</a> • <a href="#GetNumberScenes">GetNumberScenes</a> • <a href="#GetOnePixel">GetOnePixel</a> • <a href="#GetPixels">GetPixels</a> • <a href="#GetPreviousImage">GetPreviousImage</a> • <a href="#HSLTransform">HSLTransform</a> • <a href="#IdentityAffine">IdentityAffine</a> • <a href="#InitializeMagick">InitializeMagick</a> • <a href="#InterpolatePixelColor">InterpolatePixelColor</a> • <a href="#InterpretImageAttributes">InterpretImageAttributes</a> • <a href="#LevelImageColor">LevelImageColor</a> • <a href="#LiberateMemory">LiberateMemory</a> • <a href="#LiberateSemaphoreInfo">LiberateSemaphoreInfo</a> • <a href="#MagickIncarnate">MagickIncarnate</a> • <a href="#MagickMonitor">MagickMonitor</a> • <a href="#MapImage">MapImage</a> • <a href="#MapImages">MapImages</a> • <a href="#MatteFloodfill">MatteFloodfill</a> • <a href="#MaximumImages">MaximumImages</a> • <a href="#MinimumImages">MinimumImages</a> • <a href="#MosaicImages">MosaicImages</a> • <a href="#OpaqueImage">OpaqueImage</a> • <a href="#OpenCacheView">OpenCacheView</a> • <a href="#PaintFloodfill">PaintFloodfill</a> • <a href="#PaintOpaqueImage">PaintOpaqueImage</a> • <a href="#PaintTransparentImage">PaintTransparentImage</a> • <a href="#ParseSizeGeometry">ParseSizeGeometry</a> • <a href="#PopImageList">PopImageList</a> • <a href="#PopImagePixels">PopImagePixels</a> • <a href="#PostscriptGeometry">PostscriptGeometry</a> • <a href="#PushImageList">PushImageList</a> • <a href="#PushImagePixels">PushImagePixels</a> • <a href="#QuantizationError">QuantizationError</a> • <a href="#RandomChannelThresholdImage">RandomChannelThresholdImage</a> • <a href="#ReacquireMemory">ReacquireMemory</a> • <a href="#RecolorImage">RecolorImage</a> • <a href="#ResetImageAttributeIterator">ResetImageAttributeIterator</a> • <a href="#SetCacheViewPixels">SetCacheViewPixels</a> • <a href="#SetExceptionInfo">SetExceptionInfo</a> • <a href="#SetImage">SetImage</a> • <a href="#SetImageAttribute">SetImageAttribute</a> • <a href="#SetImageList">SetImageList</a> • <a href="#SetImagePixels">SetImagePixels</a> • <a href="#SetMagickRegistry">SetMagickRegistry</a> • <a href="#SetMonitorHandler">SetMonitorHandler</a> • <a href="#ShiftImageList">ShiftImageList</a> • <a href="#SpliceImageList">SpliceImageList</a> • <a href="#Strip">Strip</a> • <a href="#SyncCacheView">SyncCacheView</a> • <a href="#SyncCacheViewPixels">SyncCacheViewPixels</a> • <a href="#SyncImagePixels">SyncImagePixels</a> • <a href="#TemporaryFilename">TemporaryFilename</a> • <a href="#ThresholdImage">ThresholdImage</a> • <a href="#ThresholdImageChannel">ThresholdImageChannel</a> • <a href="#TransformHSL">TransformHSL</a> • <a href="#TranslateText">TranslateText</a> • <a href="#TransparentImage">TransparentImage</a> • <a href="#UnshiftImageList">UnshiftImageList</a> • <a href="#ZoomImage">ZoomImage</a>]</p>
172 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
173 _8c.html" target="source" name="AcquireCacheViewIndexes">AcquireCacheViewIndexes</a></h2>
174 <div class="doc-section">
176 <p>AcquireCacheViewIndexes() returns the indexes associated with the specified view.</p></ol>
178 <p>Deprecated, replace with:</p>
181 GetCacheViewVirtualIndexQueue(cache_view);
184 <p>The format of the AcquireCacheViewIndexes method is:</p>
187 const IndexPacket *AcquireCacheViewIndexes(const CacheView *cache_view)
190 <p>A description of each parameter follows:</p></ol>
193 <ol><p>the cache view.</p></ol>
196 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
197 _8c.html" target="source" name="AcquireCacheViewPixels">AcquireCacheViewPixels</a></h2>
198 <div class="doc-section">
200 <p>AcquireCacheViewPixels() gets pixels from the in-memory or disk pixel cache as defined by the geometry parameters. A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.</p></ol>
202 <p>Deprecated, replace with:</p>
205 GetCacheViewVirtualPixels(cache_view,x,y,columns,rows,exception);
208 <p>The format of the AcquireCacheViewPixels method is:</p>
211 const PixelPacket *AcquireCacheViewPixels(const CacheView *cache_view,
212 const ssize_t x,const ssize_t y,const size_t columns,
213 const size_t rows,ExceptionInfo *exception)
216 <p>A description of each parameter follows:</p></ol>
219 <ol><p>the cache view.</p></ol>
221 <h5>x,y,columns,rows</h5>
222 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
225 <ol><p>return any errors or warnings in this structure.</p></ol>
228 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
229 _8c.html" target="source" name="AcquireImagePixels">AcquireImagePixels</a></h2>
230 <div class="doc-section">
232 <p>AcquireImagePixels() 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>
234 <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>
236 <p>If you plan to modify the pixels, use GetAuthenticPixels() instead.</p></ol>
238 <p>Note, the AcquireImagePixels() and GetAuthenticPixels() methods are not thread-safe. In a threaded environment, use GetCacheViewVirtualPixels() or GetCacheViewAuthenticPixels() instead.</p></ol>
240 <p>Deprecated, replace with:</p>
243 GetVirtualPixels(image,x,y,columns,rows,exception);
246 <p>The format of the AcquireImagePixels() method is:</p>
249 const PixelPacket *AcquireImagePixels(const Image *image,const ssize_t x,
250 const ssize_t y,const size_t columns,const size_t rows,
251 ExceptionInfo *exception)
254 <p>A description of each parameter follows:</p></ol>
257 <ol><p>the image.</p></ol>
259 <h5>x,y,columns,rows</h5>
260 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
263 <ol><p>return any errors or warnings in this structure.</p></ol>
266 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
267 _8c.html" target="source" name="AcquireIndexes">AcquireIndexes</a></h2>
268 <div class="doc-section">
270 <p>AcquireIndexes() returns the 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>
272 <p>Deprecated, replace with:</p>
275 GetVirtualIndexQueue(image);
278 <p>The format of the AcquireIndexes() method is:</p>
281 const IndexPacket *AcquireIndexes(const Image *image)
284 <p>A description of each parameter follows:</p></ol>
287 <ol><p>AcquireIndexes() returns the indexes associated with the last call to QueueAuthenticPixels() or GetVirtualPixels().</p></ol>
290 <ol><p>the image.</p></ol>
293 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
294 _8c.html" target="source" name="AcquireMemory">AcquireMemory</a></h2>
295 <div class="doc-section">
297 <p>AcquireMemory() returns a pointer to a block of memory at least size bytes suitably aligned for any use.</p></ol>
299 <p>The format of the AcquireMemory method is:</p>
302 void *AcquireMemory(const size_t size)
305 <p>A description of each parameter follows:</p></ol>
308 <ol><p>the size of the memory in bytes to allocate.</p></ol>
311 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
312 _8c.html" target="source" name="AcquireOneCacheViewPixel">AcquireOneCacheViewPixel</a></h2>
313 <div class="doc-section">
315 <p>AcquireOneCacheViewPixel() 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 GetOneCacheViewAuthenticPixel() instead.</p></ol>
317 <p>Deprecated, replace with:</p>
320 GetOneCacheViewVirtualPixel(cache_view,x,y,pixel,exception);
323 <p>The format of the AcquireOneCacheViewPixel method is:</p>
326 MagickBooleanType AcquireOneCacheViewPixel(const CacheView *cache_view,
327 const ssize_t x,const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
330 <p>A description of each parameter follows:</p></ol>
333 <ol><p>the cache view.</p></ol>
336 <ol><p>These values define the offset of the pixel.</p></ol>
339 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
342 <ol><p>return any errors or warnings in this structure.</p></ol>
345 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
346 _8c.html" target="source" name="AcquireOneCacheViewVirtualPixel">AcquireOneCacheViewVirtualPixel</a></h2>
347 <div class="doc-section">
349 <p>AcquireOneCacheViewVirtualPixel() 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 GetOneCacheViewAuthenticPixel() instead.</p></ol>
351 <p>Deprecated, replace with:</p>
354 GetOneCacheViewVirtualMethodPixel(cache_view,virtual_pixel_method,
355 x,y,pixel,exception);
358 <p>The format of the AcquireOneCacheViewPixel method is:</p>
361 MagickBooleanType AcquireOneCacheViewVirtualPixel(
362 const CacheView *cache_view,
363 const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
364 const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
367 <p>A description of each parameter follows:</p></ol>
370 <ol><p>the cache view.</p></ol>
372 <h5>virtual_pixel_method</h5>
373 <ol><p>the virtual pixel method.</p></ol>
376 <ol><p>These values define the offset of the pixel.</p></ol>
379 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
382 <ol><p>return any errors or warnings in this structure.</p></ol>
385 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
386 _8c.html" target="source" name="AcquireOneMagickPixel">AcquireOneMagickPixel</a></h2>
387 <div class="doc-section">
389 <p>AcquireOneMagickPixel() 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 GetOnePixel() instead.</p></ol>
391 <p>Deprecated, replace with:</p>
394 MagickPixelPacket pixel;
395 GetOneVirtualMagickPixel(image,x,y,&pixel,exception);
398 <p>The format of the AcquireOneMagickPixel() method is:</p>
401 MagickPixelPacket AcquireOneMagickPixel(const Image image,const ssize_t x,
402 const ssize_t y,ExceptionInfo exception)
405 <p>A description of each parameter follows:</p></ol>
408 <ol><p>the image.</p></ol>
411 <ol><p>These values define the location of the pixel to return.</p></ol>
414 <ol><p>return any errors or warnings in this structure.</p></ol>
417 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
418 _8c.html" target="source" name="AcquireOnePixel">AcquireOnePixel</a></h2>
419 <div class="doc-section">
421 <p>AcquireOnePixel() 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 GetOnePixel() instead.</p></ol>
423 <p>Deprecated, replace with:</p>
427 GetOneVirtualPixel(image,x,y,&pixel,exception);
430 <p>The format of the AcquireOnePixel() method is:</p>
433 PixelPacket AcquireOnePixel(const Image image,const ssize_t x,
434 const ssize_t y,ExceptionInfo exception)
437 <p>A description of each parameter follows:</p></ol>
440 <ol><p>the image.</p></ol>
443 <ol><p>These values define the location of the pixel to return.</p></ol>
446 <ol><p>return any errors or warnings in this structure.</p></ol>
449 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
450 _8c.html" target="source" name="AcquireOneVirtualPixel">AcquireOneVirtualPixel</a></h2>
451 <div class="doc-section">
453 <p>AcquireOneVirtualPixel() 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 GetOnePixel() instead.</p></ol>
455 <p>Deprecated, replace with:</p>
459 GetOneVirtualMethodPixel(image,virtual_pixel_method,x,y,&pixel,exception);
462 <p>The format of the AcquireOneVirtualPixel() method is:</p>
465 PixelPacket AcquireOneVirtualPixel(const Image image,
466 const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
467 const ssize_t y,ExceptionInfo exception)
470 <p>A description of each parameter follows:</p></ol>
472 <h5>virtual_pixel_method</h5>
473 <ol><p>the virtual pixel method.</p></ol>
476 <ol><p>the image.</p></ol>
479 <ol><p>These values define the location of the pixel to return.</p></ol>
482 <ol><p>return any errors or warnings in this structure.</p></ol>
485 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
486 _8c.html" target="source" name="AcquirePixels">AcquirePixels</a></h2>
487 <div class="doc-section">
489 <p>AcquirePixels() returns the pixels associated with the last call to QueueAuthenticPixels() or GetVirtualPixels().</p></ol>
491 <p>Deprecated, replace with:</p>
494 GetVirtualPixelQueue(image);
497 <p>The format of the AcquirePixels() method is:</p>
500 const PixelPacket *AcquirePixels(const Image image)
503 <p>A description of each parameter follows:</p></ol>
506 <ol><p>the image.</p></ol>
509 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
510 _8c.html" target="source" name="AffinityImage">AffinityImage</a></h2>
511 <div class="doc-section">
513 <p>AffinityImage() replaces the colors of an image with the closest color from a reference image.</p></ol>
515 <p>Deprecated, replace with:</p>
518 RemapImage(quantize_info,image,affinity_image);
521 <p>The format of the AffinityImage method is:</p>
524 MagickBooleanType AffinityImage(const QuantizeInfo *quantize_info,
525 Image *image,const Image *affinity_image)
528 <p>A description of each parameter follows:</p></ol>
530 <h5>quantize_info</h5>
531 <ol><p>Specifies a pointer to an QuantizeInfo structure.</p></ol>
534 <ol><p>the image.</p></ol>
536 <h5>affinity_image</h5>
537 <ol><p>the reference image.</p></ol>
540 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
541 _8c.html" target="source" name="AffinityImages">AffinityImages</a></h2>
542 <div class="doc-section">
544 <p>AffinityImages() replaces the colors of a sequence of images with the closest color from a reference image.</p></ol>
546 <p>Deprecated, replace with:</p>
549 RemapImages(quantize_info,images,affinity_image);
552 <p>The format of the AffinityImage method is:</p>
555 MagickBooleanType AffinityImages(const QuantizeInfo *quantize_info,
556 Image *images,Image *affinity_image)
559 <p>A description of each parameter follows:</p></ol>
561 <h5>quantize_info</h5>
562 <ol><p>Specifies a pointer to an QuantizeInfo structure.</p></ol>
565 <ol><p>the image sequence.</p></ol>
567 <h5>affinity_image</h5>
568 <ol><p>the reference image.</p></ol>
571 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
572 _8c.html" target="source" name="AllocateImage">AllocateImage</a></h2>
573 <div class="doc-section">
575 <p>AllocateImage() returns a pointer to an image structure initialized to default values.</p></ol>
577 <p>Deprecated, replace with:</p>
580 AcquireImage(image_info);
583 <p>The format of the AllocateImage method is:</p>
586 Image *AllocateImage(const ImageInfo *image_info)
589 <p>A description of each parameter follows:</p></ol>
592 <ol><p>Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others.</p></ol>
595 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
596 _8c.html" target="source" name="AllocateImageColormap">AllocateImageColormap</a></h2>
597 <div class="doc-section">
599 <p>AllocateImageColormap() allocates an image colormap and initializes it to a linear gray colorspace. If the image already has a colormap, it is replaced. AllocateImageColormap() returns MagickTrue if successful, otherwise MagickFalse if there is not enough memory.</p></ol>
601 <p>Deprecated, replace with:</p>
604 AcquireImageColormap(image,colors);
607 <p>The format of the AllocateImageColormap method is:</p>
610 MagickBooleanType AllocateImageColormap(Image *image,
614 <p>A description of each parameter follows:</p></ol>
617 <ol><p>the image.</p></ol>
620 <ol><p>the number of colors in the image colormap.</p></ol>
623 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
624 _8c.html" target="source" name="AllocateNextImage">AllocateNextImage</a></h2>
625 <div class="doc-section">
627 <p>AllocateNextImage() initializes the next image in a sequence to default values. The next member of image points to the newly allocated image. If there is a memory shortage, next is assigned NULL.</p></ol>
629 <p>Deprecated, replace with:</p>
632 AcquireNextImage(image_info,image);
635 <p>The format of the AllocateNextImage method is:</p>
638 void AllocateNextImage(const ImageInfo *image_info,Image *image)
641 <p>A description of each parameter follows:</p></ol>
644 <ol><p>Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others.</p></ol>
647 <ol><p>the image.</p></ol>
650 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
651 _8c.html" target="source" name="AllocateString">AllocateString</a></h2>
652 <div class="doc-section">
654 <p>AllocateString() allocates memory for a string and copies the source string to that memory location (and returns it).</p></ol>
656 <p>The format of the AllocateString method is:</p>
659 char *AllocateString(const char *source)
662 <p>A description of each parameter follows:</p></ol>
665 <ol><p>A character string.</p></ol>
668 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
669 _8c.html" target="source" name="AverageImages">AverageImages</a></h2>
670 <div class="doc-section">
672 <p>AverageImages() takes a set of images and averages them together. Each image in the set must have the same width and height. AverageImages() returns a single image with each corresponding pixel component of each image averaged. On failure, a NULL image is returned and exception describes the reason for the failure.</p></ol>
674 <p>Deprecated, replace with:</p>
677 EvaluateImages(images,MeanEvaluateOperator,exception);
680 <p>The format of the AverageImages method is:</p>
683 Image *AverageImages(Image *images,ExceptionInfo *exception)
686 <p>A description of each parameter follows:</p></ol>
689 <ol><p>the image sequence.</p></ol>
692 <ol><p>return any errors or warnings in this structure.</p></ol>
695 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
696 _8c.html" target="source" name="ChannelThresholdImage">ChannelThresholdImage</a></h2>
697 <div class="doc-section">
699 <p>ChannelThresholdImage() changes the value of individual pixels based on the intensity of each pixel channel. The result is a high-contrast image.</p></ol>
701 <p>The format of the ChannelThresholdImage method is:</p>
704 unsigned int ChannelThresholdImage(Image *image,const char *level)
707 <p>A description of each parameter follows:</p></ol>
710 <ol><p>the image.</p></ol>
713 <ol><p>define the threshold values.</p></ol>
716 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
717 _8c.html" target="source" name="ClipPathImage">ClipPathImage</a></h2>
718 <div class="doc-section">
720 <p>ClipPathImage() sets the image clip mask based any clipping path information if it exists.</p></ol>
722 <p>Deprecated, replace with:</p>
725 ClipImagePath(image,pathname,inside);
728 <p>The format of the ClipImage method is:</p>
731 MagickBooleanType ClipPathImage(Image *image,const char *pathname,
732 const MagickBooleanType inside)
735 <p>A description of each parameter follows:</p></ol>
738 <ol><p>the image.</p></ol>
741 <ol><p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p></ol>
744 <ol><p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p></ol>
747 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
748 _8c.html" target="source" name="CloneImageAttributes">CloneImageAttributes</a></h2>
749 <div class="doc-section">
751 <p>CloneImageAttributes() clones one or more image attributes.</p></ol>
753 <p>Deprecated, replace with:</p>
756 CloneImageProperties(image,clone_image);
759 <p>The format of the CloneImageAttributes method is:</p>
762 MagickBooleanType CloneImageAttributes(Image *image,
763 const Image *clone_image)
766 <p>A description of each parameter follows:</p></ol>
769 <ol><p>the image.</p></ol>
772 <ol><p>the clone image.</p></ol>
775 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
776 _8c.html" target="source" name="CloneMemory">CloneMemory</a></h2>
777 <div class="doc-section">
779 <p>CloneMemory() copies size bytes from memory area source to the destination. Copying between objects that overlap will take place correctly. It returns destination.</p></ol>
781 <p>The format of the CloneMemory method is:</p>
784 void *CloneMemory(void *destination,const void *source,
788 <p>A description of each parameter follows:</p></ol>
791 <ol><p>the destination.</p></ol>
794 <ol><p>the source.</p></ol>
797 <ol><p>the size of the memory in bytes to allocate.</p></ol>
800 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
801 _8c.html" target="source" name="CloseCacheView">CloseCacheView</a></h2>
802 <div class="doc-section">
804 <p>CloseCacheView() closes the specified view returned by a previous call to OpenCacheView().</p></ol>
806 <p>Deprecated, replace with:</p>
809 DestroyCacheView(view_info);
812 <p>The format of the CloseCacheView method is:</p>
815 CacheView *CloseCacheView(CacheView *view_info)
818 <p>A description of each parameter follows:</p></ol>
821 <ol><p>the address of a structure of type CacheView.</p></ol>
824 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
825 _8c.html" target="source" name="ColorFloodfill">ColorFloodfill</a></h2>
826 <div class="doc-section">
828 <p>ColorFloodfill() changes the color value of any pixel that matches target and is an immediate neighbor. If the method FillToBorderMethod is specified, the color value is changed for any neighbor pixel that does not match the bordercolor member of image.</p></ol>
830 <p>By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.</p></ol>
832 <p>The format of the ColorFloodfillImage method is:</p>
835 MagickBooleanType ColorFloodfillImage(Image *image,
836 const DrawInfo *draw_info,const PixelPacket target,
837 const ssize_t x_offset,const ssize_t y_offset,const PaintMethod method)
840 <p>A description of each parameter follows:</p></ol>
843 <ol><p>the image.</p></ol>
846 <ol><p>the draw info.</p></ol>
849 <ol><p>the RGB value of the target color.</p></ol>
852 <ol><p>the starting location of the operation.</p></ol>
855 <ol><p>Choose either FloodfillMethod or FillToBorderMethod.</p></ol>
858 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
859 _8c.html" target="source" name="DeleteImageAttribute">DeleteImageAttribute</a></h2>
860 <div class="doc-section">
862 <p>DeleteImageAttribute() deletes an attribute from the image.</p></ol>
864 <p>Deprecated, replace with:</p>
867 DeleteImageProperty(image,key);
870 <p>The format of the DeleteImageAttribute method is:</p>
873 MagickBooleanType DeleteImageAttribute(Image *image,const char *key)
876 <p>A description of each parameter follows:</p></ol>
879 <ol><p>the image info.</p></ol>
882 <ol><p>the image key.</p></ol>
885 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
886 _8c.html" target="source" name="DeleteImageList">DeleteImageList</a></h2>
887 <div class="doc-section">
889 <p>DeleteImageList() deletes an image at the specified position in the list.</p></ol>
891 <p>The format of the DeleteImageList method is:</p>
894 unsigned int DeleteImageList(Image *images,const ssize_t offset)
897 <p>A description of each parameter follows:</p></ol>
900 <ol><p>the image list.</p></ol>
903 <ol><p>the position within the list.</p></ol>
906 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
907 _8c.html" target="source" name="DeleteMagickRegistry">DeleteMagickRegistry</a></h2>
908 <div class="doc-section">
910 <p>DeleteMagickRegistry() deletes an entry in the registry as defined by the id. It returns MagickTrue if the entry is deleted otherwise MagickFalse if no entry is found in the registry that matches the id.</p></ol>
912 <p>Deprecated, replace with:</p>
915 char key[MaxTextExtent];
916 FormatMagickString(key,MaxTextExtent,"ld\n",id);
917 DeleteImageRegistry(key);
920 <p>The format of the DeleteMagickRegistry method is:</p>
923 MagickBooleanType DeleteMagickRegistry(const ssize_t id)
926 <p>A description of each parameter follows:</p></ol>
929 <ol><p>the registry id.</p></ol>
932 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
933 _8c.html" target="source" name="DescribeImage">DescribeImage</a></h2>
934 <div class="doc-section">
936 <p>DescribeImage() describes an image by printing its attributes to the file. Attributes include the image width, height, size, and others.</p></ol>
938 <p>Deprecated, replace with:</p>
941 IdentifyImage(image,file,verbose);
944 <p>The format of the DescribeImage method is:</p>
947 MagickBooleanType DescribeImage(Image *image,FILE *file,
948 const MagickBooleanType verbose)
951 <p>A description of each parameter follows:</p></ol>
954 <ol><p>the image.</p></ol>
957 <ol><p>the file, typically stdout.</p></ol>
960 <ol><p>A value other than zero prints more detailed information about the image.</p></ol>
963 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
964 _8c.html" target="source" name="DestroyImageAttributes">DestroyImageAttributes</a></h2>
965 <div class="doc-section">
967 <p>DestroyImageAttributes() deallocates memory associated with the image attribute list.</p></ol>
969 <p>The format of the DestroyImageAttributes method is:</p>
972 DestroyImageAttributes(Image *image)
975 <p>A description of each parameter follows:</p></ol>
978 <ol><p>the image.</p></ol>
981 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
982 _8c.html" target="source" name="DestroyImages">DestroyImages</a></h2>
983 <div class="doc-section">
985 <p>DestroyImages() destroys an image list.</p></ol>
987 <p>Deprecated, replace with:</p>
990 DestroyImageList(image);
993 <p>The format of the DestroyImages method is:</p>
996 void DestroyImages(Image *image)
999 <p>A description of each parameter follows:</p></ol>
1002 <ol><p>the image sequence.</p></ol>
1005 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1006 _8c.html" target="source" name="DestroyMagick">DestroyMagick</a></h2>
1007 <div class="doc-section">
1009 <p>DestroyMagick() destroys the ImageMagick environment.</p></ol>
1011 <p>Deprecated, replace with:</p>
1014 MagickCoreTerminus();
1017 <p>The format of the DestroyMagick function is:</p>
1024 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1025 _8c.html" target="source" name="DispatchImage">DispatchImage</a></h2>
1026 <div class="doc-section">
1028 <p>DispatchImage() extracts pixel data from an image and returns it to you. The method returns MagickFalse on success otherwise MagickTrue if an error is encountered. The data is returned as char, short int, int, ssize_t, float, or double in the order specified by map.</p></ol>
1030 <p>Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:</p>
1033 DispatchImage(image,0,0,640,1,"RGB",CharPixel,pixels,exception);
1036 <p>Deprecated, replace with:</p>
1039 ExportImagePixels(image,x_offset,y_offset,columns,rows,map,type,pixels,
1043 <p>The format of the DispatchImage method is:</p>
1046 unsigned int DispatchImage(const Image *image,const ssize_t x_offset,
1047 const ssize_t y_offset,const size_t columns,
1048 const size_t rows,const char *map,const StorageType type,
1049 void *pixels,ExceptionInfo *exception)
1052 <p>A description of each parameter follows:</p></ol>
1055 <ol><p>the image.</p></ol>
1057 <h5>x_offset, y_offset, columns, rows</h5>
1058 <ol><p>These values define the perimeter of a region of pixels you want to extract.</p></ol>
1061 <ol><p>This string reflects the expected ordering of the pixel array. It can be any combination or order of R = red, G = green, B = blue, A = alpha, C = cyan, Y = yellow, M = magenta, K = black, or I = intensity (for grayscale).</p></ol>
1064 <ol><p>Define the data type of the pixels. Float and double types are normalized to [0..1] otherwise [0..QuantumRange]. Choose from these types: CharPixel, ShortPixel, IntegerPixel, LongPixel, FloatPixel, or DoublePixel.</p></ol>
1067 <ol><p>This array of values contain the pixel components as defined by map and type. You must preallocate this array where the expected length varies depending on the values of width, height, map, and type.</p></ol>
1070 <ol><p>return any errors or warnings in this structure.</p></ol>
1073 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1074 _8c.html" target="source" name="ExtractSubimageFromImageImage">ExtractSubimageFromImageImage</a></h2>
1075 <div class="doc-section">
1077 <p>ExtractSubimageFromImageImage() extracts a region of the image that most closely resembles the reference.</p></ol>
1079 <p>The format of the ExtractSubimageFromImageImage method is:</p>
1082 Image *ExtractSubimageFromImage(const Image *image,
1083 const Image *reference,ExceptionInfo *exception)
1086 <p>A description of each parameter follows:</p></ol>
1089 <ol><p>the image.</p></ol>
1092 <ol><p>find an area of the image that closely resembles this image.</p></ol>
1095 <ol><p>return any errors or warnings in this structure.</p></ol>
1098 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1099 _8c.html" target="source" name="FlattenImages">FlattenImages</a></h2>
1100 <div class="doc-section">
1102 <p>FlattenImages() Obsolete Function: Use MergeImageLayers() instead.</p></ol>
1104 <p>Deprecated, replace with:</p>
1107 MergeImageLayers(image,FlattenLayer,exception);
1110 <p>The format of the FlattenImage method is:</p>
1113 Image *FlattenImage(Image *image,ExceptionInfo *exception)
1116 <p>A description of each parameter follows:</p></ol>
1119 <ol><p>the image sequence.</p></ol>
1122 <ol><p>return any errors or warnings in this structure.</p></ol>
1125 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1126 _8c.html" target="source" name="FormatImageAttribute">FormatImageAttribute</a></h2>
1127 <div class="doc-section">
1129 <p>FormatImageAttribute() permits formatted key/value pairs to be saved as an image attribute.</p></ol>
1131 <p>The format of the FormatImageAttribute method is:</p>
1134 MagickBooleanType FormatImageAttribute(Image *image,const char *key,
1135 const char *format,...)
1138 <p>A description of each parameter follows.</p></ol>
1141 <ol><p>The image.</p></ol>
1144 <ol><p>The attribute key.</p></ol>
1147 <ol><p>A string describing the format to use to write the remaining arguments.</p></ol>
1150 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1151 _8c.html" target="source" name="FormatString">FormatString</a></h2>
1152 <div class="doc-section">
1154 <p>FormatString() prints formatted output of a variable argument list.</p></ol>
1156 <p>The format of the FormatString method is:</p>
1159 void FormatString(char *string,const char *format,...)
1162 <p>A description of each parameter follows.</p></ol>
1165 <ol><p>Method FormatString returns the formatted string in this character buffer.</p></ol>
1168 <ol><p>A string describing the format to use to write the remaining arguments.</p></ol>
1171 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1172 _8c.html" target="source" name="GetConfigureBlob">GetConfigureBlob</a></h2>
1173 <div class="doc-section">
1175 <p>GetConfigureBlob() returns the specified configure file as a blob.</p></ol>
1177 <p>The format of the GetConfigureBlob method is:</p>
1180 void *GetConfigureBlob(const char *filename,ExceptionInfo *exception)
1183 <p>A description of each parameter follows:</p></ol>
1186 <ol><p>the configure file name.</p></ol>
1189 <ol><p>return the full path information of the configure file.</p></ol>
1192 <ol><p>This pointer to a size_t integer sets the initial length of the blob. On return, it reflects the actual length of the blob.</p></ol>
1195 <ol><p>return any errors or warnings in this structure.</p></ol>
1198 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1199 _8c.html" target="source" name="GetCacheView">GetCacheView</a></h2>
1200 <div class="doc-section">
1202 <p>GetCacheView() gets pixels from the in-memory or disk pixel cache as defined by the geometry parameters. A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.</p></ol>
1204 <p>Deprecated, replace with:</p>
1207 GetCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
1208 GetCacheViewException(cache_view));
1211 <p>The format of the GetCacheView method is:</p>
1214 PixelPacket *GetCacheView(CacheView *cache_view,const ssize_t x,
1215 const ssize_t y,const size_t columns,const size_t rows)
1218 <p>A description of each parameter follows:</p></ol>
1221 <ol><p>the address of a structure of type CacheView.</p></ol>
1223 <h5>x,y,columns,rows</h5>
1224 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
1227 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1228 _8c.html" target="source" name="GetCacheViewIndexes">GetCacheViewIndexes</a></h2>
1229 <div class="doc-section">
1231 <p>GetCacheViewIndexes() returns the indexes associated with the specified view.</p></ol>
1233 <p>Deprecated, replace with:</p>
1236 GetCacheViewAuthenticIndexQueue(cache_view);
1239 <p>The format of the GetCacheViewIndexes method is:</p>
1242 IndexPacket *GetCacheViewIndexes(CacheView *cache_view)
1245 <p>A description of each parameter follows:</p></ol>
1248 <ol><p>the cache view.</p></ol>
1251 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1252 _8c.html" target="source" name="GetCacheViewPixels">GetCacheViewPixels</a></h2>
1253 <div class="doc-section">
1255 <p>GetCacheViewPixels() gets pixels from the in-memory or disk pixel cache as defined by the geometry parameters. A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.</p></ol>
1257 <p>Deprecated, replace with:</p>
1260 GetCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
1261 GetCacheViewException(cache_view));
1264 <p>The format of the GetCacheViewPixels method is:</p>
1267 PixelPacket *GetCacheViewPixels(CacheView *cache_view,const ssize_t x,
1268 const ssize_t y,const size_t columns,const size_t rows)
1271 <p>A description of each parameter follows:</p></ol>
1274 <ol><p>the cache view.</p></ol>
1276 <h5>x,y,columns,rows</h5>
1277 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
1280 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1281 _8c.html" target="source" name="GetImageAttribute">GetImageAttribute</a></h2>
1282 <div class="doc-section">
1284 <p>GetImageAttribute() searches the list of image attributes and returns a pointer to the attribute if it exists otherwise NULL.</p></ol>
1286 <p>The format of the GetImageAttribute method is:</p>
1289 const ImageAttribute *GetImageAttribute(const Image *image,
1293 <p>A description of each parameter follows:</p></ol>
1296 <ol><p>the image.</p></ol>
1299 <ol><p>These character strings are the name of an image attribute to return.</p></ol>
1302 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1303 _8c.html" target="source" name="GetImageClippingPathAttribute">GetImageClippingPathAttribute</a></h2>
1304 <div class="doc-section">
1306 <p>GetImageClippingPathAttribute() searches the list of image attributes and returns a pointer to a clipping path if it exists otherwise NULL.</p></ol>
1308 <p>Deprecated, replace with:</p>
1311 GetImageAttribute(image,"8BIM:1999,2998");
1314 <p>The format of the GetImageClippingPathAttribute method is:</p>
1317 const ImageAttribute *GetImageClippingPathAttribute(Image *image)
1320 <p>A description of each parameter follows:</p></ol>
1323 <ol><p>Method GetImageClippingPathAttribute returns the clipping path if it exists otherwise NULL.</p></ol>
1326 <ol><p>the image.</p></ol>
1329 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1330 _8c.html" target="source" name="GetImageFromMagickRegistry">GetImageFromMagickRegistry</a></h2>
1331 <div class="doc-section">
1333 <p>GetImageFromMagickRegistry() gets an image from the registry as defined by its name. If the image is not found, a NULL image is returned.</p></ol>
1335 <p>Deprecated, replace with:</p>
1338 GetImageRegistry(ImageRegistryType,name,exception);
1341 <p>The format of the GetImageFromMagickRegistry method is:</p>
1344 Image *GetImageFromMagickRegistry(const char *name,ssize_t *id,
1345 ExceptionInfo *exception)
1348 <p>A description of each parameter follows:</p></ol>
1351 <ol><p>the name of the image to retrieve from the registry.</p></ol>
1354 <ol><p>the registry id.</p></ol>
1357 <ol><p>return any errors or warnings in this structure.</p></ol>
1360 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1361 _8c.html" target="source" name="GetMagickRegistry">GetMagickRegistry</a></h2>
1362 <div class="doc-section">
1364 <p>GetMagickRegistry() gets a blob from the registry as defined by the id. If the blob that matches the id is not found, NULL is returned.</p></ol>
1366 <p>The format of the GetMagickRegistry method is:</p>
1369 const void *GetMagickRegistry(const ssize_t id,RegistryType *type,
1370 size_t *length,ExceptionInfo *exception)
1373 <p>A description of each parameter follows:</p></ol>
1376 <ol><p>the registry id.</p></ol>
1379 <ol><p>the registry type.</p></ol>
1382 <ol><p>the blob length in number of bytes.</p></ol>
1385 <ol><p>return any errors or warnings in this structure.</p></ol>
1388 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1389 _8c.html" target="source" name="GetImageGeometry">GetImageGeometry</a></h2>
1390 <div class="doc-section">
1392 <p>GetImageGeometry() returns a region as defined by the geometry string with respect to the image and its gravity.</p></ol>
1394 <p>Deprecated, replace with:</p>
1397 if (size_to_fit != MagickFalse)
1398 ParseRegionGeometry(image,geometry,region_info,&image->exception); else
1399 ParsePageGeometry(image,geometry,region_info,&image->exception);
1402 <p>The format of the GetImageGeometry method is:</p>
1405 int GetImageGeometry(Image *image,const char *geometry,
1406 const unsigned int size_to_fit,RectangeInfo *region_info)
1409 <p>A description of each parameter follows:</p></ol>
1412 <ol><p>Method GetImageGeometry returns a bitmask that indicates which of the four values were located in the geometry string.</p></ol>
1415 <ol><p>The geometry (e.g. 100x100+10+10).</p></ol>
1417 <h5>size_to_fit</h5>
1418 <ol><p>A value other than 0 means to scale the region so it fits within the specified width and height.</p></ol>
1420 <h5>region_info</h5>
1421 <ol><p>the region as defined by the geometry string with respect to the image and its gravity.</p></ol>
1424 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1425 _8c.html" target="source" name="GetImageList">GetImageList</a></h2>
1426 <div class="doc-section">
1428 <p>GetImageList() returns an image at the specified position in the list.</p></ol>
1430 <p>Deprecated, replace with:</p>
1433 CloneImage(GetImageFromList(images,(ssize_t) offset),0,0,MagickTrue,
1437 <p>The format of the GetImageList method is:</p>
1440 Image *GetImageList(const Image *images,const ssize_t offset,
1441 ExceptionInfo *exception)
1444 <p>A description of each parameter follows:</p></ol>
1447 <ol><p>the image list.</p></ol>
1450 <ol><p>the position within the list.</p></ol>
1453 <ol><p>return any errors or warnings in this structure.</p></ol>
1456 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1457 _8c.html" target="source" name="GetImageListIndex">GetImageListIndex</a></h2>
1458 <div class="doc-section">
1460 <p>GetImageListIndex() returns the position in the list of the specified image.</p></ol>
1462 <p>Deprecated, replace with:</p>
1465 GetImageIndexInList(images);
1468 <p>The format of the GetImageListIndex method is:</p>
1471 ssize_t GetImageListIndex(const Image *images)
1474 <p>A description of each parameter follows:</p></ol>
1477 <ol><p>the image list.</p></ol>
1480 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1481 _8c.html" target="source" name="GetImageListSize">GetImageListSize</a></h2>
1482 <div class="doc-section">
1484 <p>GetImageListSize() returns the number of images in the list.</p></ol>
1486 <p>Deprecated, replace with:</p>
1489 GetImageListLength(images);
1492 <p>The format of the GetImageListSize method is:</p>
1495 size_t GetImageListSize(const Image *images)
1498 <p>A description of each parameter follows:</p></ol>
1501 <ol><p>the image list.</p></ol>
1504 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1505 _8c.html" target="source" name="GetImagePixels">GetImagePixels</a></h2>
1506 <div class="doc-section">
1508 <p>GetImagePixels() 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>
1510 <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>
1512 <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 GetImagePixels() 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>
1514 <p>Deprecated, replace with:</p>
1517 GetAuthenticPixels(image,x,y,columns,rows,&image->exception);
1520 <p>The format of the GetImagePixels() method is:</p>
1523 PixelPacket *GetImagePixels(Image *image,const ssize_t x,const ssize_t y,
1524 const size_t columns,const size_t rows)
1527 <p>A description of each parameter follows:</p></ol>
1530 <ol><p>the image.</p></ol>
1532 <h5>x,y,columns,rows</h5>
1533 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
1536 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1537 _8c.html" target="source" name="GetIndexes">GetIndexes</a></h2>
1538 <div class="doc-section">
1540 <p>GetIndexes() returns the 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>
1542 <p>Deprecated, replace with:</p>
1545 GetAuthenticIndexQueue(image);
1548 <p>The format of the GetIndexes() method is:</p>
1551 IndexPacket *GetIndexes(const Image *image)
1554 <p>A description of each parameter follows:</p></ol>
1557 <ol><p>GetIndexes() returns the indexes associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p></ol>
1560 <ol><p>the image.</p></ol>
1563 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1564 _8c.html" target="source" name="GetNextImage">GetNextImage</a></h2>
1565 <div class="doc-section">
1567 <p>GetNextImage() returns the next image in a list.</p></ol>
1569 <p>Deprecated, replace with:</p>
1572 GetNextImageInList(images);
1575 <p>The format of the GetNextImage method is:</p>
1578 Image *GetNextImage(const Image *images)
1581 <p>A description of each parameter follows:</p></ol>
1584 <ol><p>the image list.</p></ol>
1587 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1588 _8c.html" target="source" name="GetNextImageAttribute">GetNextImageAttribute</a></h2>
1589 <div class="doc-section">
1591 <p>GetNextImageAttribute() gets the next image attribute.</p></ol>
1593 <p>Deprecated, replace with:</p>
1596 const char *property;
1597 property=GetNextImageProperty(image);
1598 if (property != (const char *) NULL)
1599 GetImageAttribute(image,property);
1602 <p>The format of the GetNextImageAttribute method is:</p>
1605 const ImageAttribute *GetNextImageAttribute(const Image *image)
1608 <p>A description of each parameter follows:</p></ol>
1611 <ol><p>the image.</p></ol>
1614 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1615 _8c.html" target="source" name="GetNumberScenes">GetNumberScenes</a></h2>
1616 <div class="doc-section">
1618 <p>GetNumberScenes() returns the number of images in the list.</p></ol>
1620 <p>Deprecated, replace with:</p>
1623 GetImageListLength(image);
1626 <p>The format of the GetNumberScenes method is:</p>
1629 unsigned int GetNumberScenes(const Image *images)
1632 <p>A description of each parameter follows:</p></ol>
1635 <ol><p>the image list.</p></ol>
1638 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1639 _8c.html" target="source" name="GetOnePixel">GetOnePixel</a></h2>
1640 <div class="doc-section">
1642 <p>GetOnePixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.</p></ol>
1644 <p>Deprecated, replace with:</p>
1647 GetOneAuthenticPixel(image,x,y,&pixel,&image->exception);
1650 <p>The format of the GetOnePixel() method is:</p>
1653 PixelPacket GetOnePixel(const Image image,const ssize_t x,const ssize_t y)
1656 <p>A description of each parameter follows:</p></ol>
1659 <ol><p>the image.</p></ol>
1662 <ol><p>These values define the location of the pixel to return.</p></ol>
1665 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1666 _8c.html" target="source" name="GetPixels">GetPixels</a></h2>
1667 <div class="doc-section">
1669 <p>GetPixels() returns the pixels associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p></ol>
1671 <p>Deprecated, replace with:</p>
1674 GetAuthenticPixelQueue(image);
1677 <p>The format of the GetPixels() method is:</p>
1680 PixelPacket *GetPixels(const Image image)
1683 <p>A description of each parameter follows:</p></ol>
1686 <ol><p>GetPixels() returns the pixels associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p></ol>
1689 <ol><p>the image.</p></ol>
1692 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1693 _8c.html" target="source" name="GetPreviousImage">GetPreviousImage</a></h2>
1694 <div class="doc-section">
1696 <p>GetPreviousImage() returns the previous image in a list.</p></ol>
1698 <p>Deprecated, replace with:</p>
1701 GetPreviousImageInList(images));
1704 <p>The format of the GetPreviousImage method is:</p>
1707 Image *GetPreviousImage(const Image *images)
1710 <p>A description of each parameter follows:</p></ol>
1713 <ol><p>the image list.</p></ol>
1716 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1717 _8c.html" target="source" name="HSLTransform">HSLTransform</a></h2>
1718 <div class="doc-section">
1720 <p>HSLTransform() converts a (hue, saturation, lightness) to a (red, green, blue) triple.</p></ol>
1722 <p>The format of the HSLTransformImage method is:</p>
1725 void HSLTransform(const double hue,const double saturation,
1726 const double lightness,Quantum *red,Quantum *green,Quantum *blue)
1729 <p>A description of each parameter follows:</p></ol>
1731 <h5>hue, saturation, lightness</h5>
1732 <ol><p>A double value representing a component of the HSL color space.</p></ol>
1734 <h5>red, green, blue</h5>
1735 <ol><p>A pointer to a pixel component of type Quantum.</p></ol>
1738 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1739 _8c.html" target="source" name="IdentityAffine">IdentityAffine</a></h2>
1740 <div class="doc-section">
1742 <p>IdentityAffine() initializes the affine transform to the identity matrix.</p></ol>
1744 <p>The format of the IdentityAffine method is:</p>
1747 IdentityAffine(AffineMatrix *affine)
1750 <p>A description of each parameter follows:</p></ol>
1753 <ol><p>A pointer the affine transform of type AffineMatrix.</p></ol>
1756 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1757 _8c.html" target="source" name="InitializeMagick">InitializeMagick</a></h2>
1758 <div class="doc-section">
1760 <p>InitializeMagick() initializes the ImageMagick environment.</p></ol>
1762 <p>Deprecated, replace with:</p>
1765 MagickCoreGenesis(path,MagickFalse);
1768 <p>The format of the InitializeMagick function is:</p>
1771 InitializeMagick(const char *path)
1774 <p>A description of each parameter follows:</p></ol>
1777 <ol><p>the execution path of the current ImageMagick client.</p></ol>
1780 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1781 _8c.html" target="source" name="InterpolatePixelColor">InterpolatePixelColor</a></h2>
1782 <div class="doc-section">
1784 <p>InterpolatePixelColor() applies bi-linear or tri-linear interpolation between a pixel and it's neighbors.</p></ol>
1786 <p>The format of the InterpolatePixelColor method is:</p>
1789 MagickPixelPacket InterpolatePixelColor(const Image *image,
1790 CacheView *view_info,InterpolatePixelMethod method,const double x,
1791 const double y,ExceptionInfo *exception)
1794 <p>A description of each parameter follows:</p></ol>
1797 <ol><p>the image.</p></ol>
1800 <ol><p>the image cache view.</p></ol>
1803 <ol><p>the type of pixel color interpolation.</p></ol>
1806 <ol><p>A double representing the current (x,y) position of the pixel.</p></ol>
1809 <ol><p>return any errors or warnings in this structure.</p></ol>
1812 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1813 _8c.html" target="source" name="InterpretImageAttributes">InterpretImageAttributes</a></h2>
1814 <div class="doc-section">
1816 <p>InterpretImageAttributes() replaces any embedded formatting characters with the appropriate image attribute and returns the translated text.</p></ol>
1818 <p>Deprecated, replace with:</p>
1821 InterpretImageProperties(image_info,image,embed_text);
1824 <p>The format of the InterpretImageAttributes method is:</p>
1827 char *InterpretImageAttributes(const ImageInfo *image_info,Image *image,
1828 const char *embed_text)
1831 <p>A description of each parameter follows:</p></ol>
1834 <ol><p>the image info.</p></ol>
1837 <ol><p>the image.</p></ol>
1840 <ol><p>the address of a character string containing the embedded formatting characters.</p></ol>
1843 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1844 _8c.html" target="source" name="LevelImageColor">LevelImageColor</a></h2>
1845 <div class="doc-section">
1847 <p>LevelImageColor() will map the given color to "black" and "white" values, limearly spreading out the colors, and level values on a channel by channel bases, as per LevelImage(). The given colors allows you to specify different level ranges for each of the color channels seperatally.</p></ol>
1849 <p>If the boolean 'invert' is set true the image values will modifyed in the reverse direction. That is any existing "black" and "white" colors in the image will become the color values given, with all other values compressed appropriatally. This effectivally maps a greyscale gradient into the given color gradient.</p></ol>
1851 <p>Deprecated, replace with:</p>
1854 LevelColorsImageChannel(image,channel,black_color,white_color,invert);
1857 <p>The format of the LevelImageColors method is:</p>
1860 MagickBooleanType LevelImageColors(Image *image,const ChannelType channel,
1861 const MagickPixelPacket *black_color,const MagickPixelPacket *white_color,
1862 const MagickBooleanType invert)
1865 <p>A description of each parameter follows:</p></ol>
1868 <ol><p>the image.</p></ol>
1871 <ol><p>the channel.</p></ol>
1873 <h5>black_color</h5>
1874 <ol><p>The color to map black to/from</p></ol>
1876 <h5>white_point</h5>
1877 <ol><p>The color to map white to/from</p></ol>
1880 <ol><p>if true map the colors (levelize), rather than from (level)</p></ol>
1883 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1884 _8c.html" target="source" name="LiberateMemory">LiberateMemory</a></h2>
1885 <div class="doc-section">
1887 <p>LiberateMemory() frees memory that has already been allocated, and NULL's the pointer to it.</p></ol>
1889 <p>The format of the LiberateMemory method is:</p>
1892 void LiberateMemory(void **memory)
1895 <p>A description of each parameter follows:</p></ol>
1898 <ol><p>A pointer to a block of memory to free for reuse.</p></ol>
1901 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1902 _8c.html" target="source" name="LiberateSemaphoreInfo">LiberateSemaphoreInfo</a></h2>
1903 <div class="doc-section">
1905 <p>LiberateSemaphoreInfo() relinquishes a semaphore.</p></ol>
1907 <p>Deprecated, replace with:</p>
1910 UnlockSemaphoreInfo(*semaphore_info);
1913 <p>The format of the LiberateSemaphoreInfo method is:</p>
1916 LiberateSemaphoreInfo(void **semaphore_info)
1919 <p>A description of each parameter follows:</p></ol>
1921 <h5>semaphore_info</h5>
1922 <ol><p>Specifies a pointer to an SemaphoreInfo structure.</p></ol>
1925 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1926 _8c.html" target="source" name="MagickIncarnate">MagickIncarnate</a></h2>
1927 <div class="doc-section">
1929 <p>MagickIncarnate() initializes the ImageMagick environment.</p></ol>
1931 <p>Deprecated, replace with:</p>
1934 MagickCoreGenesis(path,MagickFalse);
1937 <p>The format of the MagickIncarnate function is:</p>
1940 MagickIncarnate(const char *path)
1943 <p>A description of each parameter follows:</p></ol>
1946 <ol><p>the execution path of the current ImageMagick client.</p></ol>
1949 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1950 _8c.html" target="source" name="MagickMonitor">MagickMonitor</a></h2>
1951 <div class="doc-section">
1953 <p>MagickMonitor() calls the monitor handler method with a text string that describes the task and a measure of completion. The method returns MagickTrue on success otherwise MagickFalse if an error is encountered, e.g. if there was a user interrupt.</p></ol>
1955 <p>The format of the MagickMonitor method is:</p>
1958 MagickBooleanType MagickMonitor(const char *text,
1959 const MagickOffsetType offset,const MagickSizeType span,
1963 <p>A description of each parameter follows:</p></ol>
1966 <ol><p>the position relative to the span parameter which represents how much progress has been made toward completing a task.</p></ol>
1969 <ol><p>the span relative to completing a task.</p></ol>
1971 <h5>client_data</h5>
1972 <ol><p>the client data.</p></ol>
1975 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1976 _8c.html" target="source" name="MapImage">MapImage</a></h2>
1977 <div class="doc-section">
1979 <p>MapImage() replaces the colors of an image with the closest color from a reference image.</p></ol>
1981 <p>Deprecated, replace with:</p>
1984 QuantizeInfo quantize_info;
1985 GetQuantizeInfo(&quantize_info);
1986 quantize_info.dither=dither;
1987 RemapImage(&quantize_info,image,map_image);
1990 <p>The format of the MapImage method is:</p>
1993 MagickBooleanType MapImage(Image *image,const Image *map_image,
1994 const MagickBooleanType dither)
1997 <p>A description of each parameter follows:</p></ol>
2000 <ol><p>Specifies a pointer to an Image structure.</p></ol>
2003 <ol><p>the image. Reduce image to a set of colors represented by this image.</p></ol>
2006 <ol><p>Set this integer value to something other than zero to dither the mapped image.</p></ol>
2009 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2010 _8c.html" target="source" name="MapImages">MapImages</a></h2>
2011 <div class="doc-section">
2013 <p>MapImages() replaces the colors of a sequence of images with the closest color from a reference image.</p></ol>
2015 <p>Deprecated, replace with:</p>
2018 QuantizeInfo quantize_info;
2019 GetQuantizeInfo(&quantize_info);
2020 quantize_info.dither=dither;
2021 RemapImages(&quantize_info,images,map_image);
2024 <p>The format of the MapImage method is:</p>
2027 MagickBooleanType MapImages(Image *images,Image *map_image,
2028 const MagickBooleanType dither)
2031 <p>A description of each parameter follows:</p></ol>
2034 <ol><p>Specifies a pointer to a set of Image structures.</p></ol>
2037 <ol><p>the image. Reduce image to a set of colors represented by this image.</p></ol>
2040 <ol><p>Set this integer value to something other than zero to dither the quantized image.</p></ol>
2043 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2044 _8c.html" target="source" name="MatteFloodfill">MatteFloodfill</a></h2>
2045 <div class="doc-section">
2047 <p>MatteFloodfill() changes the transparency value of any pixel that matches target and is an immediate neighbor. If the method FillToBorderMethod is specified, the transparency value is changed for any neighbor pixel that does not match the bordercolor member of image.</p></ol>
2049 <p>By default target must match a particular pixel transparency exactly. However, in many cases two transparency values may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two transparency values as the same. For example, set fuzz to 10 and the opacity values of 100 and 102 respectively are now interpreted as the same value for the purposes of the floodfill.</p></ol>
2051 <p>The format of the MatteFloodfillImage method is:</p>
2054 MagickBooleanType MatteFloodfillImage(Image *image,
2055 const PixelPacket target,const Quantum opacity,const ssize_t x_offset,
2056 const ssize_t y_offset,const PaintMethod method)
2059 <p>A description of each parameter follows:</p></ol>
2062 <ol><p>the image.</p></ol>
2065 <ol><p>the RGB value of the target color.</p></ol>
2068 <ol><p>the level of transparency: 0 is fully opaque and QuantumRange is fully transparent.</p></ol>
2071 <ol><p>the starting location of the operation.</p></ol>
2074 <ol><p>Choose either FloodfillMethod or FillToBorderMethod.</p></ol>
2077 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2078 _8c.html" target="source" name="MaximumImages">MaximumImages</a></h2>
2079 <div class="doc-section">
2081 <p>MaximumImages() returns the maximum intensity of an image sequence.</p></ol>
2083 <p>Deprecated, replace with:</p>
2086 EvaluateImages(images,MinEvaluateOperator,exception);
2089 <p>The format of the MaxImages method is:</p>
2092 Image *MaximumImages(Image *images,ExceptionInfo *exception)
2095 <p>A description of each parameter follows:</p></ol>
2098 <ol><p>the image sequence.</p></ol>
2101 <ol><p>return any errors or warnings in this structure.</p></ol>
2104 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2105 _8c.html" target="source" name="MinimumImages">MinimumImages</a></h2>
2106 <div class="doc-section">
2108 <p>MinimumImages() returns the minimum intensity of an image sequence.</p></ol>
2110 <p>Deprecated, replace with:</p>
2113 EvaluateImages(images,MinEvaluateOperator,exception);
2116 <p>The format of the MinimumImages method is:</p>
2119 Image *MinimumImages(Image *images,ExceptionInfo *exception)
2122 <p>A description of each parameter follows:</p></ol>
2125 <ol><p>the image sequence.</p></ol>
2128 <ol><p>return any errors or warnings in this structure.</p></ol>
2131 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2132 _8c.html" target="source" name="MosaicImages">MosaicImages</a></h2>
2133 <div class="doc-section">
2135 <p>MosaicImages() Obsolete Function: Use MergeImageLayers() instead.</p></ol>
2137 <p>Deprecated, replace with:</p>
2140 MergeImageLayers(image,MosaicLayer,exception);
2143 <p>The format of the MosaicImage method is:</p>
2146 Image *MosaicImages(const Image *image,ExceptionInfo *exception)
2149 <p>A description of each parameter follows:</p></ol>
2152 <ol><p>the image list to be composited together</p></ol>
2155 <ol><p>return any errors or warnings in this structure.</p></ol>
2158 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2159 _8c.html" target="source" name="OpaqueImage">OpaqueImage</a></h2>
2160 <div class="doc-section">
2162 <p>OpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
2164 <p>By default color must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. Fuzz defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color.</p></ol>
2166 <p>The format of the OpaqueImage method is:</p>
2169 MagickBooleanType OpaqueImage(Image *image,
2170 const PixelPacket *target,const PixelPacket fill)
2173 <p>A description of each parameter follows:</p></ol>
2176 <ol><p>the image.</p></ol>
2179 <ol><p>the RGB value of the target color.</p></ol>
2182 <ol><p>the replacement color.</p></ol>
2185 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2186 _8c.html" target="source" name="OpenCacheView">OpenCacheView</a></h2>
2187 <div class="doc-section">
2189 <p>OpenCacheView() opens a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p></ol>
2191 <p>Deprecated, replace with:</p>
2194 AcquireCacheView(image);
2197 <p>The format of the OpenCacheView method is:</p>
2200 CacheView *OpenCacheView(const Image *image)
2203 <p>A description of each parameter follows:</p></ol>
2206 <ol><p>the image.</p></ol>
2209 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2210 _8c.html" target="source" name="PaintFloodfill">PaintFloodfill</a></h2>
2211 <div class="doc-section">
2213 <p>PaintFloodfill() changes the color value of any pixel that matches target and is an immediate neighbor. If the method FillToBorderMethod is specified, the color value is changed for any neighbor pixel that does not match the bordercolor member of image.</p></ol>
2215 <p>By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.</p></ol>
2217 <p>Deprecated, replace with:</p>
2220 FloodfillPaintImage(image,channel,draw_info,target,x,y,
2221 method == FloodfillMethod ? MagickFalse : MagickTrue);
2224 <p>The format of the PaintFloodfillImage method is:</p>
2227 MagickBooleanType PaintFloodfillImage(Image *image,
2228 const ChannelType channel,const MagickPixelPacket target,const ssize_t x,
2229 const ssize_t y,const DrawInfo *draw_info,const PaintMethod method)
2232 <p>A description of each parameter follows:</p></ol>
2235 <ol><p>the image.</p></ol>
2238 <ol><p>the channel(s).</p></ol>
2241 <ol><p>the RGB value of the target color.</p></ol>
2244 <ol><p>the starting location of the operation.</p></ol>
2247 <ol><p>the draw info.</p></ol>
2250 <ol><p>Choose either FloodfillMethod or FillToBorderMethod.</p></ol>
2253 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2254 _8c.html" target="source" name="PaintOpaqueImage">PaintOpaqueImage</a></h2>
2255 <div class="doc-section">
2257 <p>PaintOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
2259 <p>By default color must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. Fuzz defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color.</p></ol>
2261 <p>Deprecated, replace with:</p>
2264 OpaquePaintImageChannel(image,DefaultChannels,target,fill,MagickFalse);
2265 OpaquePaintImageChannel(image,channel,target,fill,MagickFalse);
2268 <p>The format of the PaintOpaqueImage method is:</p>
2271 MagickBooleanType PaintOpaqueImage(Image *image,
2272 const PixelPacket *target,const PixelPacket *fill)
2273 MagickBooleanType PaintOpaqueImageChannel(Image *image,
2274 const ChannelType channel,const PixelPacket *target,
2275 const PixelPacket *fill)
2278 <p>A description of each parameter follows:</p></ol>
2281 <ol><p>the image.</p></ol>
2284 <ol><p>the channel(s).</p></ol>
2287 <ol><p>the RGB value of the target color.</p></ol>
2290 <ol><p>the replacement color.</p></ol>
2293 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2294 _8c.html" target="source" name="PaintTransparentImage">PaintTransparentImage</a></h2>
2295 <div class="doc-section">
2297 <p>PaintTransparentImage() changes the opacity value associated with any pixel that matches color to the value defined by opacity.</p></ol>
2299 <p>By default color must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. Fuzz defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color.</p></ol>
2301 <p>Deprecated, replace with:</p>
2304 TransparentPaintImage(image,target,opacity,MagickFalse);
2307 <p>The format of the PaintTransparentImage method is:</p>
2310 MagickBooleanType PaintTransparentImage(Image *image,
2311 const MagickPixelPacket *target,const Quantum opacity)
2314 <p>A description of each parameter follows:</p></ol>
2317 <ol><p>the image.</p></ol>
2320 <ol><p>the RGB value of the target color.</p></ol>
2323 <ol><p>the replacement opacity value.</p></ol>
2326 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2327 _8c.html" target="source" name="ParseSizeGeometry">ParseSizeGeometry</a></h2>
2328 <div class="doc-section">
2330 <p>ParseSizeGeometry() returns a region as defined by the geometry string with respect to the image dimensions and aspect ratio.</p></ol>
2332 <p>Deprecated, replace with:</p>
2335 ParseMetaGeometry(geometry,®ion_info->x,®ion_info->y,
2336 ®ion_info->width,®ion_info->height);
2339 <p>The format of the ParseSizeGeometry method is:</p>
2342 MagickStatusType ParseSizeGeometry(const Image *image,
2343 const char *geometry,RectangeInfo *region_info)
2346 <p>A description of each parameter follows:</p></ol>
2349 <ol><p>The geometry (e.g. 100x100+10+10).</p></ol>
2351 <h5>region_info</h5>
2352 <ol><p>the region as defined by the geometry string.</p></ol>
2355 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2356 _8c.html" target="source" name="PopImageList">PopImageList</a></h2>
2357 <div class="doc-section">
2359 <p>PopImageList() removes the last image in the list.</p></ol>
2361 <p>Deprecated, replace with:</p>
2364 RemoveLastImageFromList(images);
2367 <p>The format of the PopImageList method is:</p>
2370 Image *PopImageList(Image **images)
2373 <p>A description of each parameter follows:</p></ol>
2376 <ol><p>the image list.</p></ol>
2379 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2380 _8c.html" target="source" name="PopImagePixels">PopImagePixels</a></h2>
2381 <div class="doc-section">
2383 <p>PopImagePixels() transfers one or more pixel components from the image pixel cache to a user supplied buffer. The pixels are returned in network byte order. MagickTrue is returned if the pixels are successfully transferred, otherwise MagickFalse.</p></ol>
2385 <p>The format of the PopImagePixels method is:</p>
2388 size_t PopImagePixels(Image *,const QuantumType quantum,
2389 unsigned char *destination)
2392 <p>A description of each parameter follows:</p></ol>
2395 <ol><p>the image.</p></ol>
2398 <ol><p>Declare which pixel components to transfer (RGB, RGBA, etc).</p></ol>
2400 <h5>destination</h5>
2401 <ol><p>The components are transferred to this buffer.</p></ol>
2404 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2405 _8c.html" target="source" name="PostscriptGeometry">PostscriptGeometry</a></h2>
2406 <div class="doc-section">
2408 <p>PostscriptGeometry() replaces any page mneumonic with the equivalent size in picas.</p></ol>
2410 <p>Deprecated, replace with:</p>
2413 GetPageGeometry(page);
2416 <p>The format of the PostscriptGeometry method is:</p>
2419 char *PostscriptGeometry(const char *page)
2422 <p>A description of each parameter follows.</p></ol>
2425 <ol><p>Specifies a pointer to an array of characters. The string is either a Postscript page name (e.g. A4) or a postscript page geometry (e.g. 612x792+36+36).</p></ol>
2428 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2429 _8c.html" target="source" name="PushImageList">PushImageList</a></h2>
2430 <div class="doc-section">
2432 <p>PushImageList() adds an image to the end of the list.</p></ol>
2434 <p>Deprecated, replace with:</p>
2437 AppendImageToList(images,CloneImageList(image,exception));
2440 <p>The format of the PushImageList method is:</p>
2443 unsigned int PushImageList(Image *images,const Image *image,
2444 ExceptionInfo *exception)
2447 <p>A description of each parameter follows:</p></ol>
2450 <ol><p>the image list.</p></ol>
2453 <ol><p>the image.</p></ol>
2456 <ol><p>return any errors or warnings in this structure.</p></ol>
2459 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2460 _8c.html" target="source" name="PushImagePixels">PushImagePixels</a></h2>
2461 <div class="doc-section">
2463 <p>PushImagePixels() transfers one or more pixel components from a user supplied buffer into the image pixel cache of an image. The pixels are expected in network byte order. It returns MagickTrue if the pixels are successfully transferred, otherwise MagickFalse.</p></ol>
2465 <p>The format of the PushImagePixels method is:</p>
2468 size_t PushImagePixels(Image *image,const QuantumType quantum,
2469 const unsigned char *source)
2472 <p>A description of each parameter follows:</p></ol>
2475 <ol><p>the image.</p></ol>
2478 <ol><p>Declare which pixel components to transfer (red, green, blue, opacity, RGB, or RGBA).</p></ol>
2481 <ol><p>The pixel components are transferred from this buffer.</p></ol>
2484 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2485 _8c.html" target="source" name="QuantizationError">QuantizationError</a></h2>
2486 <div class="doc-section">
2488 <p>QuantizationError() measures the difference between the original and quantized images. This difference is the total quantization error. The error is computed by summing over all pixels in an image the distance squared in RGB space between each reference pixel value and its quantized value. These values are computed:</p>
2491 o mean_error_per_pixel: This value is the mean error for any single
2495 <h5>normalized_mean_square_error</h5>
2496 <ol><p>This value is the normalized mean quantization error for any single pixel in the image. This distance measure is normalized to a range between 0 and 1. It is independent of the range of red, green, and blue values in the image.</p></ol>
2498 <h5>normalized_maximum_square_error</h5>
2499 <ol><p>Thsi value is the normalized maximum quantization error for any single pixel in the image. This distance measure is normalized to a range between 0 and 1. It is independent of the range of red, green, and blue values in your image.</p></ol>
2501 <p>Deprecated, replace with:</p>
2504 GetImageQuantizeError(image);
2507 <p>The format of the QuantizationError method is:</p>
2510 unsigned int QuantizationError(Image *image)
2513 <p>A description of each parameter follows.</p></ol>
2516 <ol><p>Specifies a pointer to an Image structure; returned from ReadImage.</p></ol>
2519 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2520 _8c.html" target="source" name="RandomChannelThresholdImage">RandomChannelThresholdImage</a></h2>
2521 <div class="doc-section">
2523 <p>RandomChannelThresholdImage() changes the value of individual pixels based on the intensity of each pixel compared to a random threshold. The result is a low-contrast, two color image.</p></ol>
2525 <p>The format of the RandomChannelThresholdImage method is:</p>
2528 unsigned int RandomChannelThresholdImage(Image *image,
2529 const char *channel, const char *thresholds,
2530 ExceptionInfo *exception)
2533 <p>A description of each parameter follows:</p></ol>
2536 <ol><p>the image.</p></ol>
2539 <ol><p>the channel or channels to be thresholded.</p></ol>
2542 <ol><p>a geometry string containing LOWxHIGH thresholds. If the string contains 2x2, 3x3, or 4x4, then an ordered dither of order 2, 3, or 4 will be performed instead.</p></ol>
2545 <ol><p>return any errors or warnings in this structure.</p></ol>
2548 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2549 _8c.html" target="source" name="ReacquireMemory">ReacquireMemory</a></h2>
2550 <div class="doc-section">
2552 <p>ReacquireMemory() changes the size of the memory and returns a pointer to the (possibly moved) block. The contents will be unchanged up to the lesser of the new and old sizes.</p></ol>
2554 <p>The format of the ReacquireMemory method is:</p>
2557 void ReacquireMemory(void **memory,const size_t size)
2560 <p>A description of each parameter follows:</p></ol>
2563 <ol><p>A pointer to a memory allocation. On return the pointer may change but the contents of the original allocation will not.</p></ol>
2566 <ol><p>the new size of the allocated memory.</p></ol>
2569 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2570 _8c.html" target="source" name="RecolorImage">RecolorImage</a></h2>
2571 <div class="doc-section">
2573 <p>RecolorImage() apply color transformation to an image. The method permits saturation changes, hue rotation, luminance to alpha, and various other effects. Although variable-sized transformation matrices can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6 for CMYKA (or RGBA with offsets). The matrix is similar to those used by Adobe Flash except offsets are in column 6 rather than 5 (in support of CMYKA images) and offsets are normalized (divide Flash offset by 255).</p></ol>
2575 <p>The format of the RecolorImage method is:</p>
2578 Image *RecolorImage(const Image *image,const size_t order,
2579 const double *color_matrix,ExceptionInfo *exception)
2582 <p>A description of each parameter follows:</p></ol>
2585 <ol><p>the image.</p></ol>
2588 <ol><p>the number of columns and rows in the recolor matrix.</p></ol>
2590 <h5>color_matrix</h5>
2591 <ol><p>An array of double representing the recolor matrix.</p></ol>
2594 <ol><p>return any errors or warnings in this structure.</p></ol>
2597 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2598 _8c.html" target="source" name="ResetImageAttributeIterator">ResetImageAttributeIterator</a></h2>
2599 <div class="doc-section">
2601 <p>ResetImageAttributeIterator() resets the image attributes iterator. Use it in conjunction with GetNextImageAttribute() to iterate over all the values associated with an image.</p></ol>
2603 <p>Deprecated, replace with:</p>
2606 ResetImagePropertyIterator(image);
2609 <p>The format of the ResetImageAttributeIterator method is:</p>
2612 ResetImageAttributeIterator(const ImageInfo *image)
2615 <p>A description of each parameter follows:</p></ol>
2618 <ol><p>the image.</p></ol>
2621 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2622 _8c.html" target="source" name="SetCacheViewPixels">SetCacheViewPixels</a></h2>
2623 <div class="doc-section">
2625 <p>SetCacheViewPixels() gets pixels from the in-memory or disk pixel cache as defined by the geometry parameters. A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.</p></ol>
2627 <p>Deprecated, replace with:</p>
2630 QueueCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
2631 GetCacheViewException(cache_view));
2634 <p>The format of the SetCacheViewPixels method is:</p>
2637 PixelPacket *SetCacheViewPixels(CacheView *cache_view,const ssize_t x,
2638 const ssize_t y,const size_t columns,const size_t rows)
2641 <p>A description of each parameter follows:</p></ol>
2644 <ol><p>the cache view.</p></ol>
2646 <h5>x,y,columns,rows</h5>
2647 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
2650 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2651 _8c.html" target="source" name="SetExceptionInfo">SetExceptionInfo</a></h2>
2652 <div class="doc-section">
2654 <p>SetExceptionInfo() sets the exception severity.</p></ol>
2656 <p>The format of the SetExceptionInfo method is:</p>
2659 MagickBooleanType SetExceptionInfo(ExceptionInfo *exception,
2660 ExceptionType severity)
2663 <p>A description of each parameter follows:</p></ol>
2666 <ol><p>the exception info.</p></ol>
2669 <ol><p>the exception severity.</p></ol>
2672 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2673 _8c.html" target="source" name="SetImage">SetImage</a></h2>
2674 <div class="doc-section">
2676 <p>SetImage() sets the red, green, and blue components of each pixel to the image background color and the opacity component to the specified level of transparency. The background color is defined by the background_color member of the image.</p></ol>
2678 <p>The format of the SetImage method is:</p>
2681 void SetImage(Image *image,const Quantum opacity)
2684 <p>A description of each parameter follows:</p></ol>
2687 <ol><p>the image.</p></ol>
2690 <ol><p>Set each pixel to this level of transparency.</p></ol>
2693 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2694 _8c.html" target="source" name="SetImageAttribute">SetImageAttribute</a></h2>
2695 <div class="doc-section">
2697 <p>SetImageAttribute() searches the list of image attributes and replaces the attribute value. If it is not found in the list, the attribute name and value is added to the list.</p></ol>
2699 <p>Deprecated, replace with:</p>
2702 SetImageProperty(image,key,value);
2705 <p>The format of the SetImageAttribute method is:</p>
2708 MagickBooleanType SetImageAttribute(Image *image,const char *key,
2712 <p>A description of each parameter follows:</p></ol>
2715 <ol><p>the image.</p></ol>
2718 <ol><p>the key.</p></ol>
2721 <ol><p>the value.</p></ol>
2724 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2725 _8c.html" target="source" name="SetImageList">SetImageList</a></h2>
2726 <div class="doc-section">
2728 <p>SetImageList() inserts an image into the list at the specified position.</p></ol>
2730 <p>The format of the SetImageList method is:</p>
2733 unsigned int SetImageList(Image *images,const Image *image,
2734 const ssize_t offset,ExceptionInfo *exception)
2737 <p>A description of each parameter follows:</p></ol>
2740 <ol><p>the image list.</p></ol>
2743 <ol><p>the image.</p></ol>
2746 <ol><p>the position within the list.</p></ol>
2749 <ol><p>return any errors or warnings in this structure.</p></ol>
2752 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2753 _8c.html" target="source" name="SetImagePixels">SetImagePixels</a></h2>
2754 <div class="doc-section">
2756 <p>SetImagePixels() 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>
2758 <p>Write-only access means that any existing pixel values corresponding to the region are ignored. This useful while 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 SetImagePixels() any way it pleases. SetImagePixels() does not initialize the pixel array values. Initializing pixel array values is the application's responsibility.</p></ol>
2760 <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>
2762 <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>
2764 <p>Deprecated, replace with:</p>
2767 QueueAuthenticPixels(image,x,y,columns,rows,&image->exception);
2770 <p>The format of the SetImagePixels() method is:</p>
2773 PixelPacket *SetImagePixels(Image *image,const ssize_t x,const ssize_t y,
2774 const size_t columns,const size_t rows)
2777 <p>A description of each parameter follows:</p></ol>
2780 <ol><p>SetImagePixels returns a pointer to the pixels if they are transferred, otherwise a NULL is returned.</p></ol>
2783 <ol><p>the image.</p></ol>
2785 <h5>x,y,columns,rows</h5>
2786 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
2789 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2790 _8c.html" target="source" name="SetMagickRegistry">SetMagickRegistry</a></h2>
2791 <div class="doc-section">
2793 <p>SetMagickRegistry() sets a blob into the registry and returns a unique ID. If an error occurs, -1 is returned.</p></ol>
2795 <p>The format of the SetMagickRegistry method is:</p>
2798 ssize_t SetMagickRegistry(const RegistryType type,const void *blob,
2799 const size_t length,ExceptionInfo *exception)
2802 <p>A description of each parameter follows:</p></ol>
2805 <ol><p>the registry type.</p></ol>
2808 <ol><p>the address of a Binary Large OBject.</p></ol>
2811 <ol><p>For a registry type of ImageRegistryType use sizeof(Image) otherise the blob length in number of bytes.</p></ol>
2814 <ol><p>return any errors or warnings in this structure.</p></ol>
2817 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2818 _8c.html" target="source" name="SetMonitorHandler">SetMonitorHandler</a></h2>
2819 <div class="doc-section">
2821 <p>SetMonitorHandler() sets the monitor handler to the specified method and returns the previous monitor handler.</p></ol>
2823 <p>The format of the SetMonitorHandler method is:</p>
2826 MonitorHandler SetMonitorHandler(MonitorHandler handler)
2829 <p>A description of each parameter follows:</p></ol>
2832 <ol><p>Specifies a pointer to a method to handle monitors.</p></ol>
2835 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2836 _8c.html" target="source" name="ShiftImageList">ShiftImageList</a></h2>
2837 <div class="doc-section">
2839 <p>ShiftImageList() removes an image from the beginning of the list.</p></ol>
2841 <p>Deprecated, replace with:</p>
2844 RemoveFirstImageFromList(images);
2847 <p>The format of the ShiftImageList method is:</p>
2850 Image *ShiftImageList(Image **images)
2853 <p>A description of each parameter follows:</p></ol>
2856 <ol><p>the image list.</p></ol>
2859 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2860 _8c.html" target="source" name="SpliceImageList">SpliceImageList</a></h2>
2861 <div class="doc-section">
2863 <p>SpliceImageList() removes the images designated by offset and length from the list and replaces them with the specified list.</p></ol>
2865 <p>The format of the SpliceImageList method is:</p>
2868 Image *SpliceImageList(Image *images,const ssize_t offset,
2869 const size_t length,const Image *splices,
2870 ExceptionInfo *exception)
2873 <p>A description of each parameter follows:</p></ol>
2876 <ol><p>the image list.</p></ol>
2879 <ol><p>the position within the list.</p></ol>
2882 <ol><p>the length of the image list to remove.</p></ol>
2885 <ol><p>Replace the removed image list with this list.</p></ol>
2888 <ol><p>return any errors or warnings in this structure.</p></ol>
2891 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2892 _8c.html" target="source" name="Strip">Strip</a></h2>
2893 <div class="doc-section">
2895 <p>Strip() strips any whitespace or quotes from the beginning and end of a string of characters.</p></ol>
2897 <p>The format of the Strip method is:</p>
2900 void Strip(char *message)
2903 <p>A description of each parameter follows:</p></ol>
2906 <ol><p>Specifies an array of characters.</p></ol>
2909 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2910 _8c.html" target="source" name="SyncCacheView">SyncCacheView</a></h2>
2911 <div class="doc-section">
2913 <p>SyncCacheView() saves the cache view pixels to the in-memory or disk cache. It returns MagickTrue if the pixel region is synced, otherwise MagickFalse.</p></ol>
2915 <p>Deprecated, replace with:</p>
2918 SyncCacheViewAuthenticPixels(cache_view,GetCacheViewException(cache_view));
2921 <p>The format of the SyncCacheView method is:</p>
2924 MagickBooleanType SyncCacheView(CacheView *cache_view)
2927 <p>A description of each parameter follows:</p></ol>
2930 <ol><p>the cache view.</p></ol>
2933 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2934 _8c.html" target="source" name="SyncCacheViewPixels">SyncCacheViewPixels</a></h2>
2935 <div class="doc-section">
2937 <p>SyncCacheViewPixels() saves the cache view pixels to the in-memory or disk cache. It returns MagickTrue if the pixel region is flushed, otherwise MagickFalse.</p></ol>
2939 <p>Deprecated, replace with:</p>
2942 SyncCacheViewAuthenticPixels(cache_view,GetCacheViewException(cache_view));
2945 <p>The format of the SyncCacheViewPixels method is:</p>
2948 MagickBooleanType SyncCacheViewPixels(CacheView *cache_view)
2951 <p>A description of each parameter follows:</p></ol>
2954 <ol><p>the cache view.</p></ol>
2957 <ol><p>return any errors or warnings in this structure.</p></ol>
2960 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2961 _8c.html" target="source" name="SyncImagePixels">SyncImagePixels</a></h2>
2962 <div class="doc-section">
2964 <p>SyncImagePixels() saves the image pixels to the in-memory or disk cache. The method returns MagickTrue if the pixel region is synced, otherwise MagickFalse.</p></ol>
2966 <p>Deprecated, replace with:</p>
2969 SyncAuthenticPixels(image,&image->exception);
2972 <p>The format of the SyncImagePixels() method is:</p>
2975 MagickBooleanType SyncImagePixels(Image *image)
2978 <p>A description of each parameter follows:</p></ol>
2981 <ol><p>the image.</p></ol>
2984 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2985 _8c.html" target="source" name="TemporaryFilename">TemporaryFilename</a></h2>
2986 <div class="doc-section">
2988 <p>TemporaryFilename() replaces the contents of path by a unique path name.</p></ol>
2990 <p>The format of the TemporaryFilename method is:</p>
2993 void TemporaryFilename(char *path)
2996 <p>A description of each parameter follows.</p></ol>
2999 <ol><p>Specifies a pointer to an array of characters. The unique path name is returned in this array.</p></ol>
3002 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
3003 _8c.html" target="source" name="ThresholdImage">ThresholdImage</a></h2>
3004 <div class="doc-section">
3006 <p>ThresholdImage() changes the value of individual pixels based on the intensity of each pixel compared to threshold. The result is a high-contrast, two color image.</p></ol>
3008 <p>The format of the ThresholdImage method is:</p>
3011 unsigned int ThresholdImage(Image *image,const double threshold)
3014 <p>A description of each parameter follows:</p></ol>
3017 <ol><p>the image.</p></ol>
3020 <ol><p>Define the threshold value</p></ol>
3023 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
3024 _8c.html" target="source" name="ThresholdImageChannel">ThresholdImageChannel</a></h2>
3025 <div class="doc-section">
3027 <p>ThresholdImageChannel() changes the value of individual pixels based on the intensity of each pixel channel. The result is a high-contrast image.</p></ol>
3029 <p>The format of the ThresholdImageChannel method is:</p>
3032 unsigned int ThresholdImageChannel(Image *image,const char *threshold)
3035 <p>A description of each parameter follows:</p></ol>
3038 <ol><p>the image.</p></ol>
3041 <ol><p>define the threshold values.</p></ol>
3044 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
3045 _8c.html" target="source" name="TransformHSL">TransformHSL</a></h2>
3046 <div class="doc-section">
3048 <p>TransformHSL() converts a (red, green, blue) to a (hue, saturation, lightness) triple.</p></ol>
3050 <p>The format of the TransformHSL method is:</p>
3053 void TransformHSL(const Quantum red,const Quantum green,
3054 const Quantum blue,double *hue,double *saturation,double *lightness)
3057 <p>A description of each parameter follows:</p></ol>
3059 <h5>red, green, blue</h5>
3060 <ol><p>A Quantum value representing the red, green, and blue component of a pixel..</p></ol>
3062 <h5>hue, saturation, lightness</h5>
3063 <ol><p>A pointer to a double value representing a component of the HSL color space.</p></ol>
3066 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
3067 _8c.html" target="source" name="TranslateText">TranslateText</a></h2>
3068 <div class="doc-section">
3070 <p>TranslateText() replaces any embedded formatting characters with the appropriate image attribute and returns the translated text.</p></ol>
3072 <p>Deprecated, replace with:</p>
3075 InterpretImageProperties(image_info,image,embed_text);
3078 <p>The format of the TranslateText method is:</p>
3081 char *TranslateText(const ImageInfo *image_info,Image *image,
3082 const char *embed_text)
3085 <p>A description of each parameter follows:</p></ol>
3088 <ol><p>the image info.</p></ol>
3091 <ol><p>the image.</p></ol>
3094 <ol><p>the address of a character string containing the embedded formatting characters.</p></ol>
3097 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
3098 _8c.html" target="source" name="TransparentImage">TransparentImage</a></h2>
3099 <div class="doc-section">
3101 <p>TransparentImage() changes the opacity value associated with any pixel that matches color to the value defined by opacity.</p></ol>
3103 <p>By default color must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. Fuzz defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color.</p></ol>
3105 <p>The format of the TransparentImage method is:</p>
3108 MagickBooleanType TransparentImage(Image *image,
3109 const PixelPacket target,const Quantum opacity)
3112 <p>A description of each parameter follows:</p></ol>
3115 <ol><p>the image.</p></ol>
3118 <ol><p>the RGB value of the target color.</p></ol>
3121 <ol><p>the replacement opacity value.</p></ol>
3124 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
3125 _8c.html" target="source" name="UnshiftImageList">UnshiftImageList</a></h2>
3126 <div class="doc-section">
3128 <p>UnshiftImageList() adds the image to the beginning of the list.</p></ol>
3130 <p>Deprecated, replace with:</p>
3133 PrependImageToList(images,CloneImageList(image,exception));
3136 <p>The format of the UnshiftImageList method is:</p>
3139 unsigned int UnshiftImageList(Image *images,const Image *image,
3140 ExceptionInfo *exception)
3143 <p>A description of each parameter follows:</p></ol>
3146 <ol><p>the image list.</p></ol>
3149 <ol><p>the image.</p></ol>
3152 <ol><p>return any errors or warnings in this structure.</p></ol>
3155 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
3156 _8c.html" target="source" name="ZoomImage">ZoomImage</a></h2>
3157 <div class="doc-section">
3159 <p>ZoomImage() creates a new image that is a scaled size of an existing one. It allocates the memory necessary for the new Image structure and returns a pointer to the new image. The Point filter gives fast pixel replication, Triangle is equivalent to bi-linear interpolation, and Mitchel giver slower, very high-quality results. See Graphic Gems III for details on this algorithm.</p></ol>
3161 <p>The filter member of the Image structure specifies which image filter to use. Blur specifies the blur factor where > 1 is blurry, < 1 is sharp.</p></ol>
3163 <p>The format of the ZoomImage method is:</p>
3166 Image *ZoomImage(const Image *image,const size_t columns,
3167 const size_t rows,ExceptionInfo *exception)
3170 <p>A description of each parameter follows:</p></ol>
3173 <ol><p>the image.</p></ol>
3176 <ol><p>An integer that specifies the number of columns in the zoom image.</p></ol>
3179 <ol><p>An integer that specifies the number of rows in the scaled image.</p></ol>
3182 <ol><p>return any errors or warnings in this structure.</p></ol>
3188 <div id="linkbar">
\r
3189 <span id="linkbar-west"> </span>
\r
3190 <span id="linkbar-center">
\r
3191 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
\r
3192 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
\r
3194 <span id="linkbar-east"> </span>
\r
3196 <div class="footer">
\r
3197 <span id="footer-west">© 1999-2010 ImageMagick Studio LLC</span>
\r
3198 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
\r
3200 <div style="clear: both; margin: 0; width: 100%; "></div>
\r
3201 <script type="text/javascript">
\r
3202 var _gaq = _gaq || [];
\r
3203 _gaq.push(['_setAccount', 'UA-17690367-1']);
\r
3204 _gaq.push(['_trackPageview']);
\r
3207 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
\r
3208 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
\r
3209 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
\r