Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / ce66ab1f57d3f9b7192c74cd15912239071ba443 / . / www / api / deprecate.html
blob: 184f9cf34d500284a1cda28fab662a547307c959 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame]3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
7 <title>ImageMagick: MagickCore, C API for ImageMagick: Deprecated Methods</title/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]8 <meta http-equiv="Content-Language" content="en-US"/>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
10 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]11 <meta name="Application-name" content="ImageMagick"/>
12 <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves. ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems. The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
13 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]14 <meta name="Generator" content="PHP"/>
15 <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, deprecated, methods, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]16 <meta name="Rating" content="GENERAL"/>
17 <meta name="Robots" content="INDEX, FOLLOW"/>
18 <meta name="Generator" content="ImageMagick Studio LLC"/>
19 <meta name="Author" content="ImageMagick Studio LLC"/>
20 <meta name="Revisit-after" content="2 DAYS"/>
21 <meta name="Resource-type" content="document"/>
cristy16af1cb2009-12-11 21:38:29 +0000[diff] [blame]22 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]23 <meta name="Distribution" content="Global"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]24 <link rel="icon" href="../../images/wand.png" sizes="32x32"/>
25 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
27 <style type="text/css" media="all">
28 @import url("../../www/magick.css");
29 </style>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]30</head>
31
32<body id="www-imagemagick-org">
33<div class="titlebar">
34<a href="../../index.html">
35 <img src="../../images/script.png" alt="[ImageMagick]"
36 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
37<a href="http://www.networkredux.com">
38 <img src="../../images/networkredux.png" alt="[sponsor]"
39 style="margin: 45px auto; border: 0px; float: left;" /></a>
40<a href="http://www.imagemagick.org/discourse-server/">
41 <img src="../../images/logo.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43<a href="../../index.html">
44 <img src="../../images/sprite.jpg" alt=""
45 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
46</div>
47
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]48<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]49
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]50<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]51 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]52</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]53<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]54<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]55 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
56</div>
57<div class="sub">
58 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
59</div>
60<div class="sub">
61 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
62</div>
63<div class="sub">
64 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
65</div>
66<div class="sep"></div>
67<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]68 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]69</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]71 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]72</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]74 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]75</div>
76<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]77 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]78</div>
79<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]80 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]83 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]84</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]86 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]87</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]89 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]90</div>
91<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]92 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]93</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]94<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]95<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]96 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]97</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]99 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103 </div>
104<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]105 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]107<div class="menu">
108 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
109</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]110<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]111 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]112</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]113<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]115 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]116</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]117<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]118<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
121<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]122 <a title="Site Map: Links"href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]123</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]124<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]125<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]126 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]127
128<div class="sponsbox">
129<div class="sponsor">
cristyce66ab12010-10-21 23:36:32 +0000[diff] [blame^]130 <a title="Sponsor: alaTest.com" href="http://alatest.com">alaTest.com</a><!-- 20110801000300 -->
cristy73fd1cd2010-09-12 19:14:25 +0000[diff] [blame]131</div>
132<div class="sponsor">
cristy7d52cd62010-10-01 17:26:59 +0000[diff] [blame]133 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
134</div>
135<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]136 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
137</div>
138<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]139 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]142 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy031b7a82010-04-08 00:33:24 +0000[diff] [blame]143</div>
144<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]145 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]146</div>
147<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]148 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
cristy916e1922009-10-01 12:52:47 +0000[diff] [blame]149</div>
150<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]151 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]152</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]153</div>
154</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]155</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]156
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]157<div class="eastbar">
158 <script type="text/javascript">
159 <!--
160 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]161 google_ad_slot = "0574824969";
162 google_ad_width = 160;
163 google_ad_height = 600;
164 //-->
165 </script>
166 <script type="text/javascript"
167 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
168 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]169</div>
170
171<div class="main">
172
cristy73fd1cd2010-09-12 19:14:25 +0000[diff] [blame]173<p class="navigation-index">[<a href="#AcquireCacheViewIndexes">AcquireCacheViewIndexes</a> &bull; <a href="#AcquireCacheViewPixels">AcquireCacheViewPixels</a> &bull; <a href="#AcquireImagePixels">AcquireImagePixels</a> &bull; <a href="#AcquireIndexes">AcquireIndexes</a> &bull; <a href="#AcquireMemory">AcquireMemory</a> &bull; <a href="#AcquireOneCacheViewPixel">AcquireOneCacheViewPixel</a> &bull; <a href="#AcquireOneCacheViewVirtualPixel">AcquireOneCacheViewVirtualPixel</a> &bull; <a href="#AcquireOneMagickPixel">AcquireOneMagickPixel</a> &bull; <a href="#AcquireOnePixel">AcquireOnePixel</a> &bull; <a href="#AcquireOneVirtualPixel">AcquireOneVirtualPixel</a> &bull; <a href="#AcquirePixels">AcquirePixels</a> &bull; <a href="#AffinityImage">AffinityImage</a> &bull; <a href="#AffinityImages">AffinityImages</a> &bull; <a href="#AllocateImage">AllocateImage</a> &bull; <a href="#AllocateImageColormap">AllocateImageColormap</a> &bull; <a href="#AllocateNextImage">AllocateNextImage</a> &bull; <a href="#AllocateString">AllocateString</a> &bull; <a href="#AverageImages">AverageImages</a> &bull; <a href="#ChannelThresholdImage">ChannelThresholdImage</a> &bull; <a href="#ClipPathImage">ClipPathImage</a> &bull; <a href="#CloneImageAttributes">CloneImageAttributes</a> &bull; <a href="#CloneMemory">CloneMemory</a> &bull; <a href="#CloseCacheView">CloseCacheView</a> &bull; <a href="#ColorFloodfill">ColorFloodfill</a> &bull; <a href="#DeleteImageAttribute">DeleteImageAttribute</a> &bull; <a href="#DeleteImageList">DeleteImageList</a> &bull; <a href="#DeleteMagickRegistry">DeleteMagickRegistry</a> &bull; <a href="#DescribeImage">DescribeImage</a> &bull; <a href="#DestroyImageAttributes">DestroyImageAttributes</a> &bull; <a href="#DestroyImages">DestroyImages</a> &bull; <a href="#DestroyMagick">DestroyMagick</a> &bull; <a href="#DispatchImage">DispatchImage</a> &bull; <a href="#ExtractSubimageFromImageImage">ExtractSubimageFromImageImage</a> &bull; <a href="#FlattenImages">FlattenImages</a> &bull; <a href="#FormatImageAttribute">FormatImageAttribute</a> &bull; <a href="#FormatString">FormatString</a> &bull; <a href="#GetConfigureBlob">GetConfigureBlob</a> &bull; <a href="#GetCacheView">GetCacheView</a> &bull; <a href="#GetCacheViewIndexes">GetCacheViewIndexes</a> &bull; <a href="#GetCacheViewPixels">GetCacheViewPixels</a> &bull; <a href="#GetImageAttribute">GetImageAttribute</a> &bull; <a href="#GetImageClippingPathAttribute">GetImageClippingPathAttribute</a> &bull; <a href="#GetImageFromMagickRegistry">GetImageFromMagickRegistry</a> &bull; <a href="#GetMagickRegistry">GetMagickRegistry</a> &bull; <a href="#GetImageGeometry">GetImageGeometry</a> &bull; <a href="#GetImageList">GetImageList</a> &bull; <a href="#GetImageListIndex">GetImageListIndex</a> &bull; <a href="#GetImageListSize">GetImageListSize</a> &bull; <a href="#GetImagePixels">GetImagePixels</a> &bull; <a href="#GetIndexes">GetIndexes</a> &bull; <a href="#GetNextImage">GetNextImage</a> &bull; <a href="#GetNextImageAttribute">GetNextImageAttribute</a> &bull; <a href="#GetNumberScenes">GetNumberScenes</a> &bull; <a href="#GetOnePixel">GetOnePixel</a> &bull; <a href="#GetPixels">GetPixels</a> &bull; <a href="#GetPreviousImage">GetPreviousImage</a> &bull; <a href="#HSLTransform">HSLTransform</a> &bull; <a href="#IdentityAffine">IdentityAffine</a> &bull; <a href="#InitializeMagick">InitializeMagick</a> &bull; <a href="#InterpolatePixelColor">InterpolatePixelColor</a> &bull; <a href="#InterpretImageAttributes">InterpretImageAttributes</a> &bull; <a href="#LevelImageColor">LevelImageColor</a> &bull; <a href="#LiberateMemory">LiberateMemory</a> &bull; <a href="#LiberateSemaphoreInfo">LiberateSemaphoreInfo</a> &bull; <a href="#MagickIncarnate">MagickIncarnate</a> &bull; <a href="#MagickMonitor">MagickMonitor</a> &bull; <a href="#MapImage">MapImage</a> &bull; <a href="#MapImages">MapImages</a> &bull; <a href="#MatteFloodfill">MatteFloodfill</a> &bull; <a href="#MaximumImages">MaximumImages</a> &bull; <a href="#MinimumImages">MinimumImages</a> &bull; <a href="#MosaicImages">MosaicImages</a> &bull; <a href="#OpaqueImage">OpaqueImage</a> &bull; <a href="#OpenCacheView">OpenCacheView</a> &bull; <a href="#PaintFloodfill">PaintFloodfill</a> &bull; <a href="#PaintOpaqueImage">PaintOpaqueImage</a> &bull; <a href="#PaintTransparentImage">PaintTransparentImage</a> &bull; <a href="#ParseSizeGeometry">ParseSizeGeometry</a> &bull; <a href="#PopImageList">PopImageList</a> &bull; <a href="#PopImagePixels">PopImagePixels</a> &bull; <a href="#PostscriptGeometry">PostscriptGeometry</a> &bull; <a href="#PushImageList">PushImageList</a> &bull; <a href="#PushImagePixels">PushImagePixels</a> &bull; <a href="#QuantizationError">QuantizationError</a> &bull; <a href="#RandomChannelThresholdImage">RandomChannelThresholdImage</a> &bull; <a href="#ReacquireMemory">ReacquireMemory</a> &bull; <a href="#RecolorImage">RecolorImage</a> &bull; <a href="#ResetImageAttributeIterator">ResetImageAttributeIterator</a> &bull; <a href="#SetCacheViewPixels">SetCacheViewPixels</a> &bull; <a href="#SetExceptionInfo">SetExceptionInfo</a> &bull; <a href="#SetImage">SetImage</a> &bull; <a href="#SetImageAttribute">SetImageAttribute</a> &bull; <a href="#SetImageList">SetImageList</a> &bull; <a href="#SetImagePixels">SetImagePixels</a> &bull; <a href="#SetMagickRegistry">SetMagickRegistry</a> &bull; <a href="#SetMonitorHandler">SetMonitorHandler</a> &bull; <a href="#ShiftImageList">ShiftImageList</a> &bull; <a href="#SpliceImageList">SpliceImageList</a> &bull; <a href="#Strip">Strip</a> &bull; <a href="#SyncCacheView">SyncCacheView</a> &bull; <a href="#SyncCacheViewPixels">SyncCacheViewPixels</a> &bull; <a href="#SyncImagePixels">SyncImagePixels</a> &bull; <a href="#TemporaryFilename">TemporaryFilename</a> &bull; <a href="#ThresholdImage">ThresholdImage</a> &bull; <a href="#ThresholdImageChannel">ThresholdImageChannel</a> &bull; <a href="#TransformHSL">TransformHSL</a> &bull; <a href="#TranslateText">TranslateText</a> &bull; <a href="#TransparentImage">TransparentImage</a> &bull; <a href="#UnshiftImageList">UnshiftImageList</a> &bull; <a href="#ZoomImage">ZoomImage</a>]</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]174
175<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
176_8c.html" target="source" name="AcquireCacheViewIndexes">AcquireCacheViewIndexes</a></h2>
177<div class="doc-section">
178
179<p>AcquireCacheViewIndexes() returns the indexes associated with the specified view.</p></ol>
180
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]181<p>Deprecated, replace with:</p>
182
183<pre class="text">
184 GetCacheViewVirtualIndexQueue(cache_view);
185</pre>
186
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]187<p>The format of the AcquireCacheViewIndexes method is:</p>
188
189<pre class="code">
190 const IndexPacket *AcquireCacheViewIndexes(const CacheView *cache_view)
191</pre>
192
193<p>A description of each parameter follows:</p></ol>
194
195<h5>cache_view</h5>
196<ol><p>the cache view.</p></ol>
197
198 </div>
199<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
200_8c.html" target="source" name="AcquireCacheViewPixels">AcquireCacheViewPixels</a></h2>
201<div class="doc-section">
202
203<p>AcquireCacheViewPixels() gets pixels from the in-memory or disk pixel cache as defined by the geometry parameters. A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.</p></ol>
204
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]205<p>Deprecated, replace with:</p>
206
207<pre class="text">
208 GetCacheViewVirtualPixels(cache_view,x,y,columns,rows,exception);
209</pre>
210
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]211<p>The format of the AcquireCacheViewPixels method is:</p>
212
213<pre class="code">
214 const PixelPacket *AcquireCacheViewPixels(const CacheView *cache_view,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]215 const ssize_t x,const ssize_t y,const size_t columns,
216 const size_t rows,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]217</pre>
218
219<p>A description of each parameter follows:</p></ol>
220
221<h5>cache_view</h5>
222<ol><p>the cache view.</p></ol>
223
224<h5>x,y,columns,rows</h5>
225<ol><p>These values define the perimeter of a region of pixels.</p></ol>
226
227<h5>exception</h5>
228<ol><p>return any errors or warnings in this structure.</p></ol>
229
230 </div>
231<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
232_8c.html" target="source" name="AcquireImagePixels">AcquireImagePixels</a></h2>
233<div class="doc-section">
234
235<p>AcquireImagePixels() returns an immutable pixel region. If the region is successfully accessed, a pointer to it is returned, otherwise NULL is returned. The returned pointer may point to a temporary working copy of the pixels or it may point to the original pixels in memory. Performance is maximized if the selected region is part of one row, or one or more full rows, since there is opportunity to access the pixels in-place (without a copy) if the image is in RAM, or in a memory-mapped file. The returned pointer should *never* be deallocated by the user.</p></ol>
236
237<p>Pixels accessed via the returned pointer represent a simple array of type PixelPacket. If the image type is CMYK or the storage class is PseudoClass, call GetAuthenticIndexQueue() after invoking GetAuthenticPixels() to access the black color component or to obtain the colormap indexes (of type IndexPacket) corresponding to the region.</p></ol>
238
239<p>If you plan to modify the pixels, use GetAuthenticPixels() instead.</p></ol>
240
241<p>Note, the AcquireImagePixels() and GetAuthenticPixels() methods are not thread-safe. In a threaded environment, use GetCacheViewVirtualPixels() or GetCacheViewAuthenticPixels() instead.</p></ol>
242
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]243<p>Deprecated, replace with:</p>
244
245<pre class="text">
246 GetVirtualPixels(image,x,y,columns,rows,exception);
247</pre>
248
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]249<p>The format of the AcquireImagePixels() method is:</p>
250
251<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]252 const PixelPacket *AcquireImagePixels(const Image *image,const ssize_t x,
253 const ssize_t y,const size_t columns,const size_t rows,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]254 ExceptionInfo *exception)
255</pre>
256
257<p>A description of each parameter follows:</p></ol>
258
259<h5>image</h5>
260<ol><p>the image.</p></ol>
261
262<h5>x,y,columns,rows</h5>
263<ol><p>These values define the perimeter of a region of pixels.</p></ol>
264
265<h5>exception</h5>
266<ol><p>return any errors or warnings in this structure.</p></ol>
267
268 </div>
269<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
270_8c.html" target="source" name="AcquireIndexes">AcquireIndexes</a></h2>
271<div class="doc-section">
272
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]273<p>AcquireIndexes() returns the black channel or the colormap indexes associated with the last call to QueueAuthenticPixels() or GetVirtualPixels(). NULL is returned if the black channel or colormap indexes are not available.</p></ol>
274
275<p>Deprecated, replace with:</p>
276
277<pre class="text">
278 GetVirtualIndexQueue(image);
279</pre>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]280
281<p>The format of the AcquireIndexes() method is:</p>
282
283<pre class="code">
284 const IndexPacket *AcquireIndexes(const Image *image)
285</pre>
286
287<p>A description of each parameter follows:</p></ol>
288
289<h5>indexes</h5>
290<ol><p>AcquireIndexes() returns the indexes associated with the last call to QueueAuthenticPixels() or GetVirtualPixels().</p></ol>
291
292<h5>image</h5>
293<ol><p>the image.</p></ol>
294
295 </div>
296<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
297_8c.html" target="source" name="AcquireMemory">AcquireMemory</a></h2>
298<div class="doc-section">
299
300<p>AcquireMemory() returns a pointer to a block of memory at least size bytes suitably aligned for any use.</p></ol>
301
302<p>The format of the AcquireMemory method is:</p>
303
304<pre class="code">
305 void *AcquireMemory(const size_t size)
306</pre>
307
308<p>A description of each parameter follows:</p></ol>
309
310<h5>size</h5>
311<ol><p>the size of the memory in bytes to allocate.</p></ol>
312
313 </div>
314<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
315_8c.html" target="source" name="AcquireOneCacheViewPixel">AcquireOneCacheViewPixel</a></h2>
316<div class="doc-section">
317
318<p>AcquireOneCacheViewPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs. If you plan to modify the pixel, use GetOneCacheViewAuthenticPixel() instead.</p></ol>
319
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]320<p>Deprecated, replace with:</p>
321
322<pre class="text">
323 GetOneCacheViewVirtualPixel(cache_view,x,y,pixel,exception);
324</pre>
325
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]326<p>The format of the AcquireOneCacheViewPixel method is:</p>
327
328<pre class="code">
329 MagickBooleanType AcquireOneCacheViewPixel(const CacheView *cache_view,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]330 const ssize_t x,const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]331</pre>
332
333<p>A description of each parameter follows:</p></ol>
334
335<h5>cache_view</h5>
336<ol><p>the cache view.</p></ol>
337
338<h5>x,y</h5>
339<ol><p>These values define the offset of the pixel.</p></ol>
340
341<h5>pixel</h5>
342<ol><p>return a pixel at the specified (x,y) location.</p></ol>
343
344<h5>exception</h5>
345<ol><p>return any errors or warnings in this structure.</p></ol>
346
347 </div>
348<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
349_8c.html" target="source" name="AcquireOneCacheViewVirtualPixel">AcquireOneCacheViewVirtualPixel</a></h2>
350<div class="doc-section">
351
352<p>AcquireOneCacheViewVirtualPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs. If you plan to modify the pixel, use GetOneCacheViewAuthenticPixel() instead.</p></ol>
353
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]354<p>Deprecated, replace with:</p>
355
356<pre class="text">
357 GetOneCacheViewVirtualMethodPixel(cache_view,virtual_pixel_method,
358 x,y,pixel,exception);
359</pre>
360
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]361<p>The format of the AcquireOneCacheViewPixel method is:</p>
362
363<pre class="code">
364 MagickBooleanType AcquireOneCacheViewVirtualPixel(
365 const CacheView *cache_view,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]366 const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
367 const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]368</pre>
369
370<p>A description of each parameter follows:</p></ol>
371
372<h5>cache_view</h5>
373<ol><p>the cache view.</p></ol>
374
375<h5>virtual_pixel_method</h5>
376<ol><p>the virtual pixel method.</p></ol>
377
378<h5>x,y</h5>
379<ol><p>These values define the offset of the pixel.</p></ol>
380
381<h5>pixel</h5>
382<ol><p>return a pixel at the specified (x,y) location.</p></ol>
383
384<h5>exception</h5>
385<ol><p>return any errors or warnings in this structure.</p></ol>
386
387 </div>
388<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
389_8c.html" target="source" name="AcquireOneMagickPixel">AcquireOneMagickPixel</a></h2>
390<div class="doc-section">
391
392<p>AcquireOneMagickPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs. If you plan to modify the pixel, use GetOnePixel() instead.</p></ol>
393
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]394<p>Deprecated, replace with:</p>
395
396<pre class="text">
397 MagickPixelPacket pixel;
398 GetOneVirtualMagickPixel(image,x,y,&pixel,exception);
399</pre>
400
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]401<p>The format of the AcquireOneMagickPixel() method is:</p>
402
403<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]404 MagickPixelPacket AcquireOneMagickPixel(const Image image,const ssize_t x,
405 const ssize_t y,ExceptionInfo exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]406</pre>
407
408<p>A description of each parameter follows:</p></ol>
409
410<h5>image</h5>
411<ol><p>the image.</p></ol>
412
413<h5>x,y</h5>
414<ol><p>These values define the location of the pixel to return.</p></ol>
415
416<h5>exception</h5>
417<ol><p>return any errors or warnings in this structure.</p></ol>
418
419 </div>
420<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
421_8c.html" target="source" name="AcquireOnePixel">AcquireOnePixel</a></h2>
422<div class="doc-section">
423
424<p>AcquireOnePixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs. If you plan to modify the pixel, use GetOnePixel() instead.</p></ol>
425
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]426<p>Deprecated, replace with:</p>
427
428<pre class="text">
429 PixelPacket pixel;
430 GetOneVirtualPixel(image,x,y,&pixel,exception);
431</pre>
432
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]433<p>The format of the AcquireOnePixel() method is:</p>
434
435<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]436 PixelPacket AcquireOnePixel(const Image image,const ssize_t x,
437 const ssize_t y,ExceptionInfo exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]438</pre>
439
440<p>A description of each parameter follows:</p></ol>
441
442<h5>image</h5>
443<ol><p>the image.</p></ol>
444
445<h5>x,y</h5>
446<ol><p>These values define the location of the pixel to return.</p></ol>
447
448<h5>exception</h5>
449<ol><p>return any errors or warnings in this structure.</p></ol>
450
451 </div>
452<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
453_8c.html" target="source" name="AcquireOneVirtualPixel">AcquireOneVirtualPixel</a></h2>
454<div class="doc-section">
455
456<p>AcquireOneVirtualPixel() returns a single pixel at the specified (x,y) location as defined by specified pixel method. The image background color is returned if an error occurs. If you plan to modify the pixel, use GetOnePixel() instead.</p></ol>
457
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]458<p>Deprecated, replace with:</p>
459
460<pre class="text">
461 PixelPacket pixel;
462 GetOneVirtualMethodPixel(image,virtual_pixel_method,x,y,&pixel,exception);
463</pre>
464
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]465<p>The format of the AcquireOneVirtualPixel() method is:</p>
466
467<pre class="code">
468 PixelPacket AcquireOneVirtualPixel(const Image image,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]469 const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
470 const ssize_t y,ExceptionInfo exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]471</pre>
472
473<p>A description of each parameter follows:</p></ol>
474
475<h5>virtual_pixel_method</h5>
476<ol><p>the virtual pixel method.</p></ol>
477
478<h5>image</h5>
479<ol><p>the image.</p></ol>
480
481<h5>x,y</h5>
482<ol><p>These values define the location of the pixel to return.</p></ol>
483
484<h5>exception</h5>
485<ol><p>return any errors or warnings in this structure.</p></ol>
486
487 </div>
488<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
489_8c.html" target="source" name="AcquirePixels">AcquirePixels</a></h2>
490<div class="doc-section">
491
492<p>AcquirePixels() returns the pixels associated with the last call to QueueAuthenticPixels() or GetVirtualPixels().</p></ol>
493
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]494<p>Deprecated, replace with:</p>
495
496<pre class="text">
497 GetVirtualPixelQueue(image);
498</pre>
499
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]500<p>The format of the AcquirePixels() method is:</p>
501
502<pre class="code">
503 const PixelPacket *AcquirePixels(const Image image)
504</pre>
505
506<p>A description of each parameter follows:</p></ol>
507
508<h5>image</h5>
509<ol><p>the image.</p></ol>
510
511 </div>
512<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
513_8c.html" target="source" name="AffinityImage">AffinityImage</a></h2>
514<div class="doc-section">
515
516<p>AffinityImage() replaces the colors of an image with the closest color from a reference image.</p></ol>
517
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]518<p>Deprecated, replace with:</p>
519
520<pre class="text">
521 RemapImage(quantize_info,image,affinity_image);
522</pre>
523
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]524<p>The format of the AffinityImage method is:</p>
525
526<pre class="code">
527 MagickBooleanType AffinityImage(const QuantizeInfo *quantize_info,
528 Image *image,const Image *affinity_image)
529</pre>
530
531<p>A description of each parameter follows:</p></ol>
532
533<h5>quantize_info</h5>
534<ol><p>Specifies a pointer to an QuantizeInfo structure.</p></ol>
535
536<h5>image</h5>
537<ol><p>the image.</p></ol>
538
539<h5>affinity_image</h5>
540<ol><p>the reference image.</p></ol>
541
542 </div>
543<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
544_8c.html" target="source" name="AffinityImages">AffinityImages</a></h2>
545<div class="doc-section">
546
547<p>AffinityImages() replaces the colors of a sequence of images with the closest color from a reference image.</p></ol>
548
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]549<p>Deprecated, replace with:</p>
550
551<pre class="text">
552 RemapImages(quantize_info,images,affinity_image);
553</pre>
554
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]555<p>The format of the AffinityImage method is:</p>
556
557<pre class="code">
558 MagickBooleanType AffinityImages(const QuantizeInfo *quantize_info,
559 Image *images,Image *affinity_image)
560</pre>
561
562<p>A description of each parameter follows:</p></ol>
563
564<h5>quantize_info</h5>
565<ol><p>Specifies a pointer to an QuantizeInfo structure.</p></ol>
566
567<h5>images</h5>
568<ol><p>the image sequence.</p></ol>
569
570<h5>affinity_image</h5>
571<ol><p>the reference image.</p></ol>
572
573 </div>
574<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
575_8c.html" target="source" name="AllocateImage">AllocateImage</a></h2>
576<div class="doc-section">
577
578<p>AllocateImage() returns a pointer to an image structure initialized to default values.</p></ol>
579
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]580<p>Deprecated, replace with:</p>
581
582<pre class="text">
583 AcquireImage(image_info);
584</pre>
585
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]586<p>The format of the AllocateImage method is:</p>
587
588<pre class="code">
589 Image *AllocateImage(const ImageInfo *image_info)
590</pre>
591
592<p>A description of each parameter follows:</p></ol>
593
594<h5>image_info</h5>
595<ol><p>Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others.</p></ol>
596
597 </div>
598<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
599_8c.html" target="source" name="AllocateImageColormap">AllocateImageColormap</a></h2>
600<div class="doc-section">
601
602<p>AllocateImageColormap() allocates an image colormap and initializes it to a linear gray colorspace. If the image already has a colormap, it is replaced. AllocateImageColormap() returns MagickTrue if successful, otherwise MagickFalse if there is not enough memory.</p></ol>
603
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]604<p>Deprecated, replace with:</p>
605
606<pre class="text">
607 AcquireImageColormap(image,colors);
608</pre>
609
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]610<p>The format of the AllocateImageColormap method is:</p>
611
612<pre class="code">
613 MagickBooleanType AllocateImageColormap(Image *image,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]614 const size_t colors)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]615</pre>
616
617<p>A description of each parameter follows:</p></ol>
618
619<h5>image</h5>
620<ol><p>the image.</p></ol>
621
622<h5>colors</h5>
623<ol><p>the number of colors in the image colormap.</p></ol>
624
625 </div>
626<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
627_8c.html" target="source" name="AllocateNextImage">AllocateNextImage</a></h2>
628<div class="doc-section">
629
630<p>AllocateNextImage() initializes the next image in a sequence to default values. The next member of image points to the newly allocated image. If there is a memory shortage, next is assigned NULL.</p></ol>
631
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]632<p>Deprecated, replace with:</p>
633
634<pre class="text">
635 AcquireNextImage(image_info,image);
636</pre>
637
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]638<p>The format of the AllocateNextImage method is:</p>
639
640<pre class="code">
641 void AllocateNextImage(const ImageInfo *image_info,Image *image)
642</pre>
643
644<p>A description of each parameter follows:</p></ol>
645
646<h5>image_info</h5>
647<ol><p>Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others.</p></ol>
648
649<h5>image</h5>
650<ol><p>the image.</p></ol>
651
652 </div>
653<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
654_8c.html" target="source" name="AllocateString">AllocateString</a></h2>
655<div class="doc-section">
656
657<p>AllocateString() allocates memory for a string and copies the source string to that memory location (and returns it).</p></ol>
658
659<p>The format of the AllocateString method is:</p>
660
661<pre class="code">
662 char *AllocateString(const char *source)
663</pre>
664
665<p>A description of each parameter follows:</p></ol>
666
667<h5>source</h5>
668<ol><p>A character string.</p></ol>
669
670 </div>
671<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
cristy63fed272010-03-07 19:08:45 +0000[diff] [blame]672_8c.html" target="source" name="AverageImages">AverageImages</a></h2>
673<div class="doc-section">
674
675<p>AverageImages() takes a set of images and averages them together. Each image in the set must have the same width and height. AverageImages() returns a single image with each corresponding pixel component of each image averaged. On failure, a NULL image is returned and exception describes the reason for the failure.</p></ol>
676
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]677<p>Deprecated, replace with:</p>
678
679<pre class="text">
680 EvaluateImages(images,MeanEvaluateOperator,exception);
681</pre>
682
cristy63fed272010-03-07 19:08:45 +0000[diff] [blame]683<p>The format of the AverageImages method is:</p>
684
685<pre class="code">
686 Image *AverageImages(Image *images,ExceptionInfo *exception)
687</pre>
688
689<p>A description of each parameter follows:</p></ol>
690
691<h5>image</h5>
692<ol><p>the image sequence.</p></ol>
693
694<h5>exception</h5>
695<ol><p>return any errors or warnings in this structure.</p></ol>
696
697 </div>
698<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]699_8c.html" target="source" name="ChannelThresholdImage">ChannelThresholdImage</a></h2>
700<div class="doc-section">
701
702<p>ChannelThresholdImage() changes the value of individual pixels based on the intensity of each pixel channel. The result is a high-contrast image.</p></ol>
703
704<p>The format of the ChannelThresholdImage method is:</p>
705
706<pre class="code">
707 unsigned int ChannelThresholdImage(Image *image,const char *level)
708</pre>
709
710<p>A description of each parameter follows:</p></ol>
711
712<h5>image</h5>
713<ol><p>the image.</p></ol>
714
715<h5>level</h5>
716<ol><p>define the threshold values.</p></ol>
717
718 </div>
719<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
720_8c.html" target="source" name="ClipPathImage">ClipPathImage</a></h2>
721<div class="doc-section">
722
723<p>ClipPathImage() sets the image clip mask based any clipping path information if it exists.</p></ol>
724
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]725<p>Deprecated, replace with:</p>
726
727<pre class="text">
728 ClipImagePath(image,pathname,inside);
729</pre>
730
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]731<p>The format of the ClipImage method is:</p>
732
733<pre class="code">
734 MagickBooleanType ClipPathImage(Image *image,const char *pathname,
735 const MagickBooleanType inside)
736</pre>
737
738<p>A description of each parameter follows:</p></ol>
739
740<h5>image</h5>
741<ol><p>the image.</p></ol>
742
743<h5>pathname</h5>
744<ol><p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p></ol>
745
746<h5>inside</h5>
747<ol><p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p></ol>
748
749 </div>
750<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
751_8c.html" target="source" name="CloneImageAttributes">CloneImageAttributes</a></h2>
752<div class="doc-section">
753
754<p>CloneImageAttributes() clones one or more image attributes.</p></ol>
755
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]756<p>Deprecated, replace with:</p>
757
758<pre class="text">
759 CloneImageProperties(image,clone_image);
760</pre>
761
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]762<p>The format of the CloneImageAttributes method is:</p>
763
764<pre class="code">
765 MagickBooleanType CloneImageAttributes(Image *image,
766 const Image *clone_image)
767</pre>
768
769<p>A description of each parameter follows:</p></ol>
770
771<h5>image</h5>
772<ol><p>the image.</p></ol>
773
774<h5>clone_image</h5>
775<ol><p>the clone image.</p></ol>
776
777 </div>
778<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
779_8c.html" target="source" name="CloneMemory">CloneMemory</a></h2>
780<div class="doc-section">
781
782<p>CloneMemory() copies size bytes from memory area source to the destination. Copying between objects that overlap will take place correctly. It returns destination.</p></ol>
783
784<p>The format of the CloneMemory method is:</p>
785
786<pre class="code">
787 void *CloneMemory(void *destination,const void *source,
788 const size_t size)
789</pre>
790
791<p>A description of each parameter follows:</p></ol>
792
793<h5>destination</h5>
794<ol><p>the destination.</p></ol>
795
796<h5>source</h5>
797<ol><p>the source.</p></ol>
798
799<h5>size</h5>
800<ol><p>the size of the memory in bytes to allocate.</p></ol>
801
802 </div>
803<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
804_8c.html" target="source" name="CloseCacheView">CloseCacheView</a></h2>
805<div class="doc-section">
806
807<p>CloseCacheView() closes the specified view returned by a previous call to OpenCacheView().</p></ol>
808
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]809<p>Deprecated, replace with:</p>
810
811<pre class="text">
812 DestroyCacheView(view_info);
813</pre>
814
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]815<p>The format of the CloseCacheView method is:</p>
816
817<pre class="code">
818 CacheView *CloseCacheView(CacheView *view_info)
819</pre>
820
821<p>A description of each parameter follows:</p></ol>
822
823<h5>view_info</h5>
824<ol><p>the address of a structure of type CacheView.</p></ol>
825
826 </div>
827<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
828_8c.html" target="source" name="ColorFloodfill">ColorFloodfill</a></h2>
829<div class="doc-section">
830
831<p>ColorFloodfill() changes the color value of any pixel that matches target and is an immediate neighbor. If the method FillToBorderMethod is specified, the color value is changed for any neighbor pixel that does not match the bordercolor member of image.</p></ol>
832
833<p>By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.</p></ol>
834
835<p>The format of the ColorFloodfillImage method is:</p>
836
837<pre class="code">
838 MagickBooleanType ColorFloodfillImage(Image *image,
839 const DrawInfo *draw_info,const PixelPacket target,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]840 const ssize_t x_offset,const ssize_t y_offset,const PaintMethod method)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]841</pre>
842
843<p>A description of each parameter follows:</p></ol>
844
845<h5>image</h5>
846<ol><p>the image.</p></ol>
847
848<h5>draw_info</h5>
849<ol><p>the draw info.</p></ol>
850
851<h5>target</h5>
852<ol><p>the RGB value of the target color.</p></ol>
853
854<h5>x,y</h5>
855<ol><p>the starting location of the operation.</p></ol>
856
857<h5>method</h5>
858<ol><p>Choose either FloodfillMethod or FillToBorderMethod.</p></ol>
859
860 </div>
861<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
862_8c.html" target="source" name="DeleteImageAttribute">DeleteImageAttribute</a></h2>
863<div class="doc-section">
864
865<p>DeleteImageAttribute() deletes an attribute from the image.</p></ol>
866
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]867<p>Deprecated, replace with:</p>
868
869<pre class="text">
870 DeleteImageProperty(image,key);
871</pre>
872
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]873<p>The format of the DeleteImageAttribute method is:</p>
874
875<pre class="code">
876 MagickBooleanType DeleteImageAttribute(Image *image,const char *key)
877</pre>
878
879<p>A description of each parameter follows:</p></ol>
880
881<h5>image</h5>
882<ol><p>the image info.</p></ol>
883
884<h5>key</h5>
885<ol><p>the image key.</p></ol>
886
887 </div>
888<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
889_8c.html" target="source" name="DeleteImageList">DeleteImageList</a></h2>
890<div class="doc-section">
891
892<p>DeleteImageList() deletes an image at the specified position in the list.</p></ol>
893
894<p>The format of the DeleteImageList method is:</p>
895
896<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]897 unsigned int DeleteImageList(Image *images,const ssize_t offset)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]898</pre>
899
900<p>A description of each parameter follows:</p></ol>
901
902<h5>images</h5>
903<ol><p>the image list.</p></ol>
904
905<h5>offset</h5>
906<ol><p>the position within the list.</p></ol>
907
908 </div>
909<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
910_8c.html" target="source" name="DeleteMagickRegistry">DeleteMagickRegistry</a></h2>
911<div class="doc-section">
912
913<p>DeleteMagickRegistry() deletes an entry in the registry as defined by the id. It returns MagickTrue if the entry is deleted otherwise MagickFalse if no entry is found in the registry that matches the id.</p></ol>
914
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]915<p>Deprecated, replace with:</p>
916
917<pre class="text">
918 char key[MaxTextExtent];
919 FormatMagickString(key,MaxTextExtent,"ld\n",id);
920 DeleteImageRegistry(key);
921</pre>
922
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]923<p>The format of the DeleteMagickRegistry method is:</p>
924
925<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]926 MagickBooleanType DeleteMagickRegistry(const ssize_t id)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]927</pre>
928
929<p>A description of each parameter follows:</p></ol>
930
931<h5>id</h5>
932<ol><p>the registry id.</p></ol>
933
934 </div>
935<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
936_8c.html" target="source" name="DescribeImage">DescribeImage</a></h2>
937<div class="doc-section">
938
939<p>DescribeImage() describes an image by printing its attributes to the file. Attributes include the image width, height, size, and others.</p></ol>
940
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]941<p>Deprecated, replace with:</p>
942
943<pre class="text">
944 IdentifyImage(image,file,verbose);
945</pre>
946
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]947<p>The format of the DescribeImage method is:</p>
948
949<pre class="code">
950 MagickBooleanType DescribeImage(Image *image,FILE *file,
951 const MagickBooleanType verbose)
952</pre>
953
954<p>A description of each parameter follows:</p></ol>
955
956<h5>image</h5>
957<ol><p>the image.</p></ol>
958
959<h5>file</h5>
960<ol><p>the file, typically stdout.</p></ol>
961
962<h5>verbose</h5>
963<ol><p>A value other than zero prints more detailed information about the image.</p></ol>
964
965 </div>
966<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
967_8c.html" target="source" name="DestroyImageAttributes">DestroyImageAttributes</a></h2>
968<div class="doc-section">
969
970<p>DestroyImageAttributes() deallocates memory associated with the image attribute list.</p></ol>
971
972<p>The format of the DestroyImageAttributes method is:</p>
973
974<pre class="code">
975 DestroyImageAttributes(Image *image)
976</pre>
977
978<p>A description of each parameter follows:</p></ol>
979
980<h5>image</h5>
981<ol><p>the image.</p></ol>
982
983 </div>
984<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
985_8c.html" target="source" name="DestroyImages">DestroyImages</a></h2>
986<div class="doc-section">
987
988<p>DestroyImages() destroys an image list.</p></ol>
989
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]990<p>Deprecated, replace with:</p>
991
992<pre class="text">
993 DestroyImageList(image);
994</pre>
995
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]996<p>The format of the DestroyImages method is:</p>
997
998<pre class="code">
999 void DestroyImages(Image *image)
1000</pre>
1001
1002<p>A description of each parameter follows:</p></ol>
1003
1004<h5>image</h5>
1005<ol><p>the image sequence.</p></ol>
1006
1007 </div>
1008<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1009_8c.html" target="source" name="DestroyMagick">DestroyMagick</a></h2>
1010<div class="doc-section">
1011
1012<p>DestroyMagick() destroys the ImageMagick environment.</p></ol>
1013
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1014<p>Deprecated, replace with:</p>
1015
1016<pre class="text">
1017 MagickCoreTerminus();
1018</pre>
1019
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1020<p>The format of the DestroyMagick function is:</p>
1021
1022<pre class="text">
1023 DestroyMagick(void)
1024</pre>
1025
1026 </div>
1027<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1028_8c.html" target="source" name="DispatchImage">DispatchImage</a></h2>
1029<div class="doc-section">
1030
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1031<p>DispatchImage() extracts pixel data from an image and returns it to you. The method returns MagickFalse on success otherwise MagickTrue if an error is encountered. The data is returned as char, short int, int, ssize_t, float, or double in the order specified by map.</p></ol>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1032
1033<p>Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:</p>
1034
1035<pre class="text">
1036 DispatchImage(image,0,0,640,1,"RGB",CharPixel,pixels,exception);
1037</pre>
1038
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1039<p>Deprecated, replace with:</p>
1040
1041<pre class="text">
1042 ExportImagePixels(image,x_offset,y_offset,columns,rows,map,type,pixels,
1043 exception);
1044</pre>
1045
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1046<p>The format of the DispatchImage method is:</p>
1047
1048<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1049 unsigned int DispatchImage(const Image *image,const ssize_t x_offset,
1050 const ssize_t y_offset,const size_t columns,
1051 const size_t rows,const char *map,const StorageType type,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1052 void *pixels,ExceptionInfo *exception)
1053</pre>
1054
1055<p>A description of each parameter follows:</p></ol>
1056
1057<h5>image</h5>
1058<ol><p>the image.</p></ol>
1059
1060<h5>x_offset, y_offset, columns, rows</h5>
1061<ol><p>These values define the perimeter of a region of pixels you want to extract.</p></ol>
1062
1063<h5>map</h5>
1064<ol><p>This string reflects the expected ordering of the pixel array. It can be any combination or order of R = red, G = green, B = blue, A = alpha, C = cyan, Y = yellow, M = magenta, K = black, or I = intensity (for grayscale).</p></ol>
1065
1066<h5>type</h5>
1067<ol><p>Define the data type of the pixels. Float and double types are normalized to [0..1] otherwise [0..QuantumRange]. Choose from these types: CharPixel, ShortPixel, IntegerPixel, LongPixel, FloatPixel, or DoublePixel.</p></ol>
1068
1069<h5>pixels</h5>
1070<ol><p>This array of values contain the pixel components as defined by map and type. You must preallocate this array where the expected length varies depending on the values of width, height, map, and type.</p></ol>
1071
1072<h5>exception</h5>
1073<ol><p>return any errors or warnings in this structure.</p></ol>
1074
1075 </div>
1076<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1077_8c.html" target="source" name="ExtractSubimageFromImageImage">ExtractSubimageFromImageImage</a></h2>
1078<div class="doc-section">
1079
cristyab30d2c2009-09-10 19:17:04 +0000[diff] [blame]1080<p>ExtractSubimageFromImageImage() extracts a region of the image that most closely resembles the reference.</p></ol>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1081
1082<p>The format of the ExtractSubimageFromImageImage method is:</p>
1083
1084<pre class="code">
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1085 Image *ExtractSubimageFromImage(const Image *image,
1086 const Image *reference,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1087</pre>
1088
1089<p>A description of each parameter follows:</p></ol>
1090
1091<h5>image</h5>
1092<ol><p>the image.</p></ol>
1093
cristyab30d2c2009-09-10 19:17:04 +0000[diff] [blame]1094<h5>reference</h5>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1095<ol><p>find an area of the image that closely resembles this image.</p></ol>
1096
1097<h5>exception</h5>
1098<ol><p>return any errors or warnings in this structure.</p></ol>
1099
1100 </div>
1101<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1102_8c.html" target="source" name="FlattenImages">FlattenImages</a></h2>
1103<div class="doc-section">
1104
1105<p>FlattenImages() Obsolete Function: Use MergeImageLayers() instead.</p></ol>
1106
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1107<p>Deprecated, replace with:</p>
1108
1109<pre class="text">
1110 MergeImageLayers(image,FlattenLayer,exception);
1111</pre>
1112
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1113<p>The format of the FlattenImage method is:</p>
1114
1115<pre class="code">
1116 Image *FlattenImage(Image *image,ExceptionInfo *exception)
1117</pre>
1118
1119<p>A description of each parameter follows:</p></ol>
1120
1121<h5>image</h5>
1122<ol><p>the image sequence.</p></ol>
1123
1124<h5>exception</h5>
1125<ol><p>return any errors or warnings in this structure.</p></ol>
1126
1127 </div>
1128<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1129_8c.html" target="source" name="FormatImageAttribute">FormatImageAttribute</a></h2>
1130<div class="doc-section">
1131
1132<p>FormatImageAttribute() permits formatted key/value pairs to be saved as an image attribute.</p></ol>
1133
1134<p>The format of the FormatImageAttribute method is:</p>
1135
1136<pre class="code">
1137 MagickBooleanType FormatImageAttribute(Image *image,const char *key,
1138 const char *format,...)
1139</pre>
1140
1141<p>A description of each parameter follows.</p></ol>
1142
1143<h5> image</h5>
1144<ol><p>The image.</p></ol>
1145
1146<h5> key</h5>
1147<ol><p>The attribute key.</p></ol>
1148
1149<h5> format</h5>
1150<ol><p>A string describing the format to use to write the remaining arguments.</p></ol>
1151
1152 </div>
1153<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1154_8c.html" target="source" name="FormatString">FormatString</a></h2>
1155<div class="doc-section">
1156
1157<p>FormatString() prints formatted output of a variable argument list.</p></ol>
1158
1159<p>The format of the FormatString method is:</p>
1160
1161<pre class="code">
1162 void FormatString(char *string,const char *format,...)
1163</pre>
1164
1165<p>A description of each parameter follows.</p></ol>
1166
1167<h5> string</h5>
1168<ol><p>Method FormatString returns the formatted string in this character buffer.</p></ol>
1169
1170<h5> format</h5>
1171<ol><p>A string describing the format to use to write the remaining arguments.</p></ol>
1172
1173 </div>
1174<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1175_8c.html" target="source" name="GetConfigureBlob">GetConfigureBlob</a></h2>
1176<div class="doc-section">
1177
1178<p>GetConfigureBlob() returns the specified configure file as a blob.</p></ol>
1179
1180<p>The format of the GetConfigureBlob method is:</p>
1181
1182<pre class="code">
1183 void *GetConfigureBlob(const char *filename,ExceptionInfo *exception)
1184</pre>
1185
1186<p>A description of each parameter follows:</p></ol>
1187
1188<h5>filename</h5>
1189<ol><p>the configure file name.</p></ol>
1190
1191<h5>path</h5>
1192<ol><p>return the full path information of the configure file.</p></ol>
1193
1194<h5>length</h5>
1195<ol><p>This pointer to a size_t integer sets the initial length of the blob. On return, it reflects the actual length of the blob.</p></ol>
1196
1197<h5>exception</h5>
1198<ol><p>return any errors or warnings in this structure.</p></ol>
1199
1200 </div>
1201<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1202_8c.html" target="source" name="GetCacheView">GetCacheView</a></h2>
1203<div class="doc-section">
1204
1205<p>GetCacheView() gets pixels from the in-memory or disk pixel cache as defined by the geometry parameters. A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.</p></ol>
1206
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1207<p>Deprecated, replace with:</p>
1208
1209<pre class="text">
1210 GetCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
1211 GetCacheViewException(cache_view));
1212</pre>
1213
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1214<p>The format of the GetCacheView method is:</p>
1215
1216<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1217 PixelPacket *GetCacheView(CacheView *cache_view,const ssize_t x,
1218 const ssize_t y,const size_t columns,const size_t rows)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1219</pre>
1220
1221<p>A description of each parameter follows:</p></ol>
1222
1223<h5>cache_view</h5>
1224<ol><p>the address of a structure of type CacheView.</p></ol>
1225
1226<h5>x,y,columns,rows</h5>
1227<ol><p>These values define the perimeter of a region of pixels.</p></ol>
1228
1229 </div>
1230<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1231_8c.html" target="source" name="GetCacheViewIndexes">GetCacheViewIndexes</a></h2>
1232<div class="doc-section">
1233
1234<p>GetCacheViewIndexes() returns the indexes associated with the specified view.</p></ol>
1235
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1236<p>Deprecated, replace with:</p>
1237
1238<pre class="text">
1239 GetCacheViewAuthenticIndexQueue(cache_view);
1240</pre>
1241
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1242<p>The format of the GetCacheViewIndexes method is:</p>
1243
1244<pre class="code">
1245 IndexPacket *GetCacheViewIndexes(CacheView *cache_view)
1246</pre>
1247
1248<p>A description of each parameter follows:</p></ol>
1249
1250<h5>cache_view</h5>
1251<ol><p>the cache view.</p></ol>
1252
1253 </div>
1254<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1255_8c.html" target="source" name="GetCacheViewPixels">GetCacheViewPixels</a></h2>
1256<div class="doc-section">
1257
1258<p>GetCacheViewPixels() gets pixels from the in-memory or disk pixel cache as defined by the geometry parameters. A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.</p></ol>
1259
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1260<p>Deprecated, replace with:</p>
1261
1262<pre class="text">
1263 GetCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
1264 GetCacheViewException(cache_view));
1265</pre>
1266
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1267<p>The format of the GetCacheViewPixels method is:</p>
1268
1269<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1270 PixelPacket *GetCacheViewPixels(CacheView *cache_view,const ssize_t x,
1271 const ssize_t y,const size_t columns,const size_t rows)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1272</pre>
1273
1274<p>A description of each parameter follows:</p></ol>
1275
1276<h5>cache_view</h5>
1277<ol><p>the cache view.</p></ol>
1278
1279<h5>x,y,columns,rows</h5>
1280<ol><p>These values define the perimeter of a region of pixels.</p></ol>
1281
1282 </div>
1283<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1284_8c.html" target="source" name="GetImageAttribute">GetImageAttribute</a></h2>
1285<div class="doc-section">
1286
1287<p>GetImageAttribute() searches the list of image attributes and returns a pointer to the attribute if it exists otherwise NULL.</p></ol>
1288
1289<p>The format of the GetImageAttribute method is:</p>
1290
1291<pre class="code">
1292 const ImageAttribute *GetImageAttribute(const Image *image,
1293 const char *key)
1294</pre>
1295
1296<p>A description of each parameter follows:</p></ol>
1297
1298<h5>image</h5>
1299<ol><p>the image.</p></ol>
1300
1301<h5>key</h5>
1302<ol><p>These character strings are the name of an image attribute to return.</p></ol>
1303
1304 </div>
1305<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1306_8c.html" target="source" name="GetImageClippingPathAttribute">GetImageClippingPathAttribute</a></h2>
1307<div class="doc-section">
1308
1309<p>GetImageClippingPathAttribute() searches the list of image attributes and returns a pointer to a clipping path if it exists otherwise NULL.</p></ol>
1310
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1311<p>Deprecated, replace with:</p>
1312
1313<pre class="text">
1314 GetImageAttribute(image,"8BIM:1999,2998");
1315</pre>
1316
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1317<p>The format of the GetImageClippingPathAttribute method is:</p>
1318
1319<pre class="code">
1320 const ImageAttribute *GetImageClippingPathAttribute(Image *image)
1321</pre>
1322
1323<p>A description of each parameter follows:</p></ol>
1324
1325<h5>attribute</h5>
1326<ol><p>Method GetImageClippingPathAttribute returns the clipping path if it exists otherwise NULL.</p></ol>
1327
1328<h5>image</h5>
1329<ol><p>the image.</p></ol>
1330
1331 </div>
1332<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1333_8c.html" target="source" name="GetImageFromMagickRegistry">GetImageFromMagickRegistry</a></h2>
1334<div class="doc-section">
1335
1336<p>GetImageFromMagickRegistry() gets an image from the registry as defined by its name. If the image is not found, a NULL image is returned.</p></ol>
1337
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1338<p>Deprecated, replace with:</p>
1339
1340<pre class="text">
1341 GetImageRegistry(ImageRegistryType,name,exception);
1342</pre>
1343
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1344<p>The format of the GetImageFromMagickRegistry method is:</p>
1345
1346<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1347 Image *GetImageFromMagickRegistry(const char *name,ssize_t *id,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1348 ExceptionInfo *exception)
1349</pre>
1350
1351<p>A description of each parameter follows:</p></ol>
1352
1353<h5>name</h5>
1354<ol><p>the name of the image to retrieve from the registry.</p></ol>
1355
1356<h5>id</h5>
1357<ol><p>the registry id.</p></ol>
1358
1359<h5>exception</h5>
1360<ol><p>return any errors or warnings in this structure.</p></ol>
1361
1362 </div>
1363<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1364_8c.html" target="source" name="GetMagickRegistry">GetMagickRegistry</a></h2>
1365<div class="doc-section">
1366
1367<p>GetMagickRegistry() gets a blob from the registry as defined by the id. If the blob that matches the id is not found, NULL is returned.</p></ol>
1368
1369<p>The format of the GetMagickRegistry method is:</p>
1370
1371<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1372 const void *GetMagickRegistry(const ssize_t id,RegistryType *type,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1373 size_t *length,ExceptionInfo *exception)
1374</pre>
1375
1376<p>A description of each parameter follows:</p></ol>
1377
1378<h5>id</h5>
1379<ol><p>the registry id.</p></ol>
1380
1381<h5>type</h5>
1382<ol><p>the registry type.</p></ol>
1383
1384<h5>length</h5>
1385<ol><p>the blob length in number of bytes.</p></ol>
1386
1387<h5>exception</h5>
1388<ol><p>return any errors or warnings in this structure.</p></ol>
1389
1390 </div>
1391<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1392_8c.html" target="source" name="GetImageGeometry">GetImageGeometry</a></h2>
1393<div class="doc-section">
1394
1395<p>GetImageGeometry() returns a region as defined by the geometry string with respect to the image and its gravity.</p></ol>
1396
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1397<p>Deprecated, replace with:</p>
1398
1399<pre class="text">
1400 if (size_to_fit != MagickFalse)
1401 ParseRegionGeometry(image,geometry,region_info,&image->exception); else
1402 ParsePageGeometry(image,geometry,region_info,&image->exception);
1403</pre>
1404
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1405<p>The format of the GetImageGeometry method is:</p>
1406
1407<pre class="code">
1408 int GetImageGeometry(Image *image,const char *geometry,
1409 const unsigned int size_to_fit,RectangeInfo *region_info)
1410</pre>
1411
1412<p>A description of each parameter follows:</p></ol>
1413
1414<h5>flags</h5>
1415<ol><p>Method GetImageGeometry returns a bitmask that indicates which of the four values were located in the geometry string.</p></ol>
1416
1417<h5>geometry</h5>
1418<ol><p>The geometry (e.g. 100x100+10+10).</p></ol>
1419
1420<h5>size_to_fit</h5>
1421<ol><p>A value other than 0 means to scale the region so it fits within the specified width and height.</p></ol>
1422
1423<h5>region_info</h5>
1424<ol><p>the region as defined by the geometry string with respect to the image and its gravity.</p></ol>
1425
1426 </div>
1427<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1428_8c.html" target="source" name="GetImageList">GetImageList</a></h2>
1429<div class="doc-section">
1430
1431<p>GetImageList() returns an image at the specified position in the list.</p></ol>
1432
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1433<p>Deprecated, replace with:</p>
1434
1435<pre class="text">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1436 CloneImage(GetImageFromList(images,(ssize_t) offset),0,0,MagickTrue,
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1437 exception);
1438</pre>
1439
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1440<p>The format of the GetImageList method is:</p>
1441
1442<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1443 Image *GetImageList(const Image *images,const ssize_t offset,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1444 ExceptionInfo *exception)
1445</pre>
1446
1447<p>A description of each parameter follows:</p></ol>
1448
1449<h5>images</h5>
1450<ol><p>the image list.</p></ol>
1451
1452<h5>offset</h5>
1453<ol><p>the position within the list.</p></ol>
1454
1455<h5>exception</h5>
1456<ol><p>return any errors or warnings in this structure.</p></ol>
1457
1458 </div>
1459<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1460_8c.html" target="source" name="GetImageListIndex">GetImageListIndex</a></h2>
1461<div class="doc-section">
1462
1463<p>GetImageListIndex() returns the position in the list of the specified image.</p></ol>
1464
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1465<p>Deprecated, replace with:</p>
1466
1467<pre class="text">
1468 GetImageIndexInList(images);
1469</pre>
1470
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1471<p>The format of the GetImageListIndex method is:</p>
1472
1473<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1474 ssize_t GetImageListIndex(const Image *images)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1475</pre>
1476
1477<p>A description of each parameter follows:</p></ol>
1478
1479<h5>images</h5>
1480<ol><p>the image list.</p></ol>
1481
1482 </div>
1483<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1484_8c.html" target="source" name="GetImageListSize">GetImageListSize</a></h2>
1485<div class="doc-section">
1486
1487<p>GetImageListSize() returns the number of images in the list.</p></ol>
1488
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1489<p>Deprecated, replace with:</p>
1490
1491<pre class="text">
1492 GetImageListLength(images);
1493</pre>
1494
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1495<p>The format of the GetImageListSize method is:</p>
1496
1497<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1498 size_t GetImageListSize(const Image *images)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1499</pre>
1500
1501<p>A description of each parameter follows:</p></ol>
1502
1503<h5>images</h5>
1504<ol><p>the image list.</p></ol>
1505
1506 </div>
1507<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1508_8c.html" target="source" name="GetImagePixels">GetImagePixels</a></h2>
1509<div class="doc-section">
1510
1511<p>GetImagePixels() obtains a pixel region for read/write access. If the region is successfully accessed, a pointer to a PixelPacket array representing the region is returned, otherwise NULL is returned.</p></ol>
1512
1513<p>The returned pointer may point to a temporary working copy of the pixels or it may point to the original pixels in memory. Performance is maximized if the selected region is part of one row, or one or more full rows, since then there is opportunity to access the pixels in-place (without a copy) if the image is in RAM, or in a memory-mapped file. The returned pointer should *never* be deallocated by the user.</p></ol>
1514
1515<p>Pixels accessed via the returned pointer represent a simple array of type PixelPacket. If the image type is CMYK or if the storage class is PseduoClass, call GetAuthenticIndexQueue() after invoking GetImagePixels() to obtain the black color component or colormap indexes (of type IndexPacket) corresponding to the region. Once the PixelPacket (and/or IndexPacket) array has been updated, the changes must be saved back to the underlying image using SyncAuthenticPixels() or they may be lost.</p></ol>
1516
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1517<p>Deprecated, replace with:</p>
1518
1519<pre class="text">
1520 GetAuthenticPixels(image,x,y,columns,rows,&image->exception);
1521</pre>
1522
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1523<p>The format of the GetImagePixels() method is:</p>
1524
1525<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1526 PixelPacket *GetImagePixels(Image *image,const ssize_t x,const ssize_t y,
1527 const size_t columns,const size_t rows)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1528</pre>
1529
1530<p>A description of each parameter follows:</p></ol>
1531
1532<h5>image</h5>
1533<ol><p>the image.</p></ol>
1534
1535<h5>x,y,columns,rows</h5>
1536<ol><p>These values define the perimeter of a region of pixels.</p></ol>
1537
1538 </div>
1539<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1540_8c.html" target="source" name="GetIndexes">GetIndexes</a></h2>
1541<div class="doc-section">
1542
1543<p>GetIndexes() returns the black channel or the colormap indexes associated with the last call to QueueAuthenticPixels() or GetVirtualPixels(). NULL is returned if the black channel or colormap indexes are not available.</p></ol>
1544
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1545<p>Deprecated, replace with:</p>
1546
1547<pre class="text">
1548 GetAuthenticIndexQueue(image);
1549</pre>
1550
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1551<p>The format of the GetIndexes() method is:</p>
1552
1553<pre class="code">
1554 IndexPacket *GetIndexes(const Image *image)
1555</pre>
1556
1557<p>A description of each parameter follows:</p></ol>
1558
1559<h5>indexes</h5>
1560<ol><p>GetIndexes() returns the indexes associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p></ol>
1561
1562<h5>image</h5>
1563<ol><p>the image.</p></ol>
1564
1565 </div>
1566<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1567_8c.html" target="source" name="GetNextImage">GetNextImage</a></h2>
1568<div class="doc-section">
1569
1570<p>GetNextImage() returns the next image in a list.</p></ol>
1571
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1572<p>Deprecated, replace with:</p>
1573
1574<pre class="text">
1575 GetNextImageInList(images);
1576</pre>
1577
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1578<p>The format of the GetNextImage method is:</p>
1579
1580<pre class="code">
1581 Image *GetNextImage(const Image *images)
1582</pre>
1583
1584<p>A description of each parameter follows:</p></ol>
1585
1586<h5>images</h5>
1587<ol><p>the image list.</p></ol>
1588
1589 </div>
1590<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1591_8c.html" target="source" name="GetNextImageAttribute">GetNextImageAttribute</a></h2>
1592<div class="doc-section">
1593
1594<p>GetNextImageAttribute() gets the next image attribute.</p></ol>
1595
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1596<p>Deprecated, replace with:</p>
1597
1598<pre class="text">
1599 const char *property;
1600 property=GetNextImageProperty(image);
1601 if (property != (const char *) NULL)
1602 GetImageAttribute(image,property);
1603</pre>
1604
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1605<p>The format of the GetNextImageAttribute method is:</p>
1606
1607<pre class="code">
1608 const ImageAttribute *GetNextImageAttribute(const Image *image)
1609</pre>
1610
1611<p>A description of each parameter follows:</p></ol>
1612
1613<h5>image</h5>
1614<ol><p>the image.</p></ol>
1615
1616 </div>
1617<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1618_8c.html" target="source" name="GetNumberScenes">GetNumberScenes</a></h2>
1619<div class="doc-section">
1620
1621<p>GetNumberScenes() returns the number of images in the list.</p></ol>
1622
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1623<p>Deprecated, replace with:</p>
1624
1625<pre class="text">
1626 GetImageListLength(image);
1627</pre>
1628
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1629<p>The format of the GetNumberScenes method is:</p>
1630
1631<pre class="code">
1632 unsigned int GetNumberScenes(const Image *images)
1633</pre>
1634
1635<p>A description of each parameter follows:</p></ol>
1636
1637<h5>images</h5>
1638<ol><p>the image list.</p></ol>
1639
1640 </div>
1641<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1642_8c.html" target="source" name="GetOnePixel">GetOnePixel</a></h2>
1643<div class="doc-section">
1644
1645<p>GetOnePixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.</p></ol>
1646
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1647<p>Deprecated, replace with:</p>
1648
1649<pre class="text">
1650 GetOneAuthenticPixel(image,x,y,&pixel,&image->exception);
1651</pre>
1652
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1653<p>The format of the GetOnePixel() method is:</p>
1654
1655<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]1656 PixelPacket GetOnePixel(const Image image,const ssize_t x,const ssize_t y)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1657</pre>
1658
1659<p>A description of each parameter follows:</p></ol>
1660
1661<h5>image</h5>
1662<ol><p>the image.</p></ol>
1663
1664<h5>x,y</h5>
1665<ol><p>These values define the location of the pixel to return.</p></ol>
1666
1667 </div>
1668<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1669_8c.html" target="source" name="GetPixels">GetPixels</a></h2>
1670<div class="doc-section">
1671
1672<p>GetPixels() returns the pixels associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p></ol>
1673
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1674<p>Deprecated, replace with:</p>
1675
1676<pre class="text">
1677 GetAuthenticPixelQueue(image);
1678</pre>
1679
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1680<p>The format of the GetPixels() method is:</p>
1681
1682<pre class="code">
1683 PixelPacket *GetPixels(const Image image)
1684</pre>
1685
1686<p>A description of each parameter follows:</p></ol>
1687
1688<h5>pixels</h5>
1689<ol><p>GetPixels() returns the pixels associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p></ol>
1690
1691<h5>image</h5>
1692<ol><p>the image.</p></ol>
1693
1694 </div>
1695<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1696_8c.html" target="source" name="GetPreviousImage">GetPreviousImage</a></h2>
1697<div class="doc-section">
1698
1699<p>GetPreviousImage() returns the previous image in a list.</p></ol>
1700
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1701<p>Deprecated, replace with:</p>
1702
1703<pre class="text">
1704 GetPreviousImageInList(images));
1705</pre>
1706
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1707<p>The format of the GetPreviousImage method is:</p>
1708
1709<pre class="code">
1710 Image *GetPreviousImage(const Image *images)
1711</pre>
1712
1713<p>A description of each parameter follows:</p></ol>
1714
1715<h5>images</h5>
1716<ol><p>the image list.</p></ol>
1717
1718 </div>
1719<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1720_8c.html" target="source" name="HSLTransform">HSLTransform</a></h2>
1721<div class="doc-section">
1722
1723<p>HSLTransform() converts a (hue, saturation, lightness) to a (red, green, blue) triple.</p></ol>
1724
1725<p>The format of the HSLTransformImage method is:</p>
1726
1727<pre class="code">
1728 void HSLTransform(const double hue,const double saturation,
1729 const double lightness,Quantum *red,Quantum *green,Quantum *blue)
1730</pre>
1731
1732<p>A description of each parameter follows:</p></ol>
1733
1734<h5>hue, saturation, lightness</h5>
1735<ol><p>A double value representing a component of the HSL color space.</p></ol>
1736
1737<h5>red, green, blue</h5>
1738<ol><p>A pointer to a pixel component of type Quantum.</p></ol>
1739
1740 </div>
1741<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1742_8c.html" target="source" name="IdentityAffine">IdentityAffine</a></h2>
1743<div class="doc-section">
1744
1745<p>IdentityAffine() initializes the affine transform to the identity matrix.</p></ol>
1746
1747<p>The format of the IdentityAffine method is:</p>
1748
1749<pre class="code">
1750 IdentityAffine(AffineMatrix *affine)
1751</pre>
1752
1753<p>A description of each parameter follows:</p></ol>
1754
1755<h5>affine</h5>
1756<ol><p>A pointer the affine transform of type AffineMatrix.</p></ol>
1757
1758 </div>
1759<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1760_8c.html" target="source" name="InitializeMagick">InitializeMagick</a></h2>
1761<div class="doc-section">
1762
1763<p>InitializeMagick() initializes the ImageMagick environment.</p></ol>
1764
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1765<p>Deprecated, replace with:</p>
1766
1767<pre class="text">
1768 MagickCoreGenesis(path,MagickFalse);
1769</pre>
1770
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1771<p>The format of the InitializeMagick function is:</p>
1772
1773<pre class="text">
1774 InitializeMagick(const char *path)
1775</pre>
1776
1777<p>A description of each parameter follows:</p></ol>
1778
1779<h5>path</h5>
1780<ol><p>the execution path of the current ImageMagick client.</p></ol>
1781
1782 </div>
1783<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1784_8c.html" target="source" name="InterpolatePixelColor">InterpolatePixelColor</a></h2>
1785<div class="doc-section">
1786
1787<p>InterpolatePixelColor() applies bi-linear or tri-linear interpolation between a pixel and it's neighbors.</p></ol>
1788
1789<p>The format of the InterpolatePixelColor method is:</p>
1790
1791<pre class="code">
1792 MagickPixelPacket InterpolatePixelColor(const Image *image,
1793 CacheView *view_info,InterpolatePixelMethod method,const double x,
1794 const double y,ExceptionInfo *exception)
1795</pre>
1796
1797<p>A description of each parameter follows:</p></ol>
1798
1799<h5>image</h5>
1800<ol><p>the image.</p></ol>
1801
1802<h5>image_view</h5>
1803<ol><p>the image cache view.</p></ol>
1804
1805<h5>type</h5>
1806<ol><p>the type of pixel color interpolation.</p></ol>
1807
1808<h5>x,y</h5>
1809<ol><p>A double representing the current (x,y) position of the pixel.</p></ol>
1810
1811<h5>exception</h5>
1812<ol><p>return any errors or warnings in this structure.</p></ol>
1813
1814 </div>
1815<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1816_8c.html" target="source" name="InterpretImageAttributes">InterpretImageAttributes</a></h2>
1817<div class="doc-section">
1818
1819<p>InterpretImageAttributes() replaces any embedded formatting characters with the appropriate image attribute and returns the translated text.</p></ol>
1820
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1821<p>Deprecated, replace with:</p>
1822
1823<pre class="text">
1824 InterpretImageProperties(image_info,image,embed_text);
1825</pre>
1826
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1827<p>The format of the InterpretImageAttributes method is:</p>
1828
1829<pre class="code">
1830 char *InterpretImageAttributes(const ImageInfo *image_info,Image *image,
1831 const char *embed_text)
1832</pre>
1833
1834<p>A description of each parameter follows:</p></ol>
1835
1836<h5>image_info</h5>
1837<ol><p>the image info.</p></ol>
1838
1839<h5>image</h5>
1840<ol><p>the image.</p></ol>
1841
1842<h5>embed_text</h5>
1843<ol><p>the address of a character string containing the embedded formatting characters.</p></ol>
1844
1845 </div>
1846<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
cristy5cadd612009-09-21 19:33:41 +0000[diff] [blame]1847_8c.html" target="source" name="LevelImageColor">LevelImageColor</a></h2>
1848<div class="doc-section">
1849
1850<p>LevelImageColor() will map the given color to "black" and "white" values, limearly spreading out the colors, and level values on a channel by channel bases, as per LevelImage(). The given colors allows you to specify different level ranges for each of the color channels seperatally.</p></ol>
1851
1852<p>If the boolean 'invert' is set true the image values will modifyed in the reverse direction. That is any existing "black" and "white" colors in the image will become the color values given, with all other values compressed appropriatally. This effectivally maps a greyscale gradient into the given color gradient.</p></ol>
1853
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1854<p>Deprecated, replace with:</p>
1855
1856<pre class="text">
1857 LevelColorsImageChannel(image,channel,black_color,white_color,invert);
1858</pre>
1859
cristy5cadd612009-09-21 19:33:41 +0000[diff] [blame]1860<p>The format of the LevelImageColors method is:</p>
1861
1862<pre class="code">
1863 MagickBooleanType LevelImageColors(Image *image,const ChannelType channel,
1864 const MagickPixelPacket *black_color,const MagickPixelPacket *white_color,
1865 const MagickBooleanType invert)
1866</pre>
1867
1868<p>A description of each parameter follows:</p></ol>
1869
1870<h5>image</h5>
1871<ol><p>the image.</p></ol>
1872
1873<h5>channel</h5>
1874<ol><p>the channel.</p></ol>
1875
1876<h5>black_color</h5>
1877<ol><p>The color to map black to/from</p></ol>
1878
1879<h5>white_point</h5>
1880<ol><p>The color to map white to/from</p></ol>
1881
1882<h5>invert</h5>
1883<ol><p>if true map the colors (levelize), rather than from (level)</p></ol>
1884
1885 </div>
1886<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1887_8c.html" target="source" name="LiberateMemory">LiberateMemory</a></h2>
1888<div class="doc-section">
1889
1890<p>LiberateMemory() frees memory that has already been allocated, and NULL's the pointer to it.</p></ol>
1891
1892<p>The format of the LiberateMemory method is:</p>
1893
1894<pre class="code">
1895 void LiberateMemory(void **memory)
1896</pre>
1897
1898<p>A description of each parameter follows:</p></ol>
1899
1900<h5>memory</h5>
1901<ol><p>A pointer to a block of memory to free for reuse.</p></ol>
1902
1903 </div>
1904<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1905_8c.html" target="source" name="LiberateSemaphoreInfo">LiberateSemaphoreInfo</a></h2>
1906<div class="doc-section">
1907
1908<p>LiberateSemaphoreInfo() relinquishes a semaphore.</p></ol>
1909
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1910<p>Deprecated, replace with:</p>
1911
1912<pre class="text">
1913 UnlockSemaphoreInfo(*semaphore_info);
1914</pre>
1915
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1916<p>The format of the LiberateSemaphoreInfo method is:</p>
1917
1918<pre class="code">
1919 LiberateSemaphoreInfo(void **semaphore_info)
1920</pre>
1921
1922<p>A description of each parameter follows:</p></ol>
1923
1924<h5>semaphore_info</h5>
1925<ol><p>Specifies a pointer to an SemaphoreInfo structure.</p></ol>
1926
1927 </div>
1928<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1929_8c.html" target="source" name="MagickIncarnate">MagickIncarnate</a></h2>
1930<div class="doc-section">
1931
1932<p>MagickIncarnate() initializes the ImageMagick environment.</p></ol>
1933
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1934<p>Deprecated, replace with:</p>
1935
1936<pre class="text">
1937 MagickCoreGenesis(path,MagickFalse);
1938</pre>
1939
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1940<p>The format of the MagickIncarnate function is:</p>
1941
1942<pre class="text">
1943 MagickIncarnate(const char *path)
1944</pre>
1945
1946<p>A description of each parameter follows:</p></ol>
1947
1948<h5>path</h5>
1949<ol><p>the execution path of the current ImageMagick client.</p></ol>
1950
1951 </div>
1952<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1953_8c.html" target="source" name="MagickMonitor">MagickMonitor</a></h2>
1954<div class="doc-section">
1955
1956<p>MagickMonitor() calls the monitor handler method with a text string that describes the task and a measure of completion. The method returns MagickTrue on success otherwise MagickFalse if an error is encountered, e.g. if there was a user interrupt.</p></ol>
1957
1958<p>The format of the MagickMonitor method is:</p>
1959
1960<pre class="code">
1961 MagickBooleanType MagickMonitor(const char *text,
1962 const MagickOffsetType offset,const MagickSizeType span,
1963 void *client_data)
1964</pre>
1965
1966<p>A description of each parameter follows:</p></ol>
1967
1968<h5>offset</h5>
1969<ol><p>the position relative to the span parameter which represents how much progress has been made toward completing a task.</p></ol>
1970
1971<h5>span</h5>
1972<ol><p>the span relative to completing a task.</p></ol>
1973
1974<h5>client_data</h5>
1975<ol><p>the client data.</p></ol>
1976
1977 </div>
1978<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1979_8c.html" target="source" name="MapImage">MapImage</a></h2>
1980<div class="doc-section">
1981
1982<p>MapImage() replaces the colors of an image with the closest color from a reference image.</p></ol>
1983
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]1984<p>Deprecated, replace with:</p>
1985
1986<pre class="text">
1987 QuantizeInfo quantize_info;
1988 GetQuantizeInfo(&quantize_info);
1989 quantize_info.dither=dither;
1990 RemapImage(&quantize_info,image,map_image);
1991</pre>
1992
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1993<p>The format of the MapImage method is:</p>
1994
1995<pre class="code">
1996 MagickBooleanType MapImage(Image *image,const Image *map_image,
1997 const MagickBooleanType dither)
1998</pre>
1999
2000<p>A description of each parameter follows:</p></ol>
2001
2002<h5>image</h5>
2003<ol><p>Specifies a pointer to an Image structure.</p></ol>
2004
2005<h5>map_image</h5>
2006<ol><p>the image. Reduce image to a set of colors represented by this image.</p></ol>
2007
2008<h5>dither</h5>
2009<ol><p>Set this integer value to something other than zero to dither the mapped image.</p></ol>
2010
2011 </div>
2012<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2013_8c.html" target="source" name="MapImages">MapImages</a></h2>
2014<div class="doc-section">
2015
2016<p>MapImages() replaces the colors of a sequence of images with the closest color from a reference image.</p></ol>
2017
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]2018<p>Deprecated, replace with:</p>
2019
2020<pre class="text">
2021 QuantizeInfo quantize_info;
2022 GetQuantizeInfo(&quantize_info);
2023 quantize_info.dither=dither;
2024 RemapImages(&quantize_info,images,map_image);
2025</pre>
2026
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2027<p>The format of the MapImage method is:</p>
2028
2029<pre class="code">
2030 MagickBooleanType MapImages(Image *images,Image *map_image,
2031 const MagickBooleanType dither)
2032</pre>
2033
2034<p>A description of each parameter follows:</p></ol>
2035
2036<h5>image</h5>
2037<ol><p>Specifies a pointer to a set of Image structures.</p></ol>
2038
2039<h5>map_image</h5>
2040<ol><p>the image. Reduce image to a set of colors represented by this image.</p></ol>
2041
2042<h5>dither</h5>
2043<ol><p>Set this integer value to something other than zero to dither the quantized image.</p></ol>
2044
2045 </div>
2046<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2047_8c.html" target="source" name="MatteFloodfill">MatteFloodfill</a></h2>
2048<div class="doc-section">
2049
2050<p>MatteFloodfill() changes the transparency value of any pixel that matches target and is an immediate neighbor. If the method FillToBorderMethod is specified, the transparency value is changed for any neighbor pixel that does not match the bordercolor member of image.</p></ol>
2051
2052<p>By default target must match a particular pixel transparency exactly. However, in many cases two transparency values may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two transparency values as the same. For example, set fuzz to 10 and the opacity values of 100 and 102 respectively are now interpreted as the same value for the purposes of the floodfill.</p></ol>
2053
2054<p>The format of the MatteFloodfillImage method is:</p>
2055
2056<pre class="code">
2057 MagickBooleanType MatteFloodfillImage(Image *image,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2058 const PixelPacket target,const Quantum opacity,const ssize_t x_offset,
2059 const ssize_t y_offset,const PaintMethod method)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2060</pre>
2061
2062<p>A description of each parameter follows:</p></ol>
2063
2064<h5>image</h5>
2065<ol><p>the image.</p></ol>
2066
2067<h5>target</h5>
2068<ol><p>the RGB value of the target color.</p></ol>
2069
2070<h5>opacity</h5>
2071<ol><p>the level of transparency: 0 is fully opaque and QuantumRange is fully transparent.</p></ol>
2072
2073<h5>x,y</h5>
2074<ol><p>the starting location of the operation.</p></ol>
2075
2076<h5>method</h5>
2077<ol><p>Choose either FloodfillMethod or FillToBorderMethod.</p></ol>
2078
2079 </div>
2080<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
cristy63fed272010-03-07 19:08:45 +0000[diff] [blame]2081_8c.html" target="source" name="MaximumImages">MaximumImages</a></h2>
2082<div class="doc-section">
2083
2084<p>MaximumImages() returns the maximum intensity of an image sequence.</p></ol>
2085
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]2086<p>Deprecated, replace with:</p>
2087
2088<pre class="text">
2089 EvaluateImages(images,MinEvaluateOperator,exception);
2090</pre>
2091
cristy63fed272010-03-07 19:08:45 +0000[diff] [blame]2092<p>The format of the MaxImages method is:</p>
2093
2094<pre class="code">
2095 Image *MaximumImages(Image *images,ExceptionInfo *exception)
2096</pre>
2097
2098<p>A description of each parameter follows:</p></ol>
2099
2100<h5>images</h5>
2101<ol><p>the image sequence.</p></ol>
2102
2103<h5>exception</h5>
2104<ol><p>return any errors or warnings in this structure.</p></ol>
2105
2106 </div>
2107<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2108_8c.html" target="source" name="MinimumImages">MinimumImages</a></h2>
2109<div class="doc-section">
2110
2111<p>MinimumImages() returns the minimum intensity of an image sequence.</p></ol>
2112
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]2113<p>Deprecated, replace with:</p>
2114
2115<pre class="text">
2116 EvaluateImages(images,MinEvaluateOperator,exception);
2117</pre>
2118
cristy63fed272010-03-07 19:08:45 +0000[diff] [blame]2119<p>The format of the MinimumImages method is:</p>
2120
2121<pre class="code">
2122 Image *MinimumImages(Image *images,ExceptionInfo *exception)
2123</pre>
2124
2125<p>A description of each parameter follows:</p></ol>
2126
2127<h5>images</h5>
2128<ol><p>the image sequence.</p></ol>
2129
2130<h5>exception</h5>
2131<ol><p>return any errors or warnings in this structure.</p></ol>
2132
2133 </div>
2134<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2135_8c.html" target="source" name="MosaicImages">MosaicImages</a></h2>
2136<div class="doc-section">
2137
2138<p>MosaicImages() Obsolete Function: Use MergeImageLayers() instead.</p></ol>
2139
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]2140<p>Deprecated, replace with:</p>
2141
2142<pre class="text">
2143 MergeImageLayers(image,MosaicLayer,exception);
2144</pre>
2145
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2146<p>The format of the MosaicImage method is:</p>
2147
2148<pre class="code">
2149 Image *MosaicImages(const Image *image,ExceptionInfo *exception)
2150</pre>
2151
2152<p>A description of each parameter follows:</p></ol>
2153
2154<h5>image</h5>
2155<ol><p>the image list to be composited together</p></ol>
2156
2157<h5>exception</h5>
2158<ol><p>return any errors or warnings in this structure.</p></ol>
2159
2160 </div>
2161<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2162_8c.html" target="source" name="OpaqueImage">OpaqueImage</a></h2>
2163<div class="doc-section">
2164
2165<p>OpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
2166
2167<p>By default color must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. Fuzz defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color.</p></ol>
2168
2169<p>The format of the OpaqueImage method is:</p>
2170
2171<pre class="code">
2172 MagickBooleanType OpaqueImage(Image *image,
2173 const PixelPacket *target,const PixelPacket fill)
2174</pre>
2175
2176<p>A description of each parameter follows:</p></ol>
2177
2178<h5>image</h5>
2179<ol><p>the image.</p></ol>
2180
2181<h5>target</h5>
2182<ol><p>the RGB value of the target color.</p></ol>
2183
2184<h5>fill</h5>
2185<ol><p>the replacement color.</p></ol>
2186
2187 </div>
2188<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2189_8c.html" target="source" name="OpenCacheView">OpenCacheView</a></h2>
2190<div class="doc-section">
2191
2192<p>OpenCacheView() opens a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p></ol>
2193
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]2194<p>Deprecated, replace with:</p>
2195
2196<pre class="text">
2197 AcquireCacheView(image);
2198</pre>
2199
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2200<p>The format of the OpenCacheView method is:</p>
2201
2202<pre class="code">
2203 CacheView *OpenCacheView(const Image *image)
2204</pre>
2205
2206<p>A description of each parameter follows:</p></ol>
2207
2208<h5>image</h5>
2209<ol><p>the image.</p></ol>
2210
2211 </div>
2212<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2213_8c.html" target="source" name="PaintFloodfill">PaintFloodfill</a></h2>
2214<div class="doc-section">
2215
2216<p>PaintFloodfill() changes the color value of any pixel that matches target and is an immediate neighbor. If the method FillToBorderMethod is specified, the color value is changed for any neighbor pixel that does not match the bordercolor member of image.</p></ol>
2217
2218<p>By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.</p></ol>
2219
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]2220<p>Deprecated, replace with:</p>
2221
2222<pre class="text">
2223 FloodfillPaintImage(image,channel,draw_info,target,x,y,
2224 method == FloodfillMethod ? MagickFalse : MagickTrue);
2225</pre>
2226
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2227<p>The format of the PaintFloodfillImage method is:</p>
2228
2229<pre class="code">
2230 MagickBooleanType PaintFloodfillImage(Image *image,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2231 const ChannelType channel,const MagickPixelPacket target,const ssize_t x,
2232 const ssize_t y,const DrawInfo *draw_info,const PaintMethod method)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2233</pre>
2234
2235<p>A description of each parameter follows:</p></ol>
2236
2237<h5>image</h5>
2238<ol><p>the image.</p></ol>
2239
2240<h5>channel</h5>
2241<ol><p>the channel(s).</p></ol>
2242
2243<h5>target</h5>
2244<ol><p>the RGB value of the target color.</p></ol>
2245
2246<h5>x,y</h5>
2247<ol><p>the starting location of the operation.</p></ol>
2248
2249<h5>draw_info</h5>
2250<ol><p>the draw info.</p></ol>
2251
2252<h5>method</h5>
2253<ol><p>Choose either FloodfillMethod or FillToBorderMethod.</p></ol>
2254
2255 </div>
2256<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2257_8c.html" target="source" name="PaintOpaqueImage">PaintOpaqueImage</a></h2>
2258<div class="doc-section">
2259
2260<p>PaintOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
2261
2262<p>By default color must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. Fuzz defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color.</p></ol>
2263
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]2264<p>Deprecated, replace with:</p>
2265
2266<pre class="text">
2267 OpaquePaintImageChannel(image,DefaultChannels,target,fill,MagickFalse);
2268 OpaquePaintImageChannel(image,channel,target,fill,MagickFalse);
2269</pre>
2270
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2271<p>The format of the PaintOpaqueImage method is:</p>
2272
2273<pre class="code">
2274 MagickBooleanType PaintOpaqueImage(Image *image,
2275 const PixelPacket *target,const PixelPacket *fill)
2276 MagickBooleanType PaintOpaqueImageChannel(Image *image,
2277 const ChannelType channel,const PixelPacket *target,
2278 const PixelPacket *fill)
2279</pre>
2280
2281<p>A description of each parameter follows:</p></ol>
2282
2283<h5>image</h5>
2284<ol><p>the image.</p></ol>
2285
2286<h5>channel</h5>
2287<ol><p>the channel(s).</p></ol>
2288
2289<h5>target</h5>
2290<ol><p>the RGB value of the target color.</p></ol>
2291
2292<h5>fill</h5>
2293<ol><p>the replacement color.</p></ol>
2294
2295 </div>
2296<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2297_8c.html" target="source" name="PaintTransparentImage">PaintTransparentImage</a></h2>
2298<div class="doc-section">
2299
2300<p>PaintTransparentImage() changes the opacity value associated with any pixel that matches color to the value defined by opacity.</p></ol>
2301
2302<p>By default color must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. Fuzz defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color.</p></ol>
2303
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]2304<p>Deprecated, replace with:</p>
2305
2306<pre class="text">
2307 TransparentPaintImage(image,target,opacity,MagickFalse);
2308</pre>
2309
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2310<p>The format of the PaintTransparentImage method is:</p>
2311
2312<pre class="code">
2313 MagickBooleanType PaintTransparentImage(Image *image,
2314 const MagickPixelPacket *target,const Quantum opacity)
2315</pre>
2316
2317<p>A description of each parameter follows:</p></ol>
2318
2319<h5>image</h5>
2320<ol><p>the image.</p></ol>
2321
2322<h5>target</h5>
2323<ol><p>the RGB value of the target color.</p></ol>
2324
2325<h5>opacity</h5>
2326<ol><p>the replacement opacity value.</p></ol>
2327
2328 </div>
2329<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2330_8c.html" target="source" name="ParseSizeGeometry">ParseSizeGeometry</a></h2>
2331<div class="doc-section">
2332
2333<p>ParseSizeGeometry() returns a region as defined by the geometry string with respect to the image dimensions and aspect ratio.</p></ol>
2334
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]2335<p>Deprecated, replace with:</p>
2336
2337<pre class="text">
2338 ParseMetaGeometry(geometry,&region_info->x,&region_info->y,
2339 &region_info->width,&region_info->height);
2340</pre>
2341
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2342<p>The format of the ParseSizeGeometry method is:</p>
2343
2344<pre class="code">
2345 MagickStatusType ParseSizeGeometry(const Image *image,
2346 const char *geometry,RectangeInfo *region_info)
2347</pre>
2348
2349<p>A description of each parameter follows:</p></ol>
2350
2351<h5>geometry</h5>
2352<ol><p>The geometry (e.g. 100x100+10+10).</p></ol>
2353
2354<h5>region_info</h5>
2355<ol><p>the region as defined by the geometry string.</p></ol>
2356
2357 </div>
2358<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2359_8c.html" target="source" name="PopImageList">PopImageList</a></h2>
2360<div class="doc-section">
2361
2362<p>PopImageList() removes the last image in the list.</p></ol>
2363
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]2364<p>Deprecated, replace with:</p>
2365
2366<pre class="text">
2367 RemoveLastImageFromList(images);
2368</pre>
2369
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2370<p>The format of the PopImageList method is:</p>
2371
2372<pre class="code">
2373 Image *PopImageList(Image **images)
2374</pre>
2375
2376<p>A description of each parameter follows:</p></ol>
2377
2378<h5>images</h5>
2379<ol><p>the image list.</p></ol>
2380
2381 </div>
2382<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2383_8c.html" target="source" name="PopImagePixels">PopImagePixels</a></h2>
2384<div class="doc-section">
2385
2386<p>PopImagePixels() transfers one or more pixel components from the image pixel cache to a user supplied buffer. The pixels are returned in network byte order. MagickTrue is returned if the pixels are successfully transferred, otherwise MagickFalse.</p></ol>
2387
2388<p>The format of the PopImagePixels method is:</p>
2389
2390<pre class="code">
2391 size_t PopImagePixels(Image *,const QuantumType quantum,
2392 unsigned char *destination)
2393</pre>
2394
2395<p>A description of each parameter follows:</p></ol>
2396
2397<h5>image</h5>
2398<ol><p>the image.</p></ol>
2399
2400<h5>quantum</h5>
2401<ol><p>Declare which pixel components to transfer (RGB, RGBA, etc).</p></ol>
2402
2403<h5>destination</h5>
2404<ol><p>The components are transferred to this buffer.</p></ol>
2405
2406 </div>
2407<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2408_8c.html" target="source" name="PostscriptGeometry">PostscriptGeometry</a></h2>
2409<div class="doc-section">
2410
2411<p>PostscriptGeometry() replaces any page mneumonic with the equivalent size in picas.</p></ol>
2412
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]2413<p>Deprecated, replace with:</p>
2414
2415<pre class="text">
2416 GetPageGeometry(page);
2417</pre>
2418
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2419<p>The format of the PostscriptGeometry method is:</p>
2420
2421<pre class="code">
2422 char *PostscriptGeometry(const char *page)
2423</pre>
2424
2425<p>A description of each parameter follows.</p></ol>
2426
2427<h5> page</h5>
2428<ol><p>Specifies a pointer to an array of characters. The string is either a Postscript page name (e.g. A4) or a postscript page geometry (e.g. 612x792+36+36).</p></ol>
2429
2430 </div>
2431<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2432_8c.html" target="source" name="PushImageList">PushImageList</a></h2>
2433<div class="doc-section">
2434
2435<p>PushImageList() adds an image to the end of the list.</p></ol>
2436
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]2437<p>Deprecated, replace with:</p>
2438
2439<pre class="text">
2440 AppendImageToList(images,CloneImageList(image,exception));
2441</pre>
2442
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2443<p>The format of the PushImageList method is:</p>
2444
2445<pre class="code">
2446 unsigned int PushImageList(Image *images,const Image *image,
2447 ExceptionInfo *exception)
2448</pre>
2449
2450<p>A description of each parameter follows:</p></ol>
2451
2452<h5>images</h5>
2453<ol><p>the image list.</p></ol>
2454
2455<h5>image</h5>
2456<ol><p>the image.</p></ol>
2457
2458<h5>exception</h5>
2459<ol><p>return any errors or warnings in this structure.</p></ol>
2460
2461 </div>
2462<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2463_8c.html" target="source" name="PushImagePixels">PushImagePixels</a></h2>
2464<div class="doc-section">
2465
2466<p>PushImagePixels() transfers one or more pixel components from a user supplied buffer into the image pixel cache of an image. The pixels are expected in network byte order. It returns MagickTrue if the pixels are successfully transferred, otherwise MagickFalse.</p></ol>
2467
2468<p>The format of the PushImagePixels method is:</p>
2469
2470<pre class="code">
2471 size_t PushImagePixels(Image *image,const QuantumType quantum,
2472 const unsigned char *source)
2473</pre>
2474
2475<p>A description of each parameter follows:</p></ol>
2476
2477<h5>image</h5>
2478<ol><p>the image.</p></ol>
2479
2480<h5>quantum</h5>
2481<ol><p>Declare which pixel components to transfer (red, green, blue, opacity, RGB, or RGBA).</p></ol>
2482
2483<h5>source</h5>
2484<ol><p>The pixel components are transferred from this buffer.</p></ol>
2485
2486 </div>
2487<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2488_8c.html" target="source" name="QuantizationError">QuantizationError</a></h2>
2489<div class="doc-section">
2490
2491<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>
2492
2493<pre class="text">
2494 o mean_error_per_pixel: This value is the mean error for any single
2495 pixel in the image.
2496</pre>
2497
2498<h5>normalized_mean_square_error</h5>
2499<ol><p>This value is the normalized mean quantization error for any single pixel in the image. This distance measure is normalized to a range between 0 and 1. It is independent of the range of red, green, and blue values in the image.</p></ol>
2500
2501<h5>normalized_maximum_square_error</h5>
2502<ol><p>Thsi value is the normalized maximum quantization error for any single pixel in the image. This distance measure is normalized to a range between 0 and 1. It is independent of the range of red, green, and blue values in your image.</p></ol>
2503
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]2504<p>Deprecated, replace with:</p>
2505
2506<pre class="text">
2507 GetImageQuantizeError(image);
2508</pre>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2509
2510<p>The format of the QuantizationError method is:</p>
2511
2512<pre class="code">
2513 unsigned int QuantizationError(Image *image)
2514</pre>
2515
2516<p>A description of each parameter follows.</p></ol>
2517
2518<h5>image</h5>
2519<ol><p>Specifies a pointer to an Image structure; returned from ReadImage.</p></ol>
2520
2521 </div>
2522<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2523_8c.html" target="source" name="RandomChannelThresholdImage">RandomChannelThresholdImage</a></h2>
2524<div class="doc-section">
2525
2526<p>RandomChannelThresholdImage() changes the value of individual pixels based on the intensity of each pixel compared to a random threshold. The result is a low-contrast, two color image.</p></ol>
2527
2528<p>The format of the RandomChannelThresholdImage method is:</p>
2529
2530<pre class="code">
2531 unsigned int RandomChannelThresholdImage(Image *image,
2532 const char *channel, const char *thresholds,
2533 ExceptionInfo *exception)
2534</pre>
2535
2536<p>A description of each parameter follows:</p></ol>
2537
2538<h5>image</h5>
2539<ol><p>the image.</p></ol>
2540
2541<h5>channel</h5>
2542<ol><p>the channel or channels to be thresholded.</p></ol>
2543
2544<h5>thresholds</h5>
2545<ol><p>a geometry string containing LOWxHIGH thresholds. If the string contains 2x2, 3x3, or 4x4, then an ordered dither of order 2, 3, or 4 will be performed instead.</p></ol>
2546
2547<h5>exception</h5>
2548<ol><p>return any errors or warnings in this structure.</p></ol>
2549
2550 </div>
2551<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2552_8c.html" target="source" name="ReacquireMemory">ReacquireMemory</a></h2>
2553<div class="doc-section">
2554
2555<p>ReacquireMemory() changes the size of the memory and returns a pointer to the (possibly moved) block. The contents will be unchanged up to the lesser of the new and old sizes.</p></ol>
2556
2557<p>The format of the ReacquireMemory method is:</p>
2558
2559<pre class="code">
2560 void ReacquireMemory(void **memory,const size_t size)
2561</pre>
2562
2563<p>A description of each parameter follows:</p></ol>
2564
2565<h5>memory</h5>
2566<ol><p>A pointer to a memory allocation. On return the pointer may change but the contents of the original allocation will not.</p></ol>
2567
2568<h5>size</h5>
2569<ol><p>the new size of the allocated memory.</p></ol>
2570
2571 </div>
2572<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
cristy0291e2d2010-04-04 17:50:18 +0000[diff] [blame]2573_8c.html" target="source" name="RecolorImage">RecolorImage</a></h2>
2574<div class="doc-section">
2575
2576<p>RecolorImage() apply color transformation to an image. The method permits saturation changes, hue rotation, luminance to alpha, and various other effects. Although variable-sized transformation matrices can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6 for CMYKA (or RGBA with offsets). The matrix is similar to those used by Adobe Flash except offsets are in column 6 rather than 5 (in support of CMYKA images) and offsets are normalized (divide Flash offset by 255).</p></ol>
2577
2578<p>The format of the RecolorImage method is:</p>
2579
2580<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2581 Image *RecolorImage(const Image *image,const size_t order,
cristy0291e2d2010-04-04 17:50:18 +0000[diff] [blame]2582 const double *color_matrix,ExceptionInfo *exception)
2583</pre>
2584
2585<p>A description of each parameter follows:</p></ol>
2586
2587<h5>image</h5>
2588<ol><p>the image.</p></ol>
2589
2590<h5>order</h5>
2591<ol><p>the number of columns and rows in the recolor matrix.</p></ol>
2592
2593<h5>color_matrix</h5>
2594<ol><p>An array of double representing the recolor matrix.</p></ol>
2595
2596<h5>exception</h5>
2597<ol><p>return any errors or warnings in this structure.</p></ol>
2598
2599 </div>
2600<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2601_8c.html" target="source" name="ResetImageAttributeIterator">ResetImageAttributeIterator</a></h2>
2602<div class="doc-section">
2603
2604<p>ResetImageAttributeIterator() resets the image attributes iterator. Use it in conjunction with GetNextImageAttribute() to iterate over all the values associated with an image.</p></ol>
2605
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]2606<p>Deprecated, replace with:</p>
2607
2608<pre class="text">
2609 ResetImagePropertyIterator(image);
2610</pre>
2611
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2612<p>The format of the ResetImageAttributeIterator method is:</p>
2613
2614<pre class="code">
2615 ResetImageAttributeIterator(const ImageInfo *image)
2616</pre>
2617
2618<p>A description of each parameter follows:</p></ol>
2619
2620<h5>image</h5>
2621<ol><p>the image.</p></ol>
2622
2623 </div>
2624<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2625_8c.html" target="source" name="SetCacheViewPixels">SetCacheViewPixels</a></h2>
2626<div class="doc-section">
2627
2628<p>SetCacheViewPixels() gets pixels from the in-memory or disk pixel cache as defined by the geometry parameters. A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.</p></ol>
2629
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]2630<p>Deprecated, replace with:</p>
2631
2632<pre class="text">
2633 QueueCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
2634 GetCacheViewException(cache_view));
2635</pre>
2636
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2637<p>The format of the SetCacheViewPixels method is:</p>
2638
2639<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2640 PixelPacket *SetCacheViewPixels(CacheView *cache_view,const ssize_t x,
2641 const ssize_t y,const size_t columns,const size_t rows)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2642</pre>
2643
2644<p>A description of each parameter follows:</p></ol>
2645
2646<h5>cache_view</h5>
2647<ol><p>the cache view.</p></ol>
2648
2649<h5>x,y,columns,rows</h5>
2650<ol><p>These values define the perimeter of a region of pixels.</p></ol>
2651
2652 </div>
2653<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2654_8c.html" target="source" name="SetExceptionInfo">SetExceptionInfo</a></h2>
2655<div class="doc-section">
2656
2657<p>SetExceptionInfo() sets the exception severity.</p></ol>
2658
2659<p>The format of the SetExceptionInfo method is:</p>
2660
2661<pre class="code">
2662 MagickBooleanType SetExceptionInfo(ExceptionInfo *exception,
2663 ExceptionType severity)
2664</pre>
2665
2666<p>A description of each parameter follows:</p></ol>
2667
2668<h5>exception</h5>
2669<ol><p>the exception info.</p></ol>
2670
2671<h5>severity</h5>
2672<ol><p>the exception severity.</p></ol>
2673
2674 </div>
2675<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2676_8c.html" target="source" name="SetImage">SetImage</a></h2>
2677<div class="doc-section">
2678
2679<p>SetImage() sets the red, green, and blue components of each pixel to the image background color and the opacity component to the specified level of transparency. The background color is defined by the background_color member of the image.</p></ol>
2680
2681<p>The format of the SetImage method is:</p>
2682
2683<pre class="code">
2684 void SetImage(Image *image,const Quantum opacity)
2685</pre>
2686
2687<p>A description of each parameter follows:</p></ol>
2688
2689<h5>image</h5>
2690<ol><p>the image.</p></ol>
2691
2692<h5>opacity</h5>
2693<ol><p>Set each pixel to this level of transparency.</p></ol>
2694
2695 </div>
2696<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2697_8c.html" target="source" name="SetImageAttribute">SetImageAttribute</a></h2>
2698<div class="doc-section">
2699
cristyc0268122009-10-07 00:39:01 +0000[diff] [blame]2700<p>SetImageAttribute() searches the list of image attributes and replaces the attribute value. If it is not found in the list, the attribute name and value is added to the list.</p></ol>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2701
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]2702<p>Deprecated, replace with:</p>
2703
2704<pre class="text">
2705 SetImageProperty(image,key,value);
2706</pre>
2707
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2708<p>The format of the SetImageAttribute method is:</p>
2709
2710<pre class="code">
2711 MagickBooleanType SetImageAttribute(Image *image,const char *key,
2712 const char *value)
2713</pre>
2714
2715<p>A description of each parameter follows:</p></ol>
2716
2717<h5>image</h5>
2718<ol><p>the image.</p></ol>
2719
2720<h5>key</h5>
2721<ol><p>the key.</p></ol>
2722
2723<h5>value</h5>
2724<ol><p>the value.</p></ol>
2725
2726 </div>
2727<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2728_8c.html" target="source" name="SetImageList">SetImageList</a></h2>
2729<div class="doc-section">
2730
2731<p>SetImageList() inserts an image into the list at the specified position.</p></ol>
2732
2733<p>The format of the SetImageList method is:</p>
2734
2735<pre class="code">
2736 unsigned int SetImageList(Image *images,const Image *image,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2737 const ssize_t offset,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2738</pre>
2739
2740<p>A description of each parameter follows:</p></ol>
2741
2742<h5>images</h5>
2743<ol><p>the image list.</p></ol>
2744
2745<h5>image</h5>
2746<ol><p>the image.</p></ol>
2747
2748<h5>offset</h5>
2749<ol><p>the position within the list.</p></ol>
2750
2751<h5>exception</h5>
2752<ol><p>return any errors or warnings in this structure.</p></ol>
2753
2754 </div>
2755<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2756_8c.html" target="source" name="SetImagePixels">SetImagePixels</a></h2>
2757<div class="doc-section">
2758
2759<p>SetImagePixels() queues a mutable pixel region. If the region is successfully intialized a pointer to a PixelPacket array representing the region is returned, otherwise NULL is returned. The returned pointer may point to a temporary working buffer for the pixels or it may point to the final location of the pixels in memory.</p></ol>
2760
2761<p>Write-only access means that any existing pixel values corresponding to the region are ignored. This useful while the initial image is being created from scratch, or if the existing pixel values are to be completely replaced without need to refer to their pre-existing values. The application is free to read and write the pixel buffer returned by SetImagePixels() any way it pleases. SetImagePixels() does not initialize the pixel array values. Initializing pixel array values is the application's responsibility.</p></ol>
2762
2763<p>Performance is maximized if the selected region is part of one row, or one or more full rows, since then there is opportunity to access the pixels in-place (without a copy) if the image is in RAM, or in a memory-mapped file. The returned pointer should *never* be deallocated by the user.</p></ol>
2764
2765<p>Pixels accessed via the returned pointer represent a simple array of type PixelPacket. If the image type is CMYK or the storage class is PseudoClass, call GetAuthenticIndexQueue() after invoking GetAuthenticPixels() to obtain the black color component or the colormap indexes (of type IndexPacket) corresponding to the region. Once the PixelPacket (and/or IndexPacket) array has been updated, the changes must be saved back to the underlying image using SyncAuthenticPixels() or they may be lost.</p></ol>
2766
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]2767<p>Deprecated, replace with:</p>
2768
2769<pre class="text">
2770 QueueAuthenticPixels(image,x,y,columns,rows,&image->exception);
2771</pre>
2772
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2773<p>The format of the SetImagePixels() method is:</p>
2774
2775<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2776 PixelPacket *SetImagePixels(Image *image,const ssize_t x,const ssize_t y,
2777 const size_t columns,const size_t rows)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2778</pre>
2779
2780<p>A description of each parameter follows:</p></ol>
2781
2782<h5>pixels</h5>
2783<ol><p>SetImagePixels returns a pointer to the pixels if they are transferred, otherwise a NULL is returned.</p></ol>
2784
2785<h5>image</h5>
2786<ol><p>the image.</p></ol>
2787
2788<h5>x,y,columns,rows</h5>
2789<ol><p>These values define the perimeter of a region of pixels.</p></ol>
2790
2791 </div>
2792<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2793_8c.html" target="source" name="SetMagickRegistry">SetMagickRegistry</a></h2>
2794<div class="doc-section">
2795
2796<p>SetMagickRegistry() sets a blob into the registry and returns a unique ID. If an error occurs, -1 is returned.</p></ol>
2797
2798<p>The format of the SetMagickRegistry method is:</p>
2799
2800<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2801 ssize_t SetMagickRegistry(const RegistryType type,const void *blob,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2802 const size_t length,ExceptionInfo *exception)
2803</pre>
2804
2805<p>A description of each parameter follows:</p></ol>
2806
2807<h5>type</h5>
2808<ol><p>the registry type.</p></ol>
2809
2810<h5>blob</h5>
2811<ol><p>the address of a Binary Large OBject.</p></ol>
2812
2813<h5>length</h5>
2814<ol><p>For a registry type of ImageRegistryType use sizeof(Image) otherise the blob length in number of bytes.</p></ol>
2815
2816<h5>exception</h5>
2817<ol><p>return any errors or warnings in this structure.</p></ol>
2818
2819 </div>
2820<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2821_8c.html" target="source" name="SetMonitorHandler">SetMonitorHandler</a></h2>
2822<div class="doc-section">
2823
2824<p>SetMonitorHandler() sets the monitor handler to the specified method and returns the previous monitor handler.</p></ol>
2825
2826<p>The format of the SetMonitorHandler method is:</p>
2827
2828<pre class="code">
2829 MonitorHandler SetMonitorHandler(MonitorHandler handler)
2830</pre>
2831
2832<p>A description of each parameter follows:</p></ol>
2833
2834<h5>handler</h5>
2835<ol><p>Specifies a pointer to a method to handle monitors.</p></ol>
2836
2837 </div>
2838<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2839_8c.html" target="source" name="ShiftImageList">ShiftImageList</a></h2>
2840<div class="doc-section">
2841
2842<p>ShiftImageList() removes an image from the beginning of the list.</p></ol>
2843
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]2844<p>Deprecated, replace with:</p>
2845
2846<pre class="text">
2847 RemoveFirstImageFromList(images);
2848</pre>
2849
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2850<p>The format of the ShiftImageList method is:</p>
2851
2852<pre class="code">
2853 Image *ShiftImageList(Image **images)
2854</pre>
2855
2856<p>A description of each parameter follows:</p></ol>
2857
2858<h5>images</h5>
2859<ol><p>the image list.</p></ol>
2860
2861 </div>
2862<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2863_8c.html" target="source" name="SpliceImageList">SpliceImageList</a></h2>
2864<div class="doc-section">
2865
2866<p>SpliceImageList() removes the images designated by offset and length from the list and replaces them with the specified list.</p></ol>
2867
2868<p>The format of the SpliceImageList method is:</p>
2869
2870<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]2871 Image *SpliceImageList(Image *images,const ssize_t offset,
2872 const size_t length,const Image *splices,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2873 ExceptionInfo *exception)
2874</pre>
2875
2876<p>A description of each parameter follows:</p></ol>
2877
2878<h5>images</h5>
2879<ol><p>the image list.</p></ol>
2880
2881<h5>offset</h5>
2882<ol><p>the position within the list.</p></ol>
2883
2884<h5>length</h5>
2885<ol><p>the length of the image list to remove.</p></ol>
2886
2887<h5>splice</h5>
2888<ol><p>Replace the removed image list with this list.</p></ol>
2889
2890<h5>exception</h5>
2891<ol><p>return any errors or warnings in this structure.</p></ol>
2892
2893 </div>
2894<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2895_8c.html" target="source" name="Strip">Strip</a></h2>
2896<div class="doc-section">
2897
2898<p>Strip() strips any whitespace or quotes from the beginning and end of a string of characters.</p></ol>
2899
2900<p>The format of the Strip method is:</p>
2901
2902<pre class="code">
2903 void Strip(char *message)
2904</pre>
2905
2906<p>A description of each parameter follows:</p></ol>
2907
2908<h5>message</h5>
2909<ol><p>Specifies an array of characters.</p></ol>
2910
2911 </div>
2912<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2913_8c.html" target="source" name="SyncCacheView">SyncCacheView</a></h2>
2914<div class="doc-section">
2915
2916<p>SyncCacheView() saves the cache view pixels to the in-memory or disk cache. It returns MagickTrue if the pixel region is synced, otherwise MagickFalse.</p></ol>
2917
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]2918<p>Deprecated, replace with:</p>
2919
2920<pre class="text">
2921 SyncCacheViewAuthenticPixels(cache_view,GetCacheViewException(cache_view));
2922</pre>
2923
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2924<p>The format of the SyncCacheView method is:</p>
2925
2926<pre class="code">
2927 MagickBooleanType SyncCacheView(CacheView *cache_view)
2928</pre>
2929
2930<p>A description of each parameter follows:</p></ol>
2931
2932<h5>cache_view</h5>
2933<ol><p>the cache view.</p></ol>
2934
2935 </div>
2936<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2937_8c.html" target="source" name="SyncCacheViewPixels">SyncCacheViewPixels</a></h2>
2938<div class="doc-section">
2939
2940<p>SyncCacheViewPixels() saves the cache view pixels to the in-memory or disk cache. It returns MagickTrue if the pixel region is flushed, otherwise MagickFalse.</p></ol>
2941
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]2942<p>Deprecated, replace with:</p>
2943
2944<pre class="text">
2945 SyncCacheViewAuthenticPixels(cache_view,GetCacheViewException(cache_view));
2946</pre>
2947
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2948<p>The format of the SyncCacheViewPixels method is:</p>
2949
2950<pre class="code">
2951 MagickBooleanType SyncCacheViewPixels(CacheView *cache_view)
2952</pre>
2953
2954<p>A description of each parameter follows:</p></ol>
2955
2956<h5>cache_view</h5>
2957<ol><p>the cache view.</p></ol>
2958
2959<h5>exception</h5>
2960<ol><p>return any errors or warnings in this structure.</p></ol>
2961
2962 </div>
2963<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2964_8c.html" target="source" name="SyncImagePixels">SyncImagePixels</a></h2>
2965<div class="doc-section">
2966
2967<p>SyncImagePixels() saves the image pixels to the in-memory or disk cache. The method returns MagickTrue if the pixel region is synced, otherwise MagickFalse.</p></ol>
2968
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]2969<p>Deprecated, replace with:</p>
2970
2971<pre class="text">
2972 SyncAuthenticPixels(image,&image->exception);
2973</pre>
2974
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]2975<p>The format of the SyncImagePixels() method is:</p>
2976
2977<pre class="code">
2978 MagickBooleanType SyncImagePixels(Image *image)
2979</pre>
2980
2981<p>A description of each parameter follows:</p></ol>
2982
2983<h5>image</h5>
2984<ol><p>the image.</p></ol>
2985
2986 </div>
2987<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2988_8c.html" target="source" name="TemporaryFilename">TemporaryFilename</a></h2>
2989<div class="doc-section">
2990
2991<p>TemporaryFilename() replaces the contents of path by a unique path name.</p></ol>
2992
2993<p>The format of the TemporaryFilename method is:</p>
2994
2995<pre class="code">
2996 void TemporaryFilename(char *path)
2997</pre>
2998
2999<p>A description of each parameter follows.</p></ol>
3000
3001<h5> path</h5>
3002<ol><p>Specifies a pointer to an array of characters. The unique path name is returned in this array.</p></ol>
3003
3004 </div>
3005<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
3006_8c.html" target="source" name="ThresholdImage">ThresholdImage</a></h2>
3007<div class="doc-section">
3008
3009<p>ThresholdImage() changes the value of individual pixels based on the intensity of each pixel compared to threshold. The result is a high-contrast, two color image.</p></ol>
3010
3011<p>The format of the ThresholdImage method is:</p>
3012
3013<pre class="code">
3014 unsigned int ThresholdImage(Image *image,const double threshold)
3015</pre>
3016
3017<p>A description of each parameter follows:</p></ol>
3018
3019<h5>image</h5>
3020<ol><p>the image.</p></ol>
3021
3022<h5>threshold</h5>
3023<ol><p>Define the threshold value</p></ol>
3024
3025 </div>
3026<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
3027_8c.html" target="source" name="ThresholdImageChannel">ThresholdImageChannel</a></h2>
3028<div class="doc-section">
3029
3030<p>ThresholdImageChannel() changes the value of individual pixels based on the intensity of each pixel channel. The result is a high-contrast image.</p></ol>
3031
3032<p>The format of the ThresholdImageChannel method is:</p>
3033
3034<pre class="code">
3035 unsigned int ThresholdImageChannel(Image *image,const char *threshold)
3036</pre>
3037
3038<p>A description of each parameter follows:</p></ol>
3039
3040<h5>image</h5>
3041<ol><p>the image.</p></ol>
3042
3043<h5>threshold</h5>
3044<ol><p>define the threshold values.</p></ol>
3045
3046 </div>
3047<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
3048_8c.html" target="source" name="TransformHSL">TransformHSL</a></h2>
3049<div class="doc-section">
3050
3051<p>TransformHSL() converts a (red, green, blue) to a (hue, saturation, lightness) triple.</p></ol>
3052
3053<p>The format of the TransformHSL method is:</p>
3054
3055<pre class="code">
3056 void TransformHSL(const Quantum red,const Quantum green,
3057 const Quantum blue,double *hue,double *saturation,double *lightness)
3058</pre>
3059
3060<p>A description of each parameter follows:</p></ol>
3061
3062<h5>red, green, blue</h5>
3063<ol><p>A Quantum value representing the red, green, and blue component of a pixel..</p></ol>
3064
3065<h5>hue, saturation, lightness</h5>
3066<ol><p>A pointer to a double value representing a component of the HSL color space.</p></ol>
3067
3068 </div>
3069<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
3070_8c.html" target="source" name="TranslateText">TranslateText</a></h2>
3071<div class="doc-section">
3072
3073<p>TranslateText() replaces any embedded formatting characters with the appropriate image attribute and returns the translated text.</p></ol>
3074
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]3075<p>Deprecated, replace with:</p>
3076
3077<pre class="text">
3078 InterpretImageProperties(image_info,image,embed_text);
3079</pre>
3080
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3081<p>The format of the TranslateText method is:</p>
3082
3083<pre class="code">
3084 char *TranslateText(const ImageInfo *image_info,Image *image,
3085 const char *embed_text)
3086</pre>
3087
3088<p>A description of each parameter follows:</p></ol>
3089
3090<h5>image_info</h5>
3091<ol><p>the image info.</p></ol>
3092
3093<h5>image</h5>
3094<ol><p>the image.</p></ol>
3095
3096<h5>embed_text</h5>
3097<ol><p>the address of a character string containing the embedded formatting characters.</p></ol>
3098
3099 </div>
3100<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
3101_8c.html" target="source" name="TransparentImage">TransparentImage</a></h2>
3102<div class="doc-section">
3103
3104<p>TransparentImage() changes the opacity value associated with any pixel that matches color to the value defined by opacity.</p></ol>
3105
3106<p>By default color must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. Fuzz defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color.</p></ol>
3107
3108<p>The format of the TransparentImage method is:</p>
3109
3110<pre class="code">
3111 MagickBooleanType TransparentImage(Image *image,
3112 const PixelPacket target,const Quantum opacity)
3113</pre>
3114
3115<p>A description of each parameter follows:</p></ol>
3116
3117<h5>image</h5>
3118<ol><p>the image.</p></ol>
3119
3120<h5>target</h5>
3121<ol><p>the RGB value of the target color.</p></ol>
3122
3123<h5>opacity</h5>
3124<ol><p>the replacement opacity value.</p></ol>
3125
3126 </div>
3127<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
3128_8c.html" target="source" name="UnshiftImageList">UnshiftImageList</a></h2>
3129<div class="doc-section">
3130
3131<p>UnshiftImageList() adds the image to the beginning of the list.</p></ol>
3132
cristy9aed3a22010-05-26 23:41:22 +0000[diff] [blame]3133<p>Deprecated, replace with:</p>
3134
3135<pre class="text">
3136 PrependImageToList(images,CloneImageList(image,exception));
3137</pre>
3138
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]3139<p>The format of the UnshiftImageList method is:</p>
3140
3141<pre class="code">
3142 unsigned int UnshiftImageList(Image *images,const Image *image,
3143 ExceptionInfo *exception)
3144</pre>
3145
3146<p>A description of each parameter follows:</p></ol>
3147
3148<h5>images</h5>
3149<ol><p>the image list.</p></ol>
3150
3151<h5>image</h5>
3152<ol><p>the image.</p></ol>
3153
3154<h5>exception</h5>
3155<ol><p>return any errors or warnings in this structure.</p></ol>
3156
3157 </div>
cristy73fd1cd2010-09-12 19:14:25 +0000[diff] [blame]3158<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
3159_8c.html" target="source" name="ZoomImage">ZoomImage</a></h2>
3160<div class="doc-section">
3161
3162<p>ZoomImage() creates a new image that is a scaled size of an existing one. It allocates the memory necessary for the new Image structure and returns a pointer to the new image. The Point filter gives fast pixel replication, Triangle is equivalent to bi-linear interpolation, and Mitchel giver slower, very high-quality results. See Graphic Gems III for details on this algorithm.</p></ol>
3163
3164<p>The filter member of the Image structure specifies which image filter to use. Blur specifies the blur factor where > 1 is blurry, < 1 is sharp.</p></ol>
3165
3166<p>The format of the ZoomImage method is:</p>
3167
3168<pre class="code">
3169 Image *ZoomImage(const Image *image,const size_t columns,
3170 const size_t rows,ExceptionInfo *exception)
3171</pre>
3172
3173<p>A description of each parameter follows:</p></ol>
3174
3175<h5>image</h5>
3176<ol><p>the image.</p></ol>
3177
3178<h5>columns</h5>
3179<ol><p>An integer that specifies the number of columns in the zoom image.</p></ol>
3180
3181<h5>rows</h5>
3182<ol><p>An integer that specifies the number of rows in the scaled image.</p></ol>
3183
3184<h5>exception</h5>
3185<ol><p>return any errors or warnings in this structure.</p></ol>
3186
3187 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]3188
3189</div>
3190
3191<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]3192 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]3193 <span id="linkbar-center">
3194 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]3195 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]3196 </span>
3197 <span id="linkbar-east">&nbsp;</span>
3198 </div>
3199 <div class="footer">
3200 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
3201 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
3202 </div>
3203 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]3204 <script type="text/javascript">
3205 var _gaq = _gaq || [];
3206 _gaq.push(['_setAccount', 'UA-17690367-1']);
3207 _gaq.push(['_trackPageview']);
3208
3209 (function() {
3210 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
3211 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
3212 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
3213 })();
3214 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]3215</body>
3216</html>