1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html version="-//W3C//DTD XHTML 1.1//EN"
4 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:schemaLocation="http://www.w3.org/1999/xhtml
7 http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
9 <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
10 <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>
11 <title>ImageMagick: MagickCore, C API for ImageMagick: Deprecated Methods</title>
12 <meta http-equiv="content-language" content="en-US"/>
13 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
14 <meta http-equiv="reply-to" content="magick-users@imagemagick.org"/>
15 <meta name="application-name" content="ImageMagick"/>
16 <meta name="description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition resize, rotate, shear, distort and transform images automagically."/>
17 <meta name="application-url" content="http://www.imagemagick.org"/>
18 <meta name="generator" content="PHP"/>
19 <meta name="keywords" content="magickcore, c, api, for, imagemagick:, deprecated, methods, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
20 <meta name="rating" content="GENERAL"/>
21 <meta name="robots" content="INDEX, FOLLOW"/>
22 <meta name="generator" content="ImageMagick Studio LLC"/>
23 <meta name="author" content="ImageMagick Studio LLC"/>
24 <meta name="revisit-after" content="2 DAYS"/>
25 <meta name="resource-type" content="document"/>
26 <meta name="copyright" content="Copyright (c) 1999-2013 ImageMagick Studio LLC"/>
27 <meta name="distribution" content="Global"/>
28 <link rel="icon" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/wand.png"/>
29 <link rel="shortcut icon" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/wand.ico" type="images/x-icon"/>
30 <link rel="canonical" href="http://www.imagemagick.org" />
31 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
32 <!-- Add jQuery library -->
33 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
35 <!-- Optionaly include easing and/or mousewheel plugins -->
36 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.easing-1.3.pack.js"></script>
37 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.mousewheel-3.0.6.pack.js"></script>
40 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/jquery.fancybox.css?v=2.0.4" type="text/css" media="screen" />
41 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox.pack.js?v=2.0.4"></script>
43 <!-- Optionaly include button and/or thumbnail helpers -->
44 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.css?v=2.0.4" type="text/css" media="screen" />
45 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.js?v=2.0.4"></script>
47 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.css?v=2.0.4" type="text/css" media="screen" />
48 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.js?v=2.0.4"></script>
49 <script type="text/javascript">
50 $(document).ready(function() {
51 $(".fancybox").fancybox();
54 <!-- ImageMagick style -->
55 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
56 <style type="text/css" media="all">
57 @import url("../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick.css");
61 <body id="www-imagemagick-org">
62 <div class="titlebar">
63 <div style="margin: 17px auto; float: left;">
64 <script type="text/javascript">
66 google_ad_client = "pub-3129977114552745";
67 google_ad_slot = "5439289906";
68 google_ad_width = 728;
69 google_ad_height = 90;
72 <script type="text/javascript"
73 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
76 <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../discourse-server">
77 <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/logo.jpg"
78 alt="ImageMagick Logo"
79 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
80 <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../index.html">
81 <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/sprite.jpg"
82 alt="ImageMagick Sprite"
83 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
89 <a title="About ImageMagick" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../index.html">About ImageMagick</a>
92 <a title="Binary Releases" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html">Binary Releases</a>
95 <a title="Binary Release: Unix" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#unix">Unix</a>
98 <a title="Binary Release: MacOS X" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#macosx">Mac OS X</a>
101 <a title="Binary Release: iOS" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#iOS">iOS</a>
104 <a title="Binary Release: Windows" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#windows">Windows</a>
106 <div class="sep"></div>
108 <a title="Command-line Tools" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-tools.html">Command-line Tools</a>
111 <a title="Command-line Tools: Processing" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-processing.html">Processing</a>
114 <a title="Command-line Tools: Options" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-options.html">Options</a>
117 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
120 <a title="Program Interfaces" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/api.html">Program Interfaces</a>
123 <a title="Program Interface: MagickWand" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick-wand.html">MagickWand</a>
126 <a title="Program Interface: MagickCore" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick-core.html">MagickCore</a>
129 <a title="Program Interface: PerlMagick" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/perl-magick.html">PerlMagick</a>
132 <a title="Program Interface: Magick++" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick++.html">Magick++</a>
134 <div class="sep"></div>
136 <a title="Install from Source" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html">Install from Source</a>
139 <a title="Install from Source: Unix" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html#unix">Unix</a>
142 <a title="Install from Source: Windows" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html#windows">Windows</a>
145 <a title="Resources" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/resources.html">Resources</a>
148 <a title="Architecture" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/architecture.html">Architecture</a>
151 <a title="Download" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/download.html">Download</a>
153 <div class="sep"></div>
155 <a title="Search" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/search.html">Search</a>
157 <div class="sep"></div>
159 <a title="Site Map" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/sitemap.html">Site Map</a>
162 <a title="Site Map: Links" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/links.html">Links</a>
164 <div class="sep"></div>
166 <a rel="follow" title="Sponsors" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/sponsors.html">Sponsors:</a>
168 <a href="http://www.networkredux.com"> <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/networkredux.png" width="140" height="31" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
169 <a href="http://www.dinodirect.com/ipads-tablets/"> <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/dino-direct.jpg" width="140" height="90" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a><!-- 201208010120 mickey@163... -->
170 <div class="sponsbox">
171 <div class="sponsor">
172 <a rel="follow" title="Sponsor: The Fastest & Easiest Way to Find Images" href="http://www.graphicsfactory.com">The Fastest & Easiest Way to Find Images</a><!-- 201210010270 graphicsfac... -->
174 <div class="sponsor">
175 <a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201209010090 barsh@inter... -->
177 <div class="sponsor">
178 <a rel="follow" title="Werbebanner Werbeplane" href="http://www.allesbanner.de">Werbebanner Werbeplane</a><!-- 201212010450 info@druck... -->
180 <div class="sponsor">
181 <a rel="follow" title="Entertainment News & Photos" href="http://www.zimbio.com">Entertainment News & Photos</a><!-- 201211010540 bd@zimb... -->
183 <div class="sponsor">
184 <a rel="follow" title="Sponsor: LED24" href="http://led24.de/">LED24</a><!-- 201207010270 info@led24... -->
186 <div class="sponsor">
187 <a rel="follow" title="Sponsor: Best Website Hosting" href="http://www.top-cheap-web-hosting.com">Best Website Hosting</a><!-- 201304010090 eunge.liu-->
189 <div class="sponsor">
190 <a rel="follow" title="Android Tablet" href="http://www.dinodirect.com/ipads-tablets/">Android Tablet</a><!-- 201208010120 mickey@163... -->
192 <div class="sponsor">
193 <a rel="follow" title="Sponsor: Web Site Hosting" href="http://webhostinggeeks.com">Web Site Hosting</a><!-- 201302010900 funds@enmob... -->
195 <div class="sponsor">
196 <a rel="follow" title="Sponsor: Premium Quality Stock Photos" href="http://www.f1online.pro/en/">Premium Quality Stock Photos</a><!-- 2012080100540 ... -->
198 <div class="sponsor">
199 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
201 <div class="sponsor">
202 <a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
204 <div class="sponsor">
205 <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
207 <div class="sponsor">
208 <a rel="follow" title="Sponsor: Kaffeemaschinen reparatur" href="http://www.kaffeemaschinen-reparatur.de">Kaffeemaschinen reparatur</a><!-- 2012080100030 Temurbas atlas-multimedia-->
210 <div class="sponsor">
211 <a rel="follow" title="Sponsor: Fototapete - Tapetendruck" href="http://www.druck-expert.com/Fototapete-Tapetendruck,category,8830.html">Fototapete - Tapetendruck</a><!-- 2012100100155 info@druck-->
217 <div class="eastbar">
218 <div class="g-plusone" id="gplusone"></div>
219 <script type="text/javascript">
225 var po = document.createElement('script');
226 po.type = 'text/javascript'; po.async = true;
227 po.src = 'https://apis.google.com/js/plusone.js';
228 var script = document.getElementsByTagName('script')[0];
229 script.parentNode.insertBefore(po, script);
231 var gplusone = document.getElementById("gplusone");
232 gplusone.setAttribute("data-size","medium");
233 gplusone.setAttribute("data-count","false");
239 <h1>Module deprecate Methods</h1>
240 <p class="navigation-index">[<a href="deprecate.html#AcquireCacheViewIndexes">AcquireCacheViewIndexes</a> • <a href="deprecate.html#AcquireCacheViewPixels">AcquireCacheViewPixels</a> • <a href="deprecate.html#AcquireImagePixels">AcquireImagePixels</a> • <a href="deprecate.html#AcquireIndexes">AcquireIndexes</a> • <a href="deprecate.html#AcquireMemory">AcquireMemory</a> • <a href="deprecate.html#AcquireOneCacheViewPixel">AcquireOneCacheViewPixel</a> • <a href="deprecate.html#AcquireOneCacheViewVirtualPixel">AcquireOneCacheViewVirtualPixel</a> • <a href="deprecate.html#AcquireOneMagickPixel">AcquireOneMagickPixel</a> • <a href="deprecate.html#AcquireOnePixel">AcquireOnePixel</a> • <a href="deprecate.html#AcquireOneVirtualPixel">AcquireOneVirtualPixel</a> • <a href="deprecate.html#AcquirePixels">AcquirePixels</a> • <a href="deprecate.html#AffinityImage">AffinityImage</a> • <a href="deprecate.html#AffinityImages">AffinityImages</a> • <a href="deprecate.html#AllocateImage">AllocateImage</a> • <a href="deprecate.html#AllocateImageColormap">AllocateImageColormap</a> • <a href="deprecate.html#AllocateNextImage">AllocateNextImage</a> • <a href="deprecate.html#AllocateString">AllocateString</a> • <a href="deprecate.html#AverageImages">AverageImages</a> • <a href="deprecate.html#ChannelThresholdImage">ChannelThresholdImage</a> • <a href="deprecate.html#ClipPathImage">ClipPathImage</a> • <a href="deprecate.html#CloneImageAttributes">CloneImageAttributes</a> • <a href="deprecate.html#CloneMemory">CloneMemory</a> • <a href="deprecate.html#CloseCacheView">CloseCacheView</a> • <a href="deprecate.html#ColorFloodfill">ColorFloodfill</a> • <a href="deprecate.html#DeleteImageAttribute">DeleteImageAttribute</a> • <a href="deprecate.html#DeleteImageList">DeleteImageList</a> • <a href="deprecate.html#DeleteMagickRegistry">DeleteMagickRegistry</a> • <a href="deprecate.html#DescribeImage">DescribeImage</a> • <a href="deprecate.html#DestroyImageAttributes">DestroyImageAttributes</a> • <a href="deprecate.html#DestroyImages">DestroyImages</a> • <a href="deprecate.html#DestroyMagick">DestroyMagick</a> • <a href="deprecate.html#DispatchImage">DispatchImage</a> • <a href="deprecate.html#ExtractSubimageFromImageImage">ExtractSubimageFromImageImage</a> • <a href="deprecate.html#FlattenImages">FlattenImages</a> • <a href="deprecate.html#FormatImageAttribute">FormatImageAttribute</a> • <a href="deprecate.html#FormatMagickString">FormatMagickString</a> • <a href="deprecate.html#FormatString">FormatString</a> • <a href="deprecate.html#GetConfigureBlob">GetConfigureBlob</a> • <a href="deprecate.html#GetCacheView">GetCacheView</a> • <a href="deprecate.html#GetCacheViewIndexes">GetCacheViewIndexes</a> • <a href="deprecate.html#GetCacheViewPixels">GetCacheViewPixels</a> • <a href="deprecate.html#GetImageAttribute">GetImageAttribute</a> • <a href="deprecate.html#GetImageClippingPathAttribute">GetImageClippingPathAttribute</a> • <a href="deprecate.html#GetImageFromMagickRegistry">GetImageFromMagickRegistry</a> • <a href="deprecate.html#GetMagickRegistry">GetMagickRegistry</a> • <a href="deprecate.html#GetImageGeometry">GetImageGeometry</a> • <a href="deprecate.html#GetImageList">GetImageList</a> • <a href="deprecate.html#GetImageListIndex">GetImageListIndex</a> • <a href="deprecate.html#GetImageListSize">GetImageListSize</a> • <a href="deprecate.html#GetImagePixels">GetImagePixels</a> • <a href="deprecate.html#GetIndexes">GetIndexes</a> • <a href="deprecate.html#GetNextImage">GetNextImage</a> • <a href="deprecate.html#GetNextImageAttribute">GetNextImageAttribute</a> • <a href="deprecate.html#GetNumberScenes">GetNumberScenes</a> • <a href="deprecate.html#GetOnePixel">GetOnePixel</a> • <a href="deprecate.html#GetPixels">GetPixels</a> • <a href="deprecate.html#GetPreviousImage">GetPreviousImage</a> • <a href="deprecate.html#HSLTransform">HSLTransform</a> • <a href="deprecate.html#IdentityAffine">IdentityAffine</a> • <a href="deprecate.html#InitializeMagick">InitializeMagick</a> • <a href="deprecate.html#InterpolatePixelColor">InterpolatePixelColor</a> • <a href="deprecate.html#InterpretImageAttributes">InterpretImageAttributes</a> • <a href="deprecate.html#LevelImageColor">LevelImageColor</a> • <a href="deprecate.html#LiberateMemory">LiberateMemory</a> • <a href="deprecate.html#LiberateSemaphoreInfo">LiberateSemaphoreInfo</a> • <a href="deprecate.html#MagickIncarnate">MagickIncarnate</a> • <a href="deprecate.html#MagickMonitor">MagickMonitor</a> • <a href="deprecate.html#MapImage">MapImage</a> • <a href="deprecate.html#MapImages">MapImages</a> • <a href="deprecate.html#MatteFloodfill">MatteFloodfill</a> • <a href="deprecate.html#MaximumImages">MaximumImages</a> • <a href="deprecate.html#MinimumImages">MinimumImages</a> • <a href="deprecate.html#MedianFilterImage">MedianFilterImage</a> • <a href="deprecate.html#ModeImage">ModeImage</a> • <a href="deprecate.html#MosaicImages">MosaicImages</a> • <a href="deprecate.html#OpaqueImage">OpaqueImage</a> • <a href="deprecate.html#OpenCacheView">OpenCacheView</a> • <a href="deprecate.html#OpenMagickStream">OpenMagickStream</a> • <a href="deprecate.html#PaintFloodfill">PaintFloodfill</a> • <a href="deprecate.html#PaintOpaqueImage">PaintOpaqueImage</a> • <a href="deprecate.html#PaintTransparentImage">PaintTransparentImage</a> • <a href="deprecate.html#ParseSizeGeometry">ParseSizeGeometry</a> • <a href="deprecate.html#PopImageList">PopImageList</a> • <a href="deprecate.html#PopImagePixels">PopImagePixels</a> • <a href="deprecate.html#PostscriptGeometry">PostscriptGeometry</a> • <a href="deprecate.html#PushImageList">PushImageList</a> • <a href="deprecate.html#PushImagePixels">PushImagePixels</a> • <a href="deprecate.html#QuantizationError">QuantizationError</a> • <a href="deprecate.html#RandomChannelThresholdImage">RandomChannelThresholdImage</a> • <a href="deprecate.html#ReacquireMemory">ReacquireMemory</a> • <a href="deprecate.html#RecolorImage">RecolorImage</a> • <a href="deprecate.html#ReduceNoiseImage">ReduceNoiseImage</a> • <a href="deprecate.html#ResetImageAttributeIterator">ResetImageAttributeIterator</a> • <a href="deprecate.html#SetCacheViewPixels">SetCacheViewPixels</a> • <a href="deprecate.html#SetExceptionInfo">SetExceptionInfo</a> • <a href="deprecate.html#SetImage">SetImage</a> • <a href="deprecate.html#SetImageAttribute">SetImageAttribute</a> • <a href="deprecate.html#SetImageList">SetImageList</a> • <a href="deprecate.html#SetImagePixels">SetImagePixels</a> • <a href="deprecate.html#SetMagickRegistry">SetMagickRegistry</a> • <a href="deprecate.html#SetMonitorHandler">SetMonitorHandler</a> • <a href="deprecate.html#ShiftImageList">ShiftImageList</a> • <a href="deprecate.html#SpliceImageList">SpliceImageList</a> • <a href="deprecate.html#Strip">Strip</a> • <a href="deprecate.html#SyncCacheView">SyncCacheView</a> • <a href="deprecate.html#SyncCacheViewPixels">SyncCacheViewPixels</a> • <a href="deprecate.html#SyncImagePixels">SyncImagePixels</a> • <a href="deprecate.html#TemporaryFilename">TemporaryFilename</a> • <a href="deprecate.html#ThresholdImage">ThresholdImage</a> • <a href="deprecate.html#ThresholdImageChannel">ThresholdImageChannel</a> • <a href="deprecate.html#TransformHSL">TransformHSL</a> • <a href="deprecate.html#TranslateText">TranslateText</a> • <a href="deprecate.html#TransparentImage">TransparentImage</a> • <a href="deprecate.html#UnshiftImageList">UnshiftImageList</a> • <a href="deprecate.html#ZoomImage">ZoomImage</a>]</p>
242 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="AcquireCacheViewIndexes">AcquireCacheViewIndexes</a></h2>
243 <div class="doc-section">
245 <p>AcquireCacheViewIndexes() returns the indexes associated with the specified view.</p>
247 <p>Deprecated, replace with:</p>
250 GetCacheViewVirtualIndexQueue(cache_view);
253 <p>The format of the AcquireCacheViewIndexes method is:</p>
256 const IndexPacket *AcquireCacheViewIndexes(const CacheView *cache_view)
259 <p>A description of each parameter follows:</p>
262 <p>the cache view.</p>
265 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="AcquireCacheViewPixels">AcquireCacheViewPixels</a></h2>
266 <div class="doc-section">
268 <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>
270 <p>Deprecated, replace with:</p>
273 GetCacheViewVirtualPixels(cache_view,x,y,columns,rows,exception);
276 <p>The format of the AcquireCacheViewPixels method is:</p>
279 const PixelPacket *AcquireCacheViewPixels(const CacheView *cache_view,
280 const ssize_t x,const ssize_t y,const size_t columns,
281 const size_t rows,ExceptionInfo *exception)
284 <p>A description of each parameter follows:</p>
287 <p>the cache view.</p>
289 <h5>x,y,columns,rows</h5>
290 <p>These values define the perimeter of a region of pixels.</p>
293 <p>return any errors or warnings in this structure.</p>
296 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="AcquireImagePixels">AcquireImagePixels</a></h2>
297 <div class="doc-section">
299 <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>
301 <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>
303 <p>If you plan to modify the pixels, use GetAuthenticPixels() instead.</p>
305 <p>Note, the AcquireImagePixels() and GetAuthenticPixels() methods are not thread-safe. In a threaded environment, use GetCacheViewVirtualPixels() or GetCacheViewAuthenticPixels() instead.</p>
307 <p>Deprecated, replace with:</p>
310 GetVirtualPixels(image,x,y,columns,rows,exception);
313 <p>The format of the AcquireImagePixels() method is:</p>
316 const PixelPacket *AcquireImagePixels(const Image *image,const ssize_t x,
317 const ssize_t y,const size_t columns,const size_t rows,
318 ExceptionInfo *exception)
321 <p>A description of each parameter follows:</p>
326 <h5>x,y,columns,rows</h5>
327 <p>These values define the perimeter of a region of pixels.</p>
330 <p>return any errors or warnings in this structure.</p>
333 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="AcquireIndexes">AcquireIndexes</a></h2>
334 <div class="doc-section">
336 <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>
338 <p>Deprecated, replace with:</p>
341 GetVirtualIndexQueue(image);
344 <p>The format of the AcquireIndexes() method is:</p>
347 const IndexPacket *AcquireIndexes(const Image *image)
350 <p>A description of each parameter follows:</p>
353 <p>AcquireIndexes() returns the indexes associated with the last call to QueueAuthenticPixels() or GetVirtualPixels().</p>
359 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="AcquireMemory">AcquireMemory</a></h2>
360 <div class="doc-section">
362 <p>AcquireMemory() returns a pointer to a block of memory at least size bytes suitably aligned for any use.</p>
364 <p>The format of the AcquireMemory method is:</p>
367 void *AcquireMemory(const size_t size)
370 <p>A description of each parameter follows:</p>
373 <p>the size of the memory in bytes to allocate.</p>
376 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="AcquireOneCacheViewPixel">AcquireOneCacheViewPixel</a></h2>
377 <div class="doc-section">
379 <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>
381 <p>Deprecated, replace with:</p>
384 GetOneCacheViewVirtualPixel(cache_view,x,y,pixel,exception);
387 <p>The format of the AcquireOneCacheViewPixel method is:</p>
390 MagickBooleanType AcquireOneCacheViewPixel(const CacheView *cache_view,
391 const ssize_t x,const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
394 <p>A description of each parameter follows:</p>
397 <p>the cache view.</p>
400 <p>These values define the offset of the pixel.</p>
403 <p>return a pixel at the specified (x,y) location.</p>
406 <p>return any errors or warnings in this structure.</p>
409 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="AcquireOneCacheViewVirtualPixel">AcquireOneCacheViewVirtualPixel</a></h2>
410 <div class="doc-section">
412 <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>
414 <p>Deprecated, replace with:</p>
417 GetOneCacheViewVirtualMethodPixel(cache_view,virtual_pixel_method,
418 x,y,pixel,exception);
421 <p>The format of the AcquireOneCacheViewPixel method is:</p>
424 MagickBooleanType AcquireOneCacheViewVirtualPixel(
425 const CacheView *cache_view,
426 const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
427 const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
430 <p>A description of each parameter follows:</p>
433 <p>the cache view.</p>
435 <h5>virtual_pixel_method</h5>
436 <p>the virtual pixel method.</p>
439 <p>These values define the offset of the pixel.</p>
442 <p>return a pixel at the specified (x,y) location.</p>
445 <p>return any errors or warnings in this structure.</p>
448 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="AcquireOneMagickPixel">AcquireOneMagickPixel</a></h2>
449 <div class="doc-section">
451 <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>
453 <p>Deprecated, replace with:</p>
456 MagickPixelPacket pixel;
457 GetOneVirtualMagickPixel(image,x,y,&pixel,exception);
460 <p>The format of the AcquireOneMagickPixel() method is:</p>
463 MagickPixelPacket AcquireOneMagickPixel(const Image image,const ssize_t x,
464 const ssize_t y,ExceptionInfo exception)
467 <p>A description of each parameter follows:</p>
473 <p>These values define the location of the pixel to return.</p>
476 <p>return any errors or warnings in this structure.</p>
479 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="AcquireOnePixel">AcquireOnePixel</a></h2>
480 <div class="doc-section">
482 <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>
484 <p>Deprecated, replace with:</p>
488 GetOneVirtualPixel(image,x,y,&pixel,exception);
491 <p>The format of the AcquireOnePixel() method is:</p>
494 PixelPacket AcquireOnePixel(const Image image,const ssize_t x,
495 const ssize_t y,ExceptionInfo exception)
498 <p>A description of each parameter follows:</p>
504 <p>These values define the location of the pixel to return.</p>
507 <p>return any errors or warnings in this structure.</p>
510 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="AcquireOneVirtualPixel">AcquireOneVirtualPixel</a></h2>
511 <div class="doc-section">
513 <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>
515 <p>Deprecated, replace with:</p>
519 GetOneVirtualMethodPixel(image,virtual_pixel_method,x,y,&pixel,exception);
522 <p>The format of the AcquireOneVirtualPixel() method is:</p>
525 PixelPacket AcquireOneVirtualPixel(const Image image,
526 const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
527 const ssize_t y,ExceptionInfo exception)
530 <p>A description of each parameter follows:</p>
532 <h5>virtual_pixel_method</h5>
533 <p>the virtual pixel method.</p>
539 <p>These values define the location of the pixel to return.</p>
542 <p>return any errors or warnings in this structure.</p>
545 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="AcquirePixels">AcquirePixels</a></h2>
546 <div class="doc-section">
548 <p>AcquirePixels() returns the pixels associated with the last call to QueueAuthenticPixels() or GetVirtualPixels().</p>
550 <p>Deprecated, replace with:</p>
553 GetVirtualPixelQueue(image);
556 <p>The format of the AcquirePixels() method is:</p>
559 const PixelPacket *AcquirePixels(const Image image)
562 <p>A description of each parameter follows:</p>
568 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="AffinityImage">AffinityImage</a></h2>
569 <div class="doc-section">
571 <p>AffinityImage() replaces the colors of an image with the closest color from a reference image.</p>
573 <p>Deprecated, replace with:</p>
576 RemapImage(quantize_info,image,affinity_image);
579 <p>The format of the AffinityImage method is:</p>
582 MagickBooleanType AffinityImage(const QuantizeInfo *quantize_info,
583 Image *image,const Image *affinity_image)
586 <p>A description of each parameter follows:</p>
588 <h5>quantize_info</h5>
589 <p>Specifies a pointer to an QuantizeInfo structure.</p>
594 <h5>affinity_image</h5>
595 <p>the reference image.</p>
598 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="AffinityImages">AffinityImages</a></h2>
599 <div class="doc-section">
601 <p>AffinityImages() replaces the colors of a sequence of images with the closest color from a reference image.</p>
603 <p>Deprecated, replace with:</p>
606 RemapImages(quantize_info,images,affinity_image);
609 <p>The format of the AffinityImage method is:</p>
612 MagickBooleanType AffinityImages(const QuantizeInfo *quantize_info,
613 Image *images,Image *affinity_image)
616 <p>A description of each parameter follows:</p>
618 <h5>quantize_info</h5>
619 <p>Specifies a pointer to an QuantizeInfo structure.</p>
622 <p>the image sequence.</p>
624 <h5>affinity_image</h5>
625 <p>the reference image.</p>
628 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="AllocateImage">AllocateImage</a></h2>
629 <div class="doc-section">
631 <p>AllocateImage() returns a pointer to an image structure initialized to default values.</p>
633 <p>Deprecated, replace with:</p>
636 AcquireImage(image_info);
639 <p>The format of the AllocateImage method is:</p>
642 Image *AllocateImage(const ImageInfo *image_info)
645 <p>A description of each parameter follows:</p>
648 <p>Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others.</p>
651 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="AllocateImageColormap">AllocateImageColormap</a></h2>
652 <div class="doc-section">
654 <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>
656 <p>Deprecated, replace with:</p>
659 AcquireImageColormap(image,colors);
662 <p>The format of the AllocateImageColormap method is:</p>
665 MagickBooleanType AllocateImageColormap(Image *image,
669 <p>A description of each parameter follows:</p>
675 <p>the number of colors in the image colormap.</p>
678 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="AllocateNextImage">AllocateNextImage</a></h2>
679 <div class="doc-section">
681 <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>
683 <p>Deprecated, replace with:</p>
686 AcquireNextImage(image_info,image);
689 <p>The format of the AllocateNextImage method is:</p>
692 void AllocateNextImage(const ImageInfo *image_info,Image *image)
695 <p>A description of each parameter follows:</p>
698 <p>Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others.</p>
704 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="AllocateString">AllocateString</a></h2>
705 <div class="doc-section">
707 <p>AllocateString() allocates memory for a string and copies the source string to that memory location (and returns it).</p>
709 <p>The format of the AllocateString method is:</p>
712 char *AllocateString(const char *source)
715 <p>A description of each parameter follows:</p>
718 <p>A character string.</p>
721 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="AverageImages">AverageImages</a></h2>
722 <div class="doc-section">
724 <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>
726 <p>Deprecated, replace with:</p>
729 EvaluateImages(images,MeanEvaluateOperator,exception);
732 <p>The format of the AverageImages method is:</p>
735 Image *AverageImages(Image *images,ExceptionInfo *exception)
738 <p>A description of each parameter follows:</p>
741 <p>the image sequence.</p>
744 <p>return any errors or warnings in this structure.</p>
747 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="ChannelThresholdImage">ChannelThresholdImage</a></h2>
748 <div class="doc-section">
750 <p>ChannelThresholdImage() changes the value of individual pixels based on the intensity of each pixel channel. The result is a high-contrast image.</p>
752 <p>The format of the ChannelThresholdImage method is:</p>
755 unsigned int ChannelThresholdImage(Image *image,const char *level)
758 <p>A description of each parameter follows:</p>
764 <p>define the threshold values.</p>
767 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="ClipPathImage">ClipPathImage</a></h2>
768 <div class="doc-section">
770 <p>ClipPathImage() sets the image clip mask based any clipping path information if it exists.</p>
772 <p>Deprecated, replace with:</p>
775 ClipImagePath(image,pathname,inside);
778 <p>The format of the ClipImage method is:</p>
781 MagickBooleanType ClipPathImage(Image *image,const char *pathname,
782 const MagickBooleanType inside)
785 <p>A description of each parameter follows:</p>
791 <p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p>
794 <p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p>
797 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="CloneImageAttributes">CloneImageAttributes</a></h2>
798 <div class="doc-section">
800 <p>CloneImageAttributes() clones one or more image attributes.</p>
802 <p>Deprecated, replace with:</p>
805 CloneImageProperties(image,clone_image);
808 <p>The format of the CloneImageAttributes method is:</p>
811 MagickBooleanType CloneImageAttributes(Image *image,
812 const Image *clone_image)
815 <p>A description of each parameter follows:</p>
821 <p>the clone image.</p>
824 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="CloneMemory">CloneMemory</a></h2>
825 <div class="doc-section">
827 <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>
829 <p>The format of the CloneMemory method is:</p>
832 void *CloneMemory(void *destination,const void *source,
836 <p>A description of each parameter follows:</p>
839 <p>the destination.</p>
845 <p>the size of the memory in bytes to allocate.</p>
848 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="CloseCacheView">CloseCacheView</a></h2>
849 <div class="doc-section">
851 <p>CloseCacheView() closes the specified view returned by a previous call to OpenCacheView().</p>
853 <p>Deprecated, replace with:</p>
856 DestroyCacheView(view_info);
859 <p>The format of the CloseCacheView method is:</p>
862 CacheView *CloseCacheView(CacheView *view_info)
865 <p>A description of each parameter follows:</p>
868 <p>the address of a structure of type CacheView.</p>
871 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="ColorFloodfill">ColorFloodfill</a></h2>
872 <div class="doc-section">
874 <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>
876 <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>
878 <p>The format of the ColorFloodfillImage method is:</p>
881 MagickBooleanType ColorFloodfillImage(Image *image,
882 const DrawInfo *draw_info,const PixelPacket target,
883 const ssize_t x_offset,const ssize_t y_offset,const PaintMethod method)
886 <p>A description of each parameter follows:</p>
892 <p>the draw info.</p>
895 <p>the RGB value of the target color.</p>
898 <p>the starting location of the operation.</p>
901 <p>Choose either FloodfillMethod or FillToBorderMethod.</p>
904 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="DeleteImageAttribute">DeleteImageAttribute</a></h2>
905 <div class="doc-section">
907 <p>DeleteImageAttribute() deletes an attribute from the image.</p>
909 <p>Deprecated, replace with:</p>
912 DeleteImageProperty(image,key);
915 <p>The format of the DeleteImageAttribute method is:</p>
918 MagickBooleanType DeleteImageAttribute(Image *image,const char *key)
921 <p>A description of each parameter follows:</p>
924 <p>the image info.</p>
927 <p>the image key.</p>
930 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="DeleteImageList">DeleteImageList</a></h2>
931 <div class="doc-section">
933 <p>DeleteImageList() deletes an image at the specified position in the list.</p>
935 <p>The format of the DeleteImageList method is:</p>
938 unsigned int DeleteImageList(Image *images,const ssize_t offset)
941 <p>A description of each parameter follows:</p>
944 <p>the image list.</p>
947 <p>the position within the list.</p>
950 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="DeleteMagickRegistry">DeleteMagickRegistry</a></h2>
951 <div class="doc-section">
953 <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>
955 <p>Deprecated, replace with:</p>
958 char key[MaxTextExtent];
959 FormatLocaleString(key,MaxTextExtent,"ld\n",id);
960 DeleteImageRegistry(key);
963 <p>The format of the DeleteMagickRegistry method is:</p>
966 MagickBooleanType DeleteMagickRegistry(const ssize_t id)
969 <p>A description of each parameter follows:</p>
972 <p>the registry id.</p>
975 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="DescribeImage">DescribeImage</a></h2>
976 <div class="doc-section">
978 <p>DescribeImage() describes an image by printing its attributes to the file. Attributes include the image width, height, size, and others.</p>
980 <p>Deprecated, replace with:</p>
983 IdentifyImage(image,file,verbose);
986 <p>The format of the DescribeImage method is:</p>
989 MagickBooleanType DescribeImage(Image *image,FILE *file,
990 const MagickBooleanType verbose)
993 <p>A description of each parameter follows:</p>
999 <p>the file, typically stdout.</p>
1002 <p>A value other than zero prints more detailed information about the image.</p>
1005 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="DestroyImageAttributes">DestroyImageAttributes</a></h2>
1006 <div class="doc-section">
1008 <p>DestroyImageAttributes() deallocates memory associated with the image attribute list.</p>
1010 <p>The format of the DestroyImageAttributes method is:</p>
1013 DestroyImageAttributes(Image *image)
1016 <p>A description of each parameter follows:</p>
1022 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="DestroyImages">DestroyImages</a></h2>
1023 <div class="doc-section">
1025 <p>DestroyImages() destroys an image list.</p>
1027 <p>Deprecated, replace with:</p>
1030 DestroyImageList(image);
1033 <p>The format of the DestroyImages method is:</p>
1036 void DestroyImages(Image *image)
1039 <p>A description of each parameter follows:</p>
1042 <p>the image sequence.</p>
1045 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="DestroyMagick">DestroyMagick</a></h2>
1046 <div class="doc-section">
1048 <p>DestroyMagick() destroys the ImageMagick environment.</p>
1050 <p>Deprecated, replace with:</p>
1053 MagickCoreTerminus();
1056 <p>The format of the DestroyMagick function is:</p>
1063 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="DispatchImage">DispatchImage</a></h2>
1064 <div class="doc-section">
1066 <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>
1068 <p>Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:</p>
1071 DispatchImage(image,0,0,640,1,"RGB",CharPixel,pixels,exception);
1074 <p>Deprecated, replace with:</p>
1077 ExportImagePixels(image,x_offset,y_offset,columns,rows,map,type,pixels,
1081 <p>The format of the DispatchImage method is:</p>
1084 unsigned int DispatchImage(const Image *image,const ssize_t x_offset,
1085 const ssize_t y_offset,const size_t columns,
1086 const size_t rows,const char *map,const StorageType type,
1087 void *pixels,ExceptionInfo *exception)
1090 <p>A description of each parameter follows:</p>
1095 <h5>x_offset, y_offset, columns, rows</h5>
1096 <p>These values define the perimeter of a region of pixels you want to extract.</p>
1099 <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>
1102 <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>
1105 <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>
1108 <p>return any errors or warnings in this structure.</p>
1111 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="ExtractSubimageFromImageImage">ExtractSubimageFromImageImage</a></h2>
1112 <div class="doc-section">
1114 <p>ExtractSubimageFromImageImage() extracts a region of the image that most closely resembles the reference.</p>
1116 <p>The format of the ExtractSubimageFromImageImage method is:</p>
1119 Image *ExtractSubimageFromImage(const Image *image,
1120 const Image *reference,ExceptionInfo *exception)
1123 <p>A description of each parameter follows:</p>
1129 <p>find an area of the image that closely resembles this image.</p>
1132 <p>return any errors or warnings in this structure.</p>
1135 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="FlattenImages">FlattenImages</a></h2>
1136 <div class="doc-section">
1138 <p>FlattenImages() Obsolete Function: Use MergeImageLayers() instead.</p>
1140 <p>Deprecated, replace with:</p>
1143 MergeImageLayers(image,FlattenLayer,exception);
1146 <p>The format of the FlattenImage method is:</p>
1149 Image *FlattenImage(Image *image,ExceptionInfo *exception)
1152 <p>A description of each parameter follows:</p>
1155 <p>the image sequence.</p>
1158 <p>return any errors or warnings in this structure.</p>
1161 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="FormatImageAttribute">FormatImageAttribute</a></h2>
1162 <div class="doc-section">
1164 <p>FormatImageAttribute() permits formatted key/value pairs to be saved as an image attribute.</p>
1166 <p>The format of the FormatImageAttribute method is:</p>
1169 MagickBooleanType FormatImageAttribute(Image *image,const char *key,
1170 const char *format,...)
1173 <p>A description of each parameter follows.</p>
1179 <p>The attribute key.</p>
1182 <p>A string describing the format to use to write the remaining arguments.</p>
1185 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="FormatMagickString">FormatMagickString</a></h2>
1186 <div class="doc-section">
1188 <p>FormatMagickString() prints formatted output of a variable argument list.</p>
1190 <p>The format of the FormatMagickString method is:</p>
1193 ssize_t FormatMagickString(char *string,const size_t length,
1194 const char *format,...)
1197 <p>A description of each parameter follows.</p>
1200 <p>FormatMagickString() returns the formatted string in this character buffer.</p>
1203 <p>the maximum length of the string.</p>
1206 <p>A string describing the format to use to write the remaining arguments.</p>
1209 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="FormatString">FormatString</a></h2>
1210 <div class="doc-section">
1212 <p>FormatString() prints formatted output of a variable argument list.</p>
1214 <p>The format of the FormatString method is:</p>
1217 void FormatString(char *string,const char *format,...)
1220 <p>A description of each parameter follows.</p>
1223 <p>Method FormatString returns the formatted string in this character buffer.</p>
1226 <p>A string describing the format to use to write the remaining arguments.</p>
1229 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="GetConfigureBlob">GetConfigureBlob</a></h2>
1230 <div class="doc-section">
1232 <p>GetConfigureBlob() returns the specified configure file as a blob.</p>
1234 <p>The format of the GetConfigureBlob method is:</p>
1237 void *GetConfigureBlob(const char *filename,ExceptionInfo *exception)
1240 <p>A description of each parameter follows:</p>
1243 <p>the configure file name.</p>
1246 <p>return the full path information of the configure file.</p>
1249 <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>
1252 <p>return any errors or warnings in this structure.</p>
1255 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="GetCacheView">GetCacheView</a></h2>
1256 <div class="doc-section">
1258 <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>
1260 <p>Deprecated, replace with:</p>
1263 GetCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
1264 GetCacheViewException(cache_view));
1267 <p>The format of the GetCacheView method is:</p>
1270 PixelPacket *GetCacheView(CacheView *cache_view,const ssize_t x,
1271 const ssize_t y,const size_t columns,const size_t rows)
1274 <p>A description of each parameter follows:</p>
1277 <p>the address of a structure of type CacheView.</p>
1279 <h5>x,y,columns,rows</h5>
1280 <p>These values define the perimeter of a region of pixels.</p>
1283 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="GetCacheViewIndexes">GetCacheViewIndexes</a></h2>
1284 <div class="doc-section">
1286 <p>GetCacheViewIndexes() returns the indexes associated with the specified view.</p>
1288 <p>Deprecated, replace with:</p>
1291 GetCacheViewAuthenticIndexQueue(cache_view);
1294 <p>The format of the GetCacheViewIndexes method is:</p>
1297 IndexPacket *GetCacheViewIndexes(CacheView *cache_view)
1300 <p>A description of each parameter follows:</p>
1303 <p>the cache view.</p>
1306 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="GetCacheViewPixels">GetCacheViewPixels</a></h2>
1307 <div class="doc-section">
1309 <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>
1311 <p>Deprecated, replace with:</p>
1314 GetCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
1315 GetCacheViewException(cache_view));
1318 <p>The format of the GetCacheViewPixels method is:</p>
1321 PixelPacket *GetCacheViewPixels(CacheView *cache_view,const ssize_t x,
1322 const ssize_t y,const size_t columns,const size_t rows)
1325 <p>A description of each parameter follows:</p>
1328 <p>the cache view.</p>
1330 <h5>x,y,columns,rows</h5>
1331 <p>These values define the perimeter of a region of pixels.</p>
1334 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="GetImageAttribute">GetImageAttribute</a></h2>
1335 <div class="doc-section">
1337 <p>GetImageAttribute() searches the list of image attributes and returns a pointer to the attribute if it exists otherwise NULL.</p>
1339 <p>The format of the GetImageAttribute method is:</p>
1342 const ImageAttribute *GetImageAttribute(const Image *image,
1346 <p>A description of each parameter follows:</p>
1352 <p>These character strings are the name of an image attribute to return.</p>
1355 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="GetImageClippingPathAttribute">GetImageClippingPathAttribute</a></h2>
1356 <div class="doc-section">
1358 <p>GetImageClippingPathAttribute() searches the list of image attributes and returns a pointer to a clipping path if it exists otherwise NULL.</p>
1360 <p>Deprecated, replace with:</p>
1363 GetImageAttribute(image,"8BIM:1999,2998");
1366 <p>The format of the GetImageClippingPathAttribute method is:</p>
1369 const ImageAttribute *GetImageClippingPathAttribute(Image *image)
1372 <p>A description of each parameter follows:</p>
1375 <p>Method GetImageClippingPathAttribute returns the clipping path if it exists otherwise NULL.</p>
1381 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="GetImageFromMagickRegistry">GetImageFromMagickRegistry</a></h2>
1382 <div class="doc-section">
1384 <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>
1386 <p>Deprecated, replace with:</p>
1389 GetImageRegistry(ImageRegistryType,name,exception);
1392 <p>The format of the GetImageFromMagickRegistry method is:</p>
1395 Image *GetImageFromMagickRegistry(const char *name,ssize_t *id,
1396 ExceptionInfo *exception)
1399 <p>A description of each parameter follows:</p>
1402 <p>the name of the image to retrieve from the registry.</p>
1405 <p>the registry id.</p>
1408 <p>return any errors or warnings in this structure.</p>
1411 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="GetMagickRegistry">GetMagickRegistry</a></h2>
1412 <div class="doc-section">
1414 <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>
1416 <p>The format of the GetMagickRegistry method is:</p>
1419 const void *GetMagickRegistry(const ssize_t id,RegistryType *type,
1420 size_t *length,ExceptionInfo *exception)
1423 <p>A description of each parameter follows:</p>
1426 <p>the registry id.</p>
1429 <p>the registry type.</p>
1432 <p>the blob length in number of bytes.</p>
1435 <p>return any errors or warnings in this structure.</p>
1438 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="GetImageGeometry">GetImageGeometry</a></h2>
1439 <div class="doc-section">
1441 <p>GetImageGeometry() returns a region as defined by the geometry string with respect to the image and its gravity.</p>
1443 <p>Deprecated, replace with:</p>
1446 if (size_to_fit != MagickFalse)
1447 ParseRegionGeometry(image,geometry,region_info,&image->exception); else
1448 ParsePageGeometry(image,geometry,region_info,&image->exception);
1451 <p>The format of the GetImageGeometry method is:</p>
1454 int GetImageGeometry(Image *image,const char *geometry,
1455 const unsigned int size_to_fit,RectangeInfo *region_info)
1458 <p>A description of each parameter follows:</p>
1461 <p>Method GetImageGeometry returns a bitmask that indicates which of the four values were located in the geometry string.</p>
1464 <p>The geometry (e.g. 100x100+10+10).</p>
1466 <h5>size_to_fit</h5>
1467 <p>A value other than 0 means to scale the region so it fits within the specified width and height.</p>
1469 <h5>region_info</h5>
1470 <p>the region as defined by the geometry string with respect to the image and its gravity.</p>
1473 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="GetImageList">GetImageList</a></h2>
1474 <div class="doc-section">
1476 <p>GetImageList() returns an image at the specified position in the list.</p>
1478 <p>Deprecated, replace with:</p>
1481 CloneImage(GetImageFromList(images,(ssize_t) offset),0,0,MagickTrue,
1485 <p>The format of the GetImageList method is:</p>
1488 Image *GetImageList(const Image *images,const ssize_t offset,
1489 ExceptionInfo *exception)
1492 <p>A description of each parameter follows:</p>
1495 <p>the image list.</p>
1498 <p>the position within the list.</p>
1501 <p>return any errors or warnings in this structure.</p>
1504 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="GetImageListIndex">GetImageListIndex</a></h2>
1505 <div class="doc-section">
1507 <p>GetImageListIndex() returns the position in the list of the specified image.</p>
1509 <p>Deprecated, replace with:</p>
1512 GetImageIndexInList(images);
1515 <p>The format of the GetImageListIndex method is:</p>
1518 ssize_t GetImageListIndex(const Image *images)
1521 <p>A description of each parameter follows:</p>
1524 <p>the image list.</p>
1527 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="GetImageListSize">GetImageListSize</a></h2>
1528 <div class="doc-section">
1530 <p>GetImageListSize() returns the number of images in the list.</p>
1532 <p>Deprecated, replace with:</p>
1535 GetImageListLength(images);
1538 <p>The format of the GetImageListSize method is:</p>
1541 size_t GetImageListSize(const Image *images)
1544 <p>A description of each parameter follows:</p>
1547 <p>the image list.</p>
1550 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="GetImagePixels">GetImagePixels</a></h2>
1551 <div class="doc-section">
1553 <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>
1555 <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>
1557 <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>
1559 <p>Deprecated, replace with:</p>
1562 GetAuthenticPixels(image,x,y,columns,rows,&image->exception);
1565 <p>The format of the GetImagePixels() method is:</p>
1568 PixelPacket *GetImagePixels(Image *image,const ssize_t x,const ssize_t y,
1569 const size_t columns,const size_t rows)
1572 <p>A description of each parameter follows:</p>
1577 <h5>x,y,columns,rows</h5>
1578 <p>These values define the perimeter of a region of pixels.</p>
1581 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="GetIndexes">GetIndexes</a></h2>
1582 <div class="doc-section">
1584 <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>
1586 <p>Deprecated, replace with:</p>
1589 GetAuthenticIndexQueue(image);
1592 <p>The format of the GetIndexes() method is:</p>
1595 IndexPacket *GetIndexes(const Image *image)
1598 <p>A description of each parameter follows:</p>
1601 <p>GetIndexes() returns the indexes associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p>
1607 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="GetNextImage">GetNextImage</a></h2>
1608 <div class="doc-section">
1610 <p>GetNextImage() returns the next image in a list.</p>
1612 <p>Deprecated, replace with:</p>
1615 GetNextImageInList(images);
1618 <p>The format of the GetNextImage method is:</p>
1621 Image *GetNextImage(const Image *images)
1624 <p>A description of each parameter follows:</p>
1627 <p>the image list.</p>
1630 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="GetNextImageAttribute">GetNextImageAttribute</a></h2>
1631 <div class="doc-section">
1633 <p>GetNextImageAttribute() gets the next image attribute.</p>
1635 <p>Deprecated, replace with:</p>
1638 const char *property;
1639 property=GetNextImageProperty(image);
1640 if (property != (const char *) NULL)
1641 GetImageAttribute(image,property);
1644 <p>The format of the GetNextImageAttribute method is:</p>
1647 const ImageAttribute *GetNextImageAttribute(const Image *image)
1650 <p>A description of each parameter follows:</p>
1656 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="GetNumberScenes">GetNumberScenes</a></h2>
1657 <div class="doc-section">
1659 <p>GetNumberScenes() returns the number of images in the list.</p>
1661 <p>Deprecated, replace with:</p>
1664 GetImageListLength(image);
1667 <p>The format of the GetNumberScenes method is:</p>
1670 unsigned int GetNumberScenes(const Image *images)
1673 <p>A description of each parameter follows:</p>
1676 <p>the image list.</p>
1679 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="GetOnePixel">GetOnePixel</a></h2>
1680 <div class="doc-section">
1682 <p>GetOnePixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.</p>
1684 <p>Deprecated, replace with:</p>
1687 GetOneAuthenticPixel(image,x,y,&pixel,&image->exception);
1690 <p>The format of the GetOnePixel() method is:</p>
1693 PixelPacket GetOnePixel(const Image image,const ssize_t x,const ssize_t y)
1696 <p>A description of each parameter follows:</p>
1702 <p>These values define the location of the pixel to return.</p>
1705 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="GetPixels">GetPixels</a></h2>
1706 <div class="doc-section">
1708 <p>GetPixels() returns the pixels associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p>
1710 <p>Deprecated, replace with:</p>
1713 GetAuthenticPixelQueue(image);
1716 <p>The format of the GetPixels() method is:</p>
1719 PixelPacket *GetPixels(const Image image)
1722 <p>A description of each parameter follows:</p>
1725 <p>GetPixels() returns the pixels associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p>
1731 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="GetPreviousImage">GetPreviousImage</a></h2>
1732 <div class="doc-section">
1734 <p>GetPreviousImage() returns the previous image in a list.</p>
1736 <p>Deprecated, replace with:</p>
1739 GetPreviousImageInList(images));
1742 <p>The format of the GetPreviousImage method is:</p>
1745 Image *GetPreviousImage(const Image *images)
1748 <p>A description of each parameter follows:</p>
1751 <p>the image list.</p>
1754 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="HSLTransform">HSLTransform</a></h2>
1755 <div class="doc-section">
1757 <p>HSLTransform() converts a (hue, saturation, lightness) to a (red, green, blue) triple.</p>
1759 <p>The format of the HSLTransformImage method is:</p>
1762 void HSLTransform(const double hue,const double saturation,
1763 const double lightness,Quantum *red,Quantum *green,Quantum *blue)
1766 <p>A description of each parameter follows:</p>
1768 <h5>hue, saturation, lightness</h5>
1769 <p>A double value representing a component of the HSL color space.</p>
1771 <h5>red, green, blue</h5>
1772 <p>A pointer to a pixel component of type Quantum.</p>
1775 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="IdentityAffine">IdentityAffine</a></h2>
1776 <div class="doc-section">
1778 <p>IdentityAffine() initializes the affine transform to the identity matrix.</p>
1780 <p>The format of the IdentityAffine method is:</p>
1783 IdentityAffine(AffineMatrix *affine)
1786 <p>A description of each parameter follows:</p>
1789 <p>A pointer the affine transform of type AffineMatrix.</p>
1792 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="InitializeMagick">InitializeMagick</a></h2>
1793 <div class="doc-section">
1795 <p>InitializeMagick() initializes the ImageMagick environment.</p>
1797 <p>Deprecated, replace with:</p>
1800 MagickCoreGenesis(path,MagickFalse);
1803 <p>The format of the InitializeMagick function is:</p>
1806 InitializeMagick(const char *path)
1809 <p>A description of each parameter follows:</p>
1812 <p>the execution path of the current ImageMagick client.</p>
1815 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="InterpolatePixelColor">InterpolatePixelColor</a></h2>
1816 <div class="doc-section">
1818 <p>InterpolatePixelColor() applies bi-linear or tri-linear interpolation between a pixel and it's neighbors.</p>
1820 <p>The format of the InterpolatePixelColor method is:</p>
1823 MagickPixelPacket InterpolatePixelColor(const Image *image,
1824 CacheView *view_info,InterpolatePixelMethod method,const double x,
1825 const double y,ExceptionInfo *exception)
1828 <p>A description of each parameter follows:</p>
1834 <p>the image cache view.</p>
1837 <p>the type of pixel color interpolation.</p>
1840 <p>A double representing the current (x,y) position of the pixel.</p>
1843 <p>return any errors or warnings in this structure.</p>
1846 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="InterpretImageAttributes">InterpretImageAttributes</a></h2>
1847 <div class="doc-section">
1849 <p>InterpretImageAttributes() replaces any embedded formatting characters with the appropriate image attribute and returns the translated text.</p>
1851 <p>Deprecated, replace with:</p>
1854 InterpretImageProperties(image_info,image,embed_text);
1857 <p>The format of the InterpretImageAttributes method is:</p>
1860 char *InterpretImageAttributes(const ImageInfo *image_info,Image *image,
1861 const char *embed_text)
1864 <p>A description of each parameter follows:</p>
1867 <p>the image info.</p>
1873 <p>the address of a character string containing the embedded formatting characters.</p>
1876 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="LevelImageColor">LevelImageColor</a></h2>
1877 <div class="doc-section">
1879 <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 separately.</p>
1881 <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>
1883 <p>Deprecated, replace with:</p>
1886 LevelColorsImageChannel(image,channel,black_color,white_color,invert);
1889 <p>The format of the LevelImageColors method is:</p>
1892 MagickBooleanType LevelImageColors(Image *image,const ChannelType channel,
1893 const MagickPixelPacket *black_color,const MagickPixelPacket *white_color,
1894 const MagickBooleanType invert)
1897 <p>A description of each parameter follows:</p>
1905 <h5>black_color</h5>
1906 <p>The color to map black to/from</p>
1908 <h5>white_point</h5>
1909 <p>The color to map white to/from</p>
1912 <p>if true map the colors (levelize), rather than from (level)</p>
1915 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="LiberateMemory">LiberateMemory</a></h2>
1916 <div class="doc-section">
1918 <p>LiberateMemory() frees memory that has already been allocated, and NULL's the pointer to it.</p>
1920 <p>The format of the LiberateMemory method is:</p>
1923 void LiberateMemory(void **memory)
1926 <p>A description of each parameter follows:</p>
1929 <p>A pointer to a block of memory to free for reuse.</p>
1932 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="LiberateSemaphoreInfo">LiberateSemaphoreInfo</a></h2>
1933 <div class="doc-section">
1935 <p>LiberateSemaphoreInfo() relinquishes a semaphore.</p>
1937 <p>Deprecated, replace with:</p>
1940 UnlockSemaphoreInfo(*semaphore_info);
1943 <p>The format of the LiberateSemaphoreInfo method is:</p>
1946 LiberateSemaphoreInfo(void **semaphore_info)
1949 <p>A description of each parameter follows:</p>
1951 <h5>semaphore_info</h5>
1952 <p>Specifies a pointer to an SemaphoreInfo structure.</p>
1955 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="MagickIncarnate">MagickIncarnate</a></h2>
1956 <div class="doc-section">
1958 <p>MagickIncarnate() initializes the ImageMagick environment.</p>
1960 <p>Deprecated, replace with:</p>
1963 MagickCoreGenesis(path,MagickFalse);
1966 <p>The format of the MagickIncarnate function is:</p>
1969 MagickIncarnate(const char *path)
1972 <p>A description of each parameter follows:</p>
1975 <p>the execution path of the current ImageMagick client.</p>
1978 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="MagickMonitor">MagickMonitor</a></h2>
1979 <div class="doc-section">
1981 <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>
1983 <p>The format of the MagickMonitor method is:</p>
1986 MagickBooleanType MagickMonitor(const char *text,
1987 const MagickOffsetType offset,const MagickSizeType span,
1991 <p>A description of each parameter follows:</p>
1994 <p>the position relative to the span parameter which represents how much progress has been made toward completing a task.</p>
1997 <p>the span relative to completing a task.</p>
1999 <h5>client_data</h5>
2000 <p>the client data.</p>
2003 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="MapImage">MapImage</a></h2>
2004 <div class="doc-section">
2006 <p>MapImage() replaces the colors of an image with the closest color from a reference image.</p>
2008 <p>Deprecated, replace with:</p>
2011 QuantizeInfo quantize_info;
2012 GetQuantizeInfo(&quantize_info);
2013 quantize_info.dither=dither;
2014 RemapImage(&quantize_info,image,map_image);
2017 <p>The format of the MapImage method is:</p>
2020 MagickBooleanType MapImage(Image *image,const Image *map_image,
2021 const MagickBooleanType dither)
2024 <p>A description of each parameter follows:</p>
2027 <p>Specifies a pointer to an Image structure.</p>
2030 <p>the image. Reduce image to a set of colors represented by this image.</p>
2033 <p>Set this integer value to something other than zero to dither the mapped image.</p>
2036 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="MapImages">MapImages</a></h2>
2037 <div class="doc-section">
2039 <p>MapImages() replaces the colors of a sequence of images with the closest color from a reference image.</p>
2041 <p>Deprecated, replace with:</p>
2044 QuantizeInfo quantize_info;
2045 GetQuantizeInfo(&quantize_info);
2046 quantize_info.dither=dither;
2047 RemapImages(&quantize_info,images,map_image);
2050 <p>The format of the MapImage method is:</p>
2053 MagickBooleanType MapImages(Image *images,Image *map_image,
2054 const MagickBooleanType dither)
2057 <p>A description of each parameter follows:</p>
2060 <p>Specifies a pointer to a set of Image structures.</p>
2063 <p>the image. Reduce image to a set of colors represented by this image.</p>
2066 <p>Set this integer value to something other than zero to dither the quantized image.</p>
2069 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="MatteFloodfill">MatteFloodfill</a></h2>
2070 <div class="doc-section">
2072 <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>
2074 <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>
2076 <p>The format of the MatteFloodfillImage method is:</p>
2079 MagickBooleanType MatteFloodfillImage(Image *image,
2080 const PixelPacket target,const Quantum opacity,const ssize_t x_offset,
2081 const ssize_t y_offset,const PaintMethod method)
2084 <p>A description of each parameter follows:</p>
2090 <p>the RGB value of the target color.</p>
2093 <p>the level of transparency: 0 is fully opaque and QuantumRange is fully transparent.</p>
2096 <p>the starting location of the operation.</p>
2099 <p>Choose either FloodfillMethod or FillToBorderMethod.</p>
2102 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="MaximumImages">MaximumImages</a></h2>
2103 <div class="doc-section">
2105 <p>MaximumImages() returns the maximum intensity of an image sequence.</p>
2107 <p>Deprecated, replace with:</p>
2110 EvaluateImages(images,MinEvaluateOperator,exception);
2113 <p>The format of the MaxImages method is:</p>
2116 Image *MaximumImages(Image *images,ExceptionInfo *exception)
2119 <p>A description of each parameter follows:</p>
2122 <p>the image sequence.</p>
2125 <p>return any errors or warnings in this structure.</p>
2128 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="MinimumImages">MinimumImages</a></h2>
2129 <div class="doc-section">
2131 <p>MinimumImages() returns the minimum intensity of an image sequence.</p>
2133 <p>Deprecated, replace with:</p>
2136 EvaluateImages(images,MinEvaluateOperator,exception);
2139 <p>The format of the MinimumImages method is:</p>
2142 Image *MinimumImages(Image *images,ExceptionInfo *exception)
2145 <p>A description of each parameter follows:</p>
2148 <p>the image sequence.</p>
2151 <p>return any errors or warnings in this structure.</p>
2154 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="MedianFilterImage">MedianFilterImage</a></h2>
2155 <div class="doc-section">
2157 <p>MedianFilterImage() applies a digital filter that improves the quality of a noisy image. Each pixel is replaced by the median in a set of neighboring pixels as defined by radius.</p>
2159 <p>The algorithm was contributed by Mike Edmonds and implements an insertion sort for selecting median color-channel values. For more on this algorithm see "Skip Lists: A probabilistic Alternative to Balanced Trees" by William Pugh in the June 1990 of Communications of the ACM.</p>
2161 <p>The format of the MedianFilterImage method is:</p>
2164 Image *MedianFilterImage(const Image *image,const double radius,
2165 ExceptionInfo *exception)
2168 <p>A description of each parameter follows:</p>
2174 <p>the radius of the pixel neighborhood.</p>
2177 <p>return any errors or warnings in this structure.</p>
2180 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="ModeImage">ModeImage</a></h2>
2181 <div class="doc-section">
2183 <p>ModeImage() makes each pixel the 'predominant color' of the neighborhood of the specified radius.</p>
2185 <p>The format of the ModeImage method is:</p>
2188 Image *ModeImage(const Image *image,const double radius,
2189 ExceptionInfo *exception)
2192 <p>A description of each parameter follows:</p>
2198 <p>the radius of the pixel neighborhood.</p>
2201 <p>return any errors or warnings in this structure.</p>
2204 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="MosaicImages">MosaicImages</a></h2>
2205 <div class="doc-section">
2207 <p>MosaicImages() Obsolete Function: Use MergeImageLayers() instead.</p>
2209 <p>Deprecated, replace with:</p>
2212 MergeImageLayers(image,MosaicLayer,exception);
2215 <p>The format of the MosaicImage method is:</p>
2218 Image *MosaicImages(const Image *image,ExceptionInfo *exception)
2221 <p>A description of each parameter follows:</p>
2224 <p>the image list to be composited together</p>
2227 <p>return any errors or warnings in this structure.</p>
2230 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="OpaqueImage">OpaqueImage</a></h2>
2231 <div class="doc-section">
2233 <p>OpaqueImage() changes any pixel that matches color with the color defined by fill.</p>
2235 <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>
2237 <p>The format of the OpaqueImage method is:</p>
2240 MagickBooleanType OpaqueImage(Image *image,
2241 const PixelPacket *target,const PixelPacket fill)
2244 <p>A description of each parameter follows:</p>
2250 <p>the RGB value of the target color.</p>
2253 <p>the replacement color.</p>
2256 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="OpenCacheView">OpenCacheView</a></h2>
2257 <div class="doc-section">
2259 <p>OpenCacheView() opens a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p>
2261 <p>Deprecated, replace with:</p>
2264 AcquireVirtualCacheView(image,&image->exception);
2267 <p>The format of the OpenCacheView method is:</p>
2270 CacheView *OpenCacheView(const Image *image)
2273 <p>A description of each parameter follows:</p>
2279 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="OpenMagickStream">OpenMagickStream</a></h2>
2280 <div class="doc-section">
2282 <p>OpenMagickStream() opens the file at the specified path and return the associated stream.</p>
2284 <p>The path of the OpenMagickStream method is:</p>
2287 FILE *OpenMagickStream(const char *path,const char *mode)
2290 <p>A description of each parameter follows.</p>
2293 <p>the file path.</p>
2296 <p>the file mode.</p>
2299 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="PaintFloodfill">PaintFloodfill</a></h2>
2300 <div class="doc-section">
2302 <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>
2304 <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>
2306 <p>Deprecated, replace with:</p>
2309 FloodfillPaintImage(image,channel,draw_info,target,x,y,
2310 method == FloodfillMethod ? MagickFalse : MagickTrue);
2313 <p>The format of the PaintFloodfillImage method is:</p>
2316 MagickBooleanType PaintFloodfillImage(Image *image,
2317 const ChannelType channel,const MagickPixelPacket target,
2318 const ssize_t x,const ssize_t y,const DrawInfo *draw_info,
2319 const PaintMethod method)
2322 <p>A description of each parameter follows:</p>
2328 <p>the channel(s).</p>
2331 <p>the RGB value of the target color.</p>
2334 <p>the starting location of the operation.</p>
2337 <p>the draw info.</p>
2340 <p>Choose either FloodfillMethod or FillToBorderMethod.</p>
2343 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="PaintOpaqueImage">PaintOpaqueImage</a></h2>
2344 <div class="doc-section">
2346 <p>PaintOpaqueImage() changes any pixel that matches color with the color defined by fill.</p>
2348 <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>
2350 <p>Deprecated, replace with:</p>
2353 OpaquePaintImageChannel(image,DefaultChannels,target,fill,MagickFalse);
2354 OpaquePaintImageChannel(image,channel,target,fill,MagickFalse);
2357 <p>The format of the PaintOpaqueImage method is:</p>
2360 MagickBooleanType PaintOpaqueImage(Image *image,
2361 const PixelPacket *target,const PixelPacket *fill)
2362 MagickBooleanType PaintOpaqueImageChannel(Image *image,
2363 const ChannelType channel,const PixelPacket *target,
2364 const PixelPacket *fill)
2367 <p>A description of each parameter follows:</p>
2373 <p>the channel(s).</p>
2376 <p>the RGB value of the target color.</p>
2379 <p>the replacement color.</p>
2382 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="PaintTransparentImage">PaintTransparentImage</a></h2>
2383 <div class="doc-section">
2385 <p>PaintTransparentImage() changes the opacity value associated with any pixel that matches color to the value defined by opacity.</p>
2387 <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>
2389 <p>Deprecated, replace with:</p>
2392 TransparentPaintImage(image,target,opacity,MagickFalse);
2395 <p>The format of the PaintTransparentImage method is:</p>
2398 MagickBooleanType PaintTransparentImage(Image *image,
2399 const MagickPixelPacket *target,const Quantum opacity)
2402 <p>A description of each parameter follows:</p>
2408 <p>the RGB value of the target color.</p>
2411 <p>the replacement opacity value.</p>
2414 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="ParseSizeGeometry">ParseSizeGeometry</a></h2>
2415 <div class="doc-section">
2417 <p>ParseSizeGeometry() returns a region as defined by the geometry string with respect to the image dimensions and aspect ratio.</p>
2419 <p>Deprecated, replace with:</p>
2422 ParseMetaGeometry(geometry,®ion_info->x,®ion_info->y,
2423 ®ion_info->width,®ion_info->height);
2426 <p>The format of the ParseSizeGeometry method is:</p>
2429 MagickStatusType ParseSizeGeometry(const Image *image,
2430 const char *geometry,RectangeInfo *region_info)
2433 <p>A description of each parameter follows:</p>
2436 <p>The geometry (e.g. 100x100+10+10).</p>
2438 <h5>region_info</h5>
2439 <p>the region as defined by the geometry string.</p>
2442 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="PopImageList">PopImageList</a></h2>
2443 <div class="doc-section">
2445 <p>PopImageList() removes the last image in the list.</p>
2447 <p>Deprecated, replace with:</p>
2450 RemoveLastImageFromList(images);
2453 <p>The format of the PopImageList method is:</p>
2456 Image *PopImageList(Image **images)
2459 <p>A description of each parameter follows:</p>
2462 <p>the image list.</p>
2465 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="PopImagePixels">PopImagePixels</a></h2>
2466 <div class="doc-section">
2468 <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>
2470 <p>The format of the PopImagePixels method is:</p>
2473 size_t PopImagePixels(Image *,const QuantumType quantum,
2474 unsigned char *destination)
2477 <p>A description of each parameter follows:</p>
2483 <p>Declare which pixel components to transfer (RGB, RGBA, etc).</p>
2485 <h5>destination</h5>
2486 <p>The components are transferred to this buffer.</p>
2489 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="PostscriptGeometry">PostscriptGeometry</a></h2>
2490 <div class="doc-section">
2492 <p>PostscriptGeometry() replaces any page mneumonic with the equivalent size in picas.</p>
2494 <p>Deprecated, replace with:</p>
2497 GetPageGeometry(page);
2500 <p>The format of the PostscriptGeometry method is:</p>
2503 char *PostscriptGeometry(const char *page)
2506 <p>A description of each parameter follows.</p>
2509 <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>
2512 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="PushImageList">PushImageList</a></h2>
2513 <div class="doc-section">
2515 <p>PushImageList() adds an image to the end of the list.</p>
2517 <p>Deprecated, replace with:</p>
2520 AppendImageToList(images,CloneImageList(image,exception));
2523 <p>The format of the PushImageList method is:</p>
2526 unsigned int PushImageList(Image *images,const Image *image,
2527 ExceptionInfo *exception)
2530 <p>A description of each parameter follows:</p>
2533 <p>the image list.</p>
2539 <p>return any errors or warnings in this structure.</p>
2542 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="PushImagePixels">PushImagePixels</a></h2>
2543 <div class="doc-section">
2545 <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>
2547 <p>The format of the PushImagePixels method is:</p>
2550 size_t PushImagePixels(Image *image,const QuantumType quantum,
2551 const unsigned char *source)
2554 <p>A description of each parameter follows:</p>
2560 <p>Declare which pixel components to transfer (red, green, blue, opacity, RGB, or RGBA).</p>
2563 <p>The pixel components are transferred from this buffer.</p>
2566 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="QuantizationError">QuantizationError</a></h2>
2567 <div class="doc-section">
2569 <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>
2572 o mean_error_per_pixel: This value is the mean error for any single
2576 <h5>normalized_mean_square_error</h5>
2577 <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>
2579 <h5>normalized_maximum_square_error</h5>
2580 <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>
2582 <p>Deprecated, replace with:</p>
2585 GetImageQuantizeError(image);
2588 <p>The format of the QuantizationError method is:</p>
2591 unsigned int QuantizationError(Image *image)
2594 <p>A description of each parameter follows.</p>
2597 <p>Specifies a pointer to an Image structure; returned from ReadImage.</p>
2600 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="RandomChannelThresholdImage">RandomChannelThresholdImage</a></h2>
2601 <div class="doc-section">
2603 <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>
2605 <p>The format of the RandomChannelThresholdImage method is:</p>
2608 unsigned int RandomChannelThresholdImage(Image *image,
2609 const char *channel, const char *thresholds,
2610 ExceptionInfo *exception)
2613 <p>A description of each parameter follows:</p>
2619 <p>the channel or channels to be thresholded.</p>
2622 <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>
2625 <p>return any errors or warnings in this structure.</p>
2628 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="ReacquireMemory">ReacquireMemory</a></h2>
2629 <div class="doc-section">
2631 <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>
2633 <p>The format of the ReacquireMemory method is:</p>
2636 void ReacquireMemory(void **memory,const size_t size)
2639 <p>A description of each parameter follows:</p>
2642 <p>A pointer to a memory allocation. On return the pointer may change but the contents of the original allocation will not.</p>
2645 <p>the new size of the allocated memory.</p>
2648 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="RecolorImage">RecolorImage</a></h2>
2649 <div class="doc-section">
2651 <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>
2653 <p>The format of the RecolorImage method is:</p>
2656 Image *RecolorImage(const Image *image,const size_t order,
2657 const double *color_matrix,ExceptionInfo *exception)
2660 <p>A description of each parameter follows:</p>
2666 <p>the number of columns and rows in the recolor matrix.</p>
2668 <h5>color_matrix</h5>
2669 <p>An array of double representing the recolor matrix.</p>
2672 <p>return any errors or warnings in this structure.</p>
2675 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="ReduceNoiseImage">ReduceNoiseImage</a></h2>
2676 <div class="doc-section">
2678 <p>ReduceNoiseImage() smooths the contours of an image while still preserving edge information. The algorithm works by replacing each pixel with its neighbor closest in value. A neighbor is defined by radius. Use a radius of 0 and ReduceNoise() selects a suitable radius for you.</p>
2680 <p>The format of the ReduceNoiseImage method is:</p>
2683 Image *ReduceNoiseImage(const Image *image,const double radius,
2684 ExceptionInfo *exception)
2687 <p>A description of each parameter follows:</p>
2693 <p>the radius of the pixel neighborhood.</p>
2696 <p>return any errors or warnings in this structure.</p>
2699 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="ResetImageAttributeIterator">ResetImageAttributeIterator</a></h2>
2700 <div class="doc-section">
2702 <p>ResetImageAttributeIterator() resets the image attributes iterator. Use it in conjunction with GetNextImageAttribute() to iterate over all the values associated with an image.</p>
2704 <p>Deprecated, replace with:</p>
2707 ResetImagePropertyIterator(image);
2710 <p>The format of the ResetImageAttributeIterator method is:</p>
2713 ResetImageAttributeIterator(const ImageInfo *image)
2716 <p>A description of each parameter follows:</p>
2722 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="SetCacheViewPixels">SetCacheViewPixels</a></h2>
2723 <div class="doc-section">
2725 <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>
2727 <p>Deprecated, replace with:</p>
2730 QueueCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
2731 GetCacheViewException(cache_view));
2734 <p>The format of the SetCacheViewPixels method is:</p>
2737 PixelPacket *SetCacheViewPixels(CacheView *cache_view,const ssize_t x,
2738 const ssize_t y,const size_t columns,const size_t rows)
2741 <p>A description of each parameter follows:</p>
2744 <p>the cache view.</p>
2746 <h5>x,y,columns,rows</h5>
2747 <p>These values define the perimeter of a region of pixels.</p>
2750 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="SetExceptionInfo">SetExceptionInfo</a></h2>
2751 <div class="doc-section">
2753 <p>SetExceptionInfo() sets the exception severity.</p>
2755 <p>The format of the SetExceptionInfo method is:</p>
2758 MagickBooleanType SetExceptionInfo(ExceptionInfo *exception,
2759 ExceptionType severity)
2762 <p>A description of each parameter follows:</p>
2765 <p>the exception info.</p>
2768 <p>the exception severity.</p>
2771 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="SetImage">SetImage</a></h2>
2772 <div class="doc-section">
2774 <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>
2776 <p>The format of the SetImage method is:</p>
2779 void SetImage(Image *image,const Quantum opacity)
2782 <p>A description of each parameter follows:</p>
2788 <p>Set each pixel to this level of transparency.</p>
2791 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="SetImageAttribute">SetImageAttribute</a></h2>
2792 <div class="doc-section">
2794 <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>
2796 <p>Deprecated, replace with:</p>
2799 SetImageProperty(image,key,value);
2802 <p>The format of the SetImageAttribute method is:</p>
2805 MagickBooleanType SetImageAttribute(Image *image,const char *key,
2809 <p>A description of each parameter follows:</p>
2821 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="SetImageList">SetImageList</a></h2>
2822 <div class="doc-section">
2824 <p>SetImageList() inserts an image into the list at the specified position.</p>
2826 <p>The format of the SetImageList method is:</p>
2829 unsigned int SetImageList(Image *images,const Image *image,
2830 const ssize_t offset,ExceptionInfo *exception)
2833 <p>A description of each parameter follows:</p>
2836 <p>the image list.</p>
2842 <p>the position within the list.</p>
2845 <p>return any errors or warnings in this structure.</p>
2848 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="SetImagePixels">SetImagePixels</a></h2>
2849 <div class="doc-section">
2851 <p>SetImagePixels() queues a mutable pixel region. If the region is successfully initialized 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>
2853 <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>
2855 <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>
2857 <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>
2859 <p>Deprecated, replace with:</p>
2862 QueueAuthenticPixels(image,x,y,columns,rows,&image->exception);
2865 <p>The format of the SetImagePixels() method is:</p>
2868 PixelPacket *SetImagePixels(Image *image,const ssize_t x,const ssize_t y,
2869 const size_t columns,const size_t rows)
2872 <p>A description of each parameter follows:</p>
2875 <p>SetImagePixels returns a pointer to the pixels if they are transferred, otherwise a NULL is returned.</p>
2880 <h5>x,y,columns,rows</h5>
2881 <p>These values define the perimeter of a region of pixels.</p>
2884 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="SetMagickRegistry">SetMagickRegistry</a></h2>
2885 <div class="doc-section">
2887 <p>SetMagickRegistry() sets a blob into the registry and returns a unique ID. If an error occurs, -1 is returned.</p>
2889 <p>The format of the SetMagickRegistry method is:</p>
2892 ssize_t SetMagickRegistry(const RegistryType type,const void *blob,
2893 const size_t length,ExceptionInfo *exception)
2896 <p>A description of each parameter follows:</p>
2899 <p>the registry type.</p>
2902 <p>the address of a Binary Large OBject.</p>
2905 <p>For a registry type of ImageRegistryType use sizeof(Image) otherise the blob length in number of bytes.</p>
2908 <p>return any errors or warnings in this structure.</p>
2911 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="SetMonitorHandler">SetMonitorHandler</a></h2>
2912 <div class="doc-section">
2914 <p>SetMonitorHandler() sets the monitor handler to the specified method and returns the previous monitor handler.</p>
2916 <p>The format of the SetMonitorHandler method is:</p>
2919 MonitorHandler SetMonitorHandler(MonitorHandler handler)
2922 <p>A description of each parameter follows:</p>
2925 <p>Specifies a pointer to a method to handle monitors.</p>
2928 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="ShiftImageList">ShiftImageList</a></h2>
2929 <div class="doc-section">
2931 <p>ShiftImageList() removes an image from the beginning of the list.</p>
2933 <p>Deprecated, replace with:</p>
2936 RemoveFirstImageFromList(images);
2939 <p>The format of the ShiftImageList method is:</p>
2942 Image *ShiftImageList(Image **images)
2945 <p>A description of each parameter follows:</p>
2948 <p>the image list.</p>
2951 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="SpliceImageList">SpliceImageList</a></h2>
2952 <div class="doc-section">
2954 <p>SpliceImageList() removes the images designated by offset and length from the list and replaces them with the specified list.</p>
2956 <p>The format of the SpliceImageList method is:</p>
2959 Image *SpliceImageList(Image *images,const ssize_t offset,
2960 const size_t length,const Image *splices,
2961 ExceptionInfo *exception)
2964 <p>A description of each parameter follows:</p>
2967 <p>the image list.</p>
2970 <p>the position within the list.</p>
2973 <p>the length of the image list to remove.</p>
2976 <p>Replace the removed image list with this list.</p>
2979 <p>return any errors or warnings in this structure.</p>
2982 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="Strip">Strip</a></h2>
2983 <div class="doc-section">
2985 <p>Strip() strips any whitespace or quotes from the beginning and end of a string of characters.</p>
2987 <p>The format of the Strip method is:</p>
2990 void Strip(char *message)
2993 <p>A description of each parameter follows:</p>
2996 <p>Specifies an array of characters.</p>
2999 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="SyncCacheView">SyncCacheView</a></h2>
3000 <div class="doc-section">
3002 <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>
3004 <p>Deprecated, replace with:</p>
3007 SyncCacheViewAuthenticPixels(cache_view,GetCacheViewException(cache_view));
3010 <p>The format of the SyncCacheView method is:</p>
3013 MagickBooleanType SyncCacheView(CacheView *cache_view)
3016 <p>A description of each parameter follows:</p>
3019 <p>the cache view.</p>
3022 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="SyncCacheViewPixels">SyncCacheViewPixels</a></h2>
3023 <div class="doc-section">
3025 <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>
3027 <p>Deprecated, replace with:</p>
3030 SyncCacheViewAuthenticPixels(cache_view,GetCacheViewException(cache_view));
3033 <p>The format of the SyncCacheViewPixels method is:</p>
3036 MagickBooleanType SyncCacheViewPixels(CacheView *cache_view)
3039 <p>A description of each parameter follows:</p>
3042 <p>the cache view.</p>
3045 <p>return any errors or warnings in this structure.</p>
3048 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="SyncImagePixels">SyncImagePixels</a></h2>
3049 <div class="doc-section">
3051 <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>
3053 <p>Deprecated, replace with:</p>
3056 SyncAuthenticPixels(image,&image->exception);
3059 <p>The format of the SyncImagePixels() method is:</p>
3062 MagickBooleanType SyncImagePixels(Image *image)
3065 <p>A description of each parameter follows:</p>
3071 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="TemporaryFilename">TemporaryFilename</a></h2>
3072 <div class="doc-section">
3074 <p>TemporaryFilename() replaces the contents of path by a unique path name.</p>
3076 <p>The format of the TemporaryFilename method is:</p>
3079 void TemporaryFilename(char *path)
3082 <p>A description of each parameter follows.</p>
3085 <p>Specifies a pointer to an array of characters. The unique path name is returned in this array.</p>
3088 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="ThresholdImage">ThresholdImage</a></h2>
3089 <div class="doc-section">
3091 <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>
3093 <p>The format of the ThresholdImage method is:</p>
3096 unsigned int ThresholdImage(Image *image,const double threshold)
3099 <p>A description of each parameter follows:</p>
3105 <p>Define the threshold value</p>
3108 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="ThresholdImageChannel">ThresholdImageChannel</a></h2>
3109 <div class="doc-section">
3111 <p>ThresholdImageChannel() changes the value of individual pixels based on the intensity of each pixel channel. The result is a high-contrast image.</p>
3113 <p>The format of the ThresholdImageChannel method is:</p>
3116 unsigned int ThresholdImageChannel(Image *image,const char *threshold)
3119 <p>A description of each parameter follows:</p>
3125 <p>define the threshold values.</p>
3128 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="TransformHSL">TransformHSL</a></h2>
3129 <div class="doc-section">
3131 <p>TransformHSL() converts a (red, green, blue) to a (hue, saturation, lightness) triple.</p>
3133 <p>The format of the TransformHSL method is:</p>
3136 void TransformHSL(const Quantum red,const Quantum green,
3137 const Quantum blue,double *hue,double *saturation,double *lightness)
3140 <p>A description of each parameter follows:</p>
3142 <h5>red, green, blue</h5>
3143 <p>A Quantum value representing the red, green, and blue component of a pixel..</p>
3145 <h5>hue, saturation, lightness</h5>
3146 <p>A pointer to a double value representing a component of the HSL color space.</p>
3149 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="TranslateText">TranslateText</a></h2>
3150 <div class="doc-section">
3152 <p>TranslateText() replaces any embedded formatting characters with the appropriate image attribute and returns the translated text.</p>
3154 <p>Deprecated, replace with:</p>
3157 InterpretImageProperties(image_info,image,embed_text);
3160 <p>The format of the TranslateText method is:</p>
3163 char *TranslateText(const ImageInfo *image_info,Image *image,
3164 const char *embed_text)
3167 <p>A description of each parameter follows:</p>
3170 <p>the image info.</p>
3176 <p>the address of a character string containing the embedded formatting characters.</p>
3179 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="TransparentImage">TransparentImage</a></h2>
3180 <div class="doc-section">
3182 <p>TransparentImage() changes the opacity value associated with any pixel that matches color to the value defined by opacity.</p>
3184 <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>
3186 <p>The format of the TransparentImage method is:</p>
3189 MagickBooleanType TransparentImage(Image *image,
3190 const PixelPacket target,const Quantum opacity)
3193 <p>A description of each parameter follows:</p>
3199 <p>the RGB value of the target color.</p>
3202 <p>the replacement opacity value.</p>
3205 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="UnshiftImageList">UnshiftImageList</a></h2>
3206 <div class="doc-section">
3208 <p>UnshiftImageList() adds the image to the beginning of the list.</p>
3210 <p>Deprecated, replace with:</p>
3213 PrependImageToList(images,CloneImageList(image,exception));
3216 <p>The format of the UnshiftImageList method is:</p>
3219 unsigned int UnshiftImageList(Image *images,const Image *image,
3220 ExceptionInfo *exception)
3223 <p>A description of each parameter follows:</p>
3226 <p>the image list.</p>
3232 <p>return any errors or warnings in this structure.</p>
3235 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate_8c.html" id="ZoomImage">ZoomImage</a></h2>
3236 <div class="doc-section">
3238 <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>
3240 <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>
3242 <p>The format of the ZoomImage method is:</p>
3245 Image *ZoomImage(const Image *image,const size_t columns,
3246 const size_t rows,ExceptionInfo *exception)
3249 <p>A description of each parameter follows:</p>
3255 <p>An integer that specifies the number of columns in the zoom image.</p>
3258 <p>An integer that specifies the number of rows in the scaled image.</p>
3261 <p>return any errors or warnings in this structure.</p>
3268 <span id="linkbar-west"> </span>
3269 <span id="linkbar-center">
3270 <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../discourse-server">Discourse Server</a> •
3271 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
3273 <span id="linkbar-east"> </span>
3275 <div class="footer">
3276 <span id="footer-west">© 1999-2013 ImageMagick Studio LLC</span>
3277 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
3279 <div style="clear: both; margin: 0; width: 100%; "></div>
3280 <script type="text/javascript">
3281 var _gaq = _gaq || [];
3282 _gaq.push(['_setAccount', 'UA-17690367-1']);
3283 _gaq.push(['_trackPageview']);
3286 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
3287 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
3288 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);