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