| Current Path : /usr/local/share/doc/ImageMagick/www/api/ |
FreeBSD hs32.drive.ne.jp 9.1-RELEASE FreeBSD 9.1-RELEASE #1: Wed Jan 14 12:18:08 JST 2015 root@hs32.drive.ne.jp:/sys/amd64/compile/hs32 amd64 |
| Current File : //usr/local/share/doc/ImageMagick/www/api/deprecate.html |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<style type="text/css" media="screen,projection"><!--
@import url("../../www/magick.css");
--></style>
<meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
<link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
<title>ImageMagick: MagickCore, C API for ImageMagick: Deprecated Methods</title>
<meta http-equiv="Content-Language" content="en-US"/>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
<meta name="Generator" content="PHP"/>
<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"/>
<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."/>
<meta name="Rating" content="GENERAL"/>
<meta name="Robots" content="INDEX, FOLLOW"/>
<meta name="Generator" content="ImageMagick Studio LLC"/>
<meta name="Author" content="ImageMagick Studio LLC"/>
<meta name="Revisit-after" content="2 DAYS"/>
<meta name="Resource-type" content="document"/>
<meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
<meta name="Distribution" content="Global"/>
<link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
</head>
<body id="www-imagemagick-org">
<div class="titlebar">
<a href="../../index.html">
<img src="../../images/script.png" alt="[ImageMagick]"
style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
<a href="http://www.networkredux.com">
<img src="../../images/networkredux.png" alt="[sponsor]"
style="margin: 45px auto; border: 0px; float: left;" /></a>
<a href="http://www.imagemagick.org/discourse-server/">
<img src="../../images/logo.jpg" alt=""
style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
<a href="../../index.html">
<img src="../../images/sprite.jpg" alt=""
style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
</div>
<div class="eastbar">
<div class="menu">
<a href="../../index.html">About ImageMagick</a>
</div>
<div class="sep"></div>
<div class="menu">
<a href="../../www/command-line-tools.html">Command-line Tools</a>
</div>
<div class="sub">
<a href="../../www/command-line-processing.html">Processing</a>
</div>
<div class="sub">
<a href="../../www/command-line-options.html">Options</a>
</div>
<div class="sub">
<a href="http://www.imagemagick.org/Usage/">Usage</a>
</div>
<div class="menu">
<a href="../../www/api.html">Program Interfaces</a>
</div>
<div class="sub">
<a href="../../www/magick-wand.html">MagickWand</a>
</div>
<div class="sub">
<a href="../../www/magick-core.html">MagickCore</a>
</div>
<div class="sub">
<a href="../../www/perl-magick.html">PerlMagick</a>
</div>
<div class="sub">
<a href="../../Magick++/">Magick++</a>
</div>
<div class="menu">
<a href="../../www/architecture.html">Architecture</a>
</div>
<div class="sep"></div>
<div class="menu">
<a href="../../www/install-source.html">Install from Source</a>
</div>
<div class="sub">
<a href="../../www/install-source.html#unix">Unix</a>
</div>
<div class="sub">
<a href="../../www/install-source.html#windows">Windows</a>
</div>
<div class="menu">
<a href="../../www/binary-releases.html">Binary Releases</a>
</div>
<div class="sub">
<a href="../../www/binary-releases.html#unix">Unix</a>
</div>
<div class="sub">
<a href="../../www/binary-releases.html#macosx">Mac OS X</a>
</div>
<div class="sub">
<a href="../../www/binary-releases.html#windows">Windows</a>
</div>
<div class="menu">
<a href="../../www/resources.html">Resources</a>
</div>
<div class="sep"></div>
<div class="menu">
<a href="../../www/download.html">Download</a>
</div>
<div class="sep"></div>
<div class="menu">
<a href="../http://www.imagemagick.org/script/search.php">Search</a>
</div><div class="sep"></div>
<div class="menu">
<a href="../../www/sitemap.html">Site Map</a>
</div>
<div class="sub">
<a href="../../www/links.html">Links</a>
</div>
<div class="sep"></div>
<div class="menu">
<a href="../../www/sponsors.html">Sponsors:</a>
<div class="sponsbox">
<div class="sponsor">
<a href="http://www.wischmop-shop.de">Wischmop</a><!-- 200905070040+ -->
</div>
<div class="sponsor">
<a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
</div>
<div class="sponsor">
<a href="http://www.online-kredit-index.de">Kredit</a><!-- 200905010120 -->
</div>
<div class="sponsor">
<a href="http://www.posters555.com">Poster</a><!-- 200903010800 -->
</div>
</div>
</div>
</div>
<div class="main">
<p class="navigation-index">[ <a href="#AcquireCacheViewIndexes">AcquireCacheViewIndexes</a> | <a href="#AcquireCacheViewPixels">AcquireCacheViewPixels</a> | <a href="#AcquireImagePixels">AcquireImagePixels</a> | <a href="#AcquireIndexes">AcquireIndexes</a> | <a href="#AcquireMemory">AcquireMemory</a> | <a href="#AcquireOneCacheViewPixel">AcquireOneCacheViewPixel</a> | <a href="#AcquireOneCacheViewVirtualPixel">AcquireOneCacheViewVirtualPixel</a> | <a href="#AcquireOneMagickPixel">AcquireOneMagickPixel</a> | <a href="#AcquireOnePixel">AcquireOnePixel</a> | <a href="#AcquireOneVirtualPixel">AcquireOneVirtualPixel</a> | <a href="#AcquirePixels">AcquirePixels</a> | <a href="#AffinityImage">AffinityImage</a> | <a href="#AffinityImages">AffinityImages</a> | <a href="#AllocateImage">AllocateImage</a> | <a href="#AllocateImageColormap">AllocateImageColormap</a> | <a href="#AllocateNextImage">AllocateNextImage</a> | <a href="#AllocateString">AllocateString</a> | <a href="#ChannelThresholdImage">ChannelThresholdImage</a> | <a href="#ClipPathImage">ClipPathImage</a> | <a href="#CloneImageAttributes">CloneImageAttributes</a> | <a href="#CloneMemory">CloneMemory</a> | <a href="#CloseCacheView">CloseCacheView</a> | <a href="#ColorFloodfill">ColorFloodfill</a> | <a href="#DeleteImageAttribute">DeleteImageAttribute</a> | <a href="#DeleteImageList">DeleteImageList</a> | <a href="#DeleteMagickRegistry">DeleteMagickRegistry</a> | <a href="#DescribeImage">DescribeImage</a> | <a href="#DestroyImageAttributes">DestroyImageAttributes</a> | <a href="#DestroyImages">DestroyImages</a> | <a href="#DestroyMagick">DestroyMagick</a> | <a href="#DispatchImage">DispatchImage</a> | <a href="#FlattenImages">FlattenImages</a> | <a href="#FormatImageAttribute">FormatImageAttribute</a> | <a href="#FormatString">FormatString</a> | <a href="#GetConfigureBlob">GetConfigureBlob</a> | <a href="#GetCacheView">GetCacheView</a> | <a href="#GetCacheViewIndexes">GetCacheViewIndexes</a> | <a href="#GetCacheViewPixels">GetCacheViewPixels</a> | <a href="#GetImageAttribute">GetImageAttribute</a> | <a href="#GetImageClippingPathAttribute">GetImageClippingPathAttribute</a> | <a href="#GetImageFromMagickRegistry">GetImageFromMagickRegistry</a> | <a href="#GetMagickRegistry">GetMagickRegistry</a> | <a href="#GetImageGeometry">GetImageGeometry</a> | <a href="#GetImageList">GetImageList</a> | <a href="#GetImageListIndex">GetImageListIndex</a> | <a href="#GetImageListSize">GetImageListSize</a> | <a href="#GetImagePixels">GetImagePixels</a> | <a href="#GetIndexes">GetIndexes</a> | <a href="#GetNextImage">GetNextImage</a> | <a href="#GetNextImageAttribute">GetNextImageAttribute</a> | <a href="#GetNumberScenes">GetNumberScenes</a> | <a href="#GetOnePixel">GetOnePixel</a> | <a href="#GetPixels">GetPixels</a> | <a href="#GetPreviousImage">GetPreviousImage</a> | <a href="#HSLTransform">HSLTransform</a> | <a href="#IdentityAffine">IdentityAffine</a> | <a href="#InitializeMagick">InitializeMagick</a> | <a href="#InterpolatePixelColor">InterpolatePixelColor</a> | <a href="#InterpretImageAttributes">InterpretImageAttributes</a> | <a href="#LiberateMemory">LiberateMemory</a> | <a href="#LiberateSemaphoreInfo">LiberateSemaphoreInfo</a> | <a href="#MagickIncarnate">MagickIncarnate</a> | <a href="#MagickMonitor">MagickMonitor</a> | <a href="#MapImage">MapImage</a> | <a href="#MapImages">MapImages</a> | <a href="#MatteFloodfill">MatteFloodfill</a> | <a href="#MosaicImages">MosaicImages</a> | <a href="#OpaqueImage">OpaqueImage</a> | <a href="#OpenCacheView">OpenCacheView</a> | <a href="#PaintFloodfill">PaintFloodfill</a> | <a href="#PaintOpaqueImage">PaintOpaqueImage</a> | <a href="#PaintTransparentImage">PaintTransparentImage</a> | <a href="#ParseSizeGeometry">ParseSizeGeometry</a> | <a href="#PopImageList">PopImageList</a> | <a href="#PopImagePixels">PopImagePixels</a> | <a href="#PostscriptGeometry">PostscriptGeometry</a> | <a href="#PushImageList">PushImageList</a> | <a href="#PushImagePixels">PushImagePixels</a> | <a href="#QuantizationError">QuantizationError</a> | <a href="#RandomChannelThresholdImage">RandomChannelThresholdImage</a> | <a href="#ReacquireMemory">ReacquireMemory</a> | <a href="#ResetImageAttributeIterator">ResetImageAttributeIterator</a> | <a href="#SetCacheViewPixels">SetCacheViewPixels</a> | <a href="#SetExceptionInfo">SetExceptionInfo</a> | <a href="#SetImage">SetImage</a> | <a href="#SetImageAttribute">SetImageAttribute</a> | <a href="#SetImageList">SetImageList</a> | <a href="#SetImagePixels">SetImagePixels</a> | <a href="#SetMagickRegistry">SetMagickRegistry</a> | <a href="#SetMonitorHandler">SetMonitorHandler</a> | <a href="#ShiftImageList">ShiftImageList</a> | <a href="#SpliceImageList">SpliceImageList</a> | <a href="#Strip">Strip</a> | <a href="#SyncCacheView">SyncCacheView</a> | <a href="#SyncCacheViewPixels">SyncCacheViewPixels</a> | <a href="#SyncImagePixels">SyncImagePixels</a> | <a href="#TemporaryFilename">TemporaryFilename</a> | <a href="#ThresholdImage">ThresholdImage</a> | <a href="#ThresholdImageChannel">ThresholdImageChannel</a> | <a href="#TransformHSL">TransformHSL</a> | <a href="#TranslateText">TranslateText</a> | <a href="#TransparentImage">TransparentImage</a> | <a href="#UnshiftImageList">UnshiftImageList</a> ]</p>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="AcquireCacheViewIndexes">AcquireCacheViewIndexes</a></h2>
</div>
<p>AcquireCacheViewIndexes() returns the indexes associated with the specified view.</p></ol>
<p>The format of the AcquireCacheViewIndexes method is:</p>
<pre class="code">
const IndexPacket *AcquireCacheViewIndexes(const ViewInfo *cache_view)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>cache_view</h5>
<ol><p>the cache view.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="AcquireCacheViewPixels">AcquireCacheViewPixels</a></h2>
</div>
<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>
<p>The format of the AcquireCacheViewPixels method is:</p>
<pre class="code">
const PixelPacket *AcquireCacheViewPixels(const ViewInfo *cache_view,
const long x,const long y,const unsigned long columns,
const unsigned long rows,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>cache_view</h5>
<ol><p>the cache view.</p></ol>
<h5>x,y,columns,rows</h5>
<ol><p>These values define the perimeter of a region of pixels.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="AcquireImagePixels">AcquireImagePixels</a></h2>
</div>
<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>
<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>
<p>If you plan to modify the pixels, use GetAuthenticPixels() instead.</p></ol>
<p>Note, the AcquireImagePixels() and GetAuthenticPixels() methods are not thread-safe. In a threaded environment, use GetCacheViewVirtualPixels() or GetCacheViewAuthenticPixels() instead.</p></ol>
<p>The format of the AcquireImagePixels() method is:</p>
<pre class="code">
const PixelPacket *AcquireImagePixels(const Image *image,const long x,
const long y,const unsigned long columns,const unsigned long rows,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>x,y,columns,rows</h5>
<ol><p>These values define the perimeter of a region of pixels.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="AcquireIndexes">AcquireIndexes</a></h2>
</div>
<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>
<p>The format of the AcquireIndexes() method is:</p>
<pre class="code">
const IndexPacket *AcquireIndexes(const Image *image)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>indexes</h5>
<ol><p>AcquireIndexes() returns the indexes associated with the last call to QueueAuthenticPixels() or GetVirtualPixels().</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="AcquireMemory">AcquireMemory</a></h2>
</div>
<p>AcquireMemory() returns a pointer to a block of memory at least size bytes suitably aligned for any use.</p></ol>
<p>The format of the AcquireMemory method is:</p>
<pre class="code">
void *AcquireMemory(const size_t size)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>size</h5>
<ol><p>the size of the memory in bytes to allocate.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="AcquireOneCacheViewPixel">AcquireOneCacheViewPixel</a></h2>
</div>
<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>
<p>The format of the AcquireOneCacheViewPixel method is:</p>
<pre class="code">
MagickBooleanType AcquireOneCacheViewPixel(const ViewInfo *cache_view,
const long x,const long y,PixelPacket *pixel,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>cache_view</h5>
<ol><p>the cache view.</p></ol>
<h5>x,y</h5>
<ol><p>These values define the offset of the pixel.</p></ol>
<h5>pixel</h5>
<ol><p>return a pixel at the specified (x,y) location.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="AcquireOneCacheViewVirtualPixel">AcquireOneCacheViewVirtualPixel</a></h2>
</div>
<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>
<p>The format of the AcquireOneCacheViewPixel method is:</p>
<pre class="code">
MagickBooleanType AcquireOneCacheViewVirtualPixel(
const ViewInfo *cache_view,
const VirtualPixelMethod virtual_pixel_method,const long x,
const long y,PixelPacket *pixel,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>cache_view</h5>
<ol><p>the cache view.</p></ol>
<h5>virtual_pixel_method</h5>
<ol><p>the virtual pixel method.</p></ol>
<h5>x,y</h5>
<ol><p>These values define the offset of the pixel.</p></ol>
<h5>pixel</h5>
<ol><p>return a pixel at the specified (x,y) location.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="AcquireOneMagickPixel">AcquireOneMagickPixel</a></h2>
</div>
<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>
<p>The format of the AcquireOneMagickPixel() method is:</p>
<pre class="code">
MagickPixelPacket AcquireOneMagickPixel(const Image image,const long x,
const long y,ExceptionInfo exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>x,y</h5>
<ol><p>These values define the location of the pixel to return.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="AcquireOnePixel">AcquireOnePixel</a></h2>
</div>
<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>
<p>The format of the AcquireOnePixel() method is:</p>
<pre class="code">
PixelPacket AcquireOnePixel(const Image image,const long x,
const long y,ExceptionInfo exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>x,y</h5>
<ol><p>These values define the location of the pixel to return.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="AcquireOneVirtualPixel">AcquireOneVirtualPixel</a></h2>
</div>
<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>
<p>The format of the AcquireOneVirtualPixel() method is:</p>
<pre class="code">
PixelPacket AcquireOneVirtualPixel(const Image image,
const VirtualPixelMethod virtual_pixel_method,const long x,
const long y,ExceptionInfo exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>virtual_pixel_method</h5>
<ol><p>the virtual pixel method.</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>x,y</h5>
<ol><p>These values define the location of the pixel to return.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="AcquirePixels">AcquirePixels</a></h2>
</div>
<p>AcquirePixels() returns the pixels associated with the last call to QueueAuthenticPixels() or GetVirtualPixels().</p></ol>
<p>The format of the AcquirePixels() method is:</p>
<pre class="code">
const PixelPacket *AcquirePixels(const Image image)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="AffinityImage">AffinityImage</a></h2>
</div>
<p>AffinityImage() replaces the colors of an image with the closest color from a reference image.</p></ol>
<p>The format of the AffinityImage method is:</p>
<pre class="code">
MagickBooleanType AffinityImage(const QuantizeInfo *quantize_info,
Image *image,const Image *affinity_image)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>quantize_info</h5>
<ol><p>Specifies a pointer to an QuantizeInfo structure.</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>affinity_image</h5>
<ol><p>the reference image.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="AffinityImages">AffinityImages</a></h2>
</div>
<p>AffinityImages() replaces the colors of a sequence of images with the closest color from a reference image.</p></ol>
<p>The format of the AffinityImage method is:</p>
<pre class="code">
MagickBooleanType AffinityImages(const QuantizeInfo *quantize_info,
Image *images,Image *affinity_image)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>quantize_info</h5>
<ol><p>Specifies a pointer to an QuantizeInfo structure.</p></ol>
<h5>images</h5>
<ol><p>the image sequence.</p></ol>
<h5>affinity_image</h5>
<ol><p>the reference image.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="AllocateImage">AllocateImage</a></h2>
</div>
<p>AllocateImage() returns a pointer to an image structure initialized to default values.</p></ol>
<p>The format of the AllocateImage method is:</p>
<pre class="code">
Image *AllocateImage(const ImageInfo *image_info)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image_info</h5>
<ol><p>Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="AllocateImageColormap">AllocateImageColormap</a></h2>
</div>
<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>
<p>The format of the AllocateImageColormap method is:</p>
<pre class="code">
MagickBooleanType AllocateImageColormap(Image *image,
const unsigned long colors)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>colors</h5>
<ol><p>the number of colors in the image colormap.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="AllocateNextImage">AllocateNextImage</a></h2>
</div>
<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>
<p>The format of the AllocateNextImage method is:</p>
<pre class="code">
void AllocateNextImage(const ImageInfo *image_info,Image *image)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image_info</h5>
<ol><p>Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others.</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="AllocateString">AllocateString</a></h2>
</div>
<p>AllocateString() allocates memory for a string and copies the source string to that memory location (and returns it).</p></ol>
<p>The format of the AllocateString method is:</p>
<pre class="code">
char *AllocateString(const char *source)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>source</h5>
<ol><p>A character string.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="ChannelThresholdImage">ChannelThresholdImage</a></h2>
</div>
<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>
<p>The format of the ChannelThresholdImage method is:</p>
<pre class="code">
unsigned int ChannelThresholdImage(Image *image,const char *level)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>level</h5>
<ol><p>define the threshold values.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="ClipPathImage">ClipPathImage</a></h2>
</div>
<p>ClipPathImage() sets the image clip mask based any clipping path information if it exists.</p></ol>
<p>The format of the ClipImage method is:</p>
<pre class="code">
MagickBooleanType ClipPathImage(Image *image,const char *pathname,
const MagickBooleanType inside)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>pathname</h5>
<ol><p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p></ol>
<h5>inside</h5>
<ol><p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="CloneImageAttributes">CloneImageAttributes</a></h2>
</div>
<p>CloneImageAttributes() clones one or more image attributes.</p></ol>
<p>The format of the CloneImageAttributes method is:</p>
<pre class="code">
MagickBooleanType CloneImageAttributes(Image *image,
const Image *clone_image)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>clone_image</h5>
<ol><p>the clone image.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="CloneMemory">CloneMemory</a></h2>
</div>
<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>
<p>The format of the CloneMemory method is:</p>
<pre class="code">
void *CloneMemory(void *destination,const void *source,
const size_t size)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>destination</h5>
<ol><p>the destination.</p></ol>
<h5>source</h5>
<ol><p>the source.</p></ol>
<h5>size</h5>
<ol><p>the size of the memory in bytes to allocate.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="CloseCacheView">CloseCacheView</a></h2>
</div>
<p>CloseCacheView() closes the specified view returned by a previous call to OpenCacheView().</p></ol>
<p>The format of the CloseCacheView method is:</p>
<pre class="code">
ViewInfo *CloseCacheView(ViewInfo *view_info)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>view_info</h5>
<ol><p>the address of a structure of type ViewInfo.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="ColorFloodfill">ColorFloodfill</a></h2>
</div>
<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>
<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>
<p>The format of the ColorFloodfillImage method is:</p>
<pre class="code">
MagickBooleanType ColorFloodfillImage(Image *image,
const DrawInfo *draw_info,const PixelPacket target,
const long x_offset,const long y_offset,const PaintMethod method)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>draw_info</h5>
<ol><p>the draw info.</p></ol>
<h5>target</h5>
<ol><p>the RGB value of the target color.</p></ol>
<h5>x,y</h5>
<ol><p>the starting location of the operation.</p></ol>
<h5>method</h5>
<ol><p>Choose either FloodfillMethod or FillToBorderMethod.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="DeleteImageAttribute">DeleteImageAttribute</a></h2>
</div>
<p>DeleteImageAttribute() deletes an attribute from the image.</p></ol>
<p>The format of the DeleteImageAttribute method is:</p>
<pre class="code">
MagickBooleanType DeleteImageAttribute(Image *image,const char *key)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image info.</p></ol>
<h5>key</h5>
<ol><p>the image key.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="DeleteImageList">DeleteImageList</a></h2>
</div>
<p>DeleteImageList() deletes an image at the specified position in the list.</p></ol>
<p>The format of the DeleteImageList method is:</p>
<pre class="code">
unsigned int DeleteImageList(Image *images,const long offset)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<h5>offset</h5>
<ol><p>the position within the list.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="DeleteMagickRegistry">DeleteMagickRegistry</a></h2>
</div>
<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>
<p>The format of the DeleteMagickRegistry method is:</p>
<pre class="code">
MagickBooleanType DeleteMagickRegistry(const long id)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>id</h5>
<ol><p>the registry id.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="DescribeImage">DescribeImage</a></h2>
</div>
<p>DescribeImage() describes an image by printing its attributes to the file. Attributes include the image width, height, size, and others.</p></ol>
<p>The format of the DescribeImage method is:</p>
<pre class="code">
MagickBooleanType DescribeImage(Image *image,FILE *file,
const MagickBooleanType verbose)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>file</h5>
<ol><p>the file, typically stdout.</p></ol>
<h5>verbose</h5>
<ol><p>A value other than zero prints more detailed information about the image.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="DestroyImageAttributes">DestroyImageAttributes</a></h2>
</div>
<p>DestroyImageAttributes() deallocates memory associated with the image attribute list.</p></ol>
<p>The format of the DestroyImageAttributes method is:</p>
<pre class="code">
DestroyImageAttributes(Image *image)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="DestroyImages">DestroyImages</a></h2>
</div>
<p>DestroyImages() destroys an image list.</p></ol>
<p>The format of the DestroyImages method is:</p>
<pre class="code">
void DestroyImages(Image *image)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image sequence.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="DestroyMagick">DestroyMagick</a></h2>
</div>
<p>DestroyMagick() destroys the ImageMagick environment.</p></ol>
<p>The format of the DestroyMagick function is:</p>
<pre class="text">
DestroyMagick(void)
</pre>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="DispatchImage">DispatchImage</a></h2>
</div>
<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, long, float, or double in the order specified by map.</p></ol>
<p>Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:</p>
<pre class="text">
DispatchImage(image,0,0,640,1,"RGB",CharPixel,pixels,exception);
</pre>
<p>The format of the DispatchImage method is:</p>
<pre class="code">
unsigned int DispatchImage(const Image *image,const long x_offset,
const long y_offset,const unsigned long columns,
const unsigned long rows,const char *map,const StorageType type,
void *pixels,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>x_offset, y_offset, columns, rows</h5>
<ol><p>These values define the perimeter of a region of pixels you want to extract.</p></ol>
<h5>map</h5>
<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>
<h5>type</h5>
<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>
<h5>pixels</h5>
<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>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="FlattenImages">FlattenImages</a></h2>
</div>
<p>FlattenImages() Obsolete Function: Use MergeImageLayers() instead.</p></ol>
<p>The format of the FlattenImage method is:</p>
<pre class="code">
Image *FlattenImage(Image *image,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image sequence.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="FormatImageAttribute">FormatImageAttribute</a></h2>
</div>
<p>FormatImageAttribute() permits formatted key/value pairs to be saved as an image attribute.</p></ol>
<p>The format of the FormatImageAttribute method is:</p>
<pre class="code">
MagickBooleanType FormatImageAttribute(Image *image,const char *key,
const char *format,...)
</pre>
<p>A description of each parameter follows.</p></ol>
<h5> image</h5>
<ol><p>The image.</p></ol>
<h5> key</h5>
<ol><p>The attribute key.</p></ol>
<h5> format</h5>
<ol><p>A string describing the format to use to write the remaining arguments.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="FormatString">FormatString</a></h2>
</div>
<p>FormatString() prints formatted output of a variable argument list.</p></ol>
<p>The format of the FormatString method is:</p>
<pre class="code">
void FormatString(char *string,const char *format,...)
</pre>
<p>A description of each parameter follows.</p></ol>
<h5> string</h5>
<ol><p>Method FormatString returns the formatted string in this character buffer.</p></ol>
<h5> format</h5>
<ol><p>A string describing the format to use to write the remaining arguments.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="GetConfigureBlob">GetConfigureBlob</a></h2>
</div>
<p>GetConfigureBlob() returns the specified configure file as a blob.</p></ol>
<p>The format of the GetConfigureBlob method is:</p>
<pre class="code">
void *GetConfigureBlob(const char *filename,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>filename</h5>
<ol><p>the configure file name.</p></ol>
<h5>path</h5>
<ol><p>return the full path information of the configure file.</p></ol>
<h5>length</h5>
<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>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="GetCacheView">GetCacheView</a></h2>
</div>
<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>
<p>The format of the GetCacheView method is:</p>
<pre class="code">
PixelPacket *GetCacheView(ViewInfo *cache_view,const long x,
const long y,const unsigned long columns,const unsigned long rows)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>cache_view</h5>
<ol><p>the address of a structure of type ViewInfo.</p></ol>
<h5>x,y,columns,rows</h5>
<ol><p>These values define the perimeter of a region of pixels.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="GetCacheViewIndexes">GetCacheViewIndexes</a></h2>
</div>
<p>GetCacheViewIndexes() returns the indexes associated with the specified view.</p></ol>
<p>The format of the GetCacheViewIndexes method is:</p>
<pre class="code">
IndexPacket *GetCacheViewIndexes(ViewInfo *cache_view)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>cache_view</h5>
<ol><p>the cache view.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="GetCacheViewPixels">GetCacheViewPixels</a></h2>
</div>
<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>
<p>The format of the GetCacheViewPixels method is:</p>
<pre class="code">
PixelPacket *GetCacheViewPixels(ViewInfo *cache_view,const long x,
const long y,const unsigned long columns,const unsigned long rows)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>cache_view</h5>
<ol><p>the cache view.</p></ol>
<h5>x,y,columns,rows</h5>
<ol><p>These values define the perimeter of a region of pixels.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="GetImageAttribute">GetImageAttribute</a></h2>
</div>
<p>GetImageAttribute() searches the list of image attributes and returns a pointer to the attribute if it exists otherwise NULL.</p></ol>
<p>The format of the GetImageAttribute method is:</p>
<pre class="code">
const ImageAttribute *GetImageAttribute(const Image *image,
const char *key)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>key</h5>
<ol><p>These character strings are the name of an image attribute to return.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="GetImageClippingPathAttribute">GetImageClippingPathAttribute</a></h2>
</div>
<p>GetImageClippingPathAttribute() searches the list of image attributes and returns a pointer to a clipping path if it exists otherwise NULL.</p></ol>
<p>The format of the GetImageClippingPathAttribute method is:</p>
<pre class="code">
const ImageAttribute *GetImageClippingPathAttribute(Image *image)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>attribute</h5>
<ol><p>Method GetImageClippingPathAttribute returns the clipping path if it exists otherwise NULL.</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="GetImageFromMagickRegistry">GetImageFromMagickRegistry</a></h2>
</div>
<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>
<p>The format of the GetImageFromMagickRegistry method is:</p>
<pre class="code">
Image *GetImageFromMagickRegistry(const char *name,long *id,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>name</h5>
<ol><p>the name of the image to retrieve from the registry.</p></ol>
<h5>id</h5>
<ol><p>the registry id.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="GetMagickRegistry">GetMagickRegistry</a></h2>
</div>
<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>
<p>The format of the GetMagickRegistry method is:</p>
<pre class="code">
const void *GetMagickRegistry(const long id,RegistryType *type,
size_t *length,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>id</h5>
<ol><p>the registry id.</p></ol>
<h5>type</h5>
<ol><p>the registry type.</p></ol>
<h5>length</h5>
<ol><p>the blob length in number of bytes.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="GetImageGeometry">GetImageGeometry</a></h2>
</div>
<p>GetImageGeometry() returns a region as defined by the geometry string with respect to the image and its gravity.</p></ol>
<p>The format of the GetImageGeometry method is:</p>
<pre class="code">
int GetImageGeometry(Image *image,const char *geometry,
const unsigned int size_to_fit,RectangeInfo *region_info)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>flags</h5>
<ol><p>Method GetImageGeometry returns a bitmask that indicates which of the four values were located in the geometry string.</p></ol>
<h5>geometry</h5>
<ol><p>The geometry (e.g. 100x100+10+10).</p></ol>
<h5>size_to_fit</h5>
<ol><p>A value other than 0 means to scale the region so it fits within the specified width and height.</p></ol>
<h5>region_info</h5>
<ol><p>the region as defined by the geometry string with respect to the image and its gravity.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="GetImageList">GetImageList</a></h2>
</div>
<p>GetImageList() returns an image at the specified position in the list.</p></ol>
<p>The format of the GetImageList method is:</p>
<pre class="code">
Image *GetImageList(const Image *images,const long offset,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<h5>offset</h5>
<ol><p>the position within the list.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="GetImageListIndex">GetImageListIndex</a></h2>
</div>
<p>GetImageListIndex() returns the position in the list of the specified image.</p></ol>
<p>The format of the GetImageListIndex method is:</p>
<pre class="code">
long GetImageListIndex(const Image *images)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="GetImageListSize">GetImageListSize</a></h2>
</div>
<p>GetImageListSize() returns the number of images in the list.</p></ol>
<p>The format of the GetImageListSize method is:</p>
<pre class="code">
unsigned long GetImageListSize(const Image *images)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="GetImagePixels">GetImagePixels</a></h2>
</div>
<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>
<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>
<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>
<p>The format of the GetImagePixels() method is:</p>
<pre class="code">
PixelPacket *GetImagePixels(Image *image,const long x,const long y,
const unsigned long columns,const unsigned long rows)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>x,y,columns,rows</h5>
<ol><p>These values define the perimeter of a region of pixels.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="GetIndexes">GetIndexes</a></h2>
</div>
<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>
<p>The format of the GetIndexes() method is:</p>
<pre class="code">
IndexPacket *GetIndexes(const Image *image)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>indexes</h5>
<ol><p>GetIndexes() returns the indexes associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="GetNextImage">GetNextImage</a></h2>
</div>
<p>GetNextImage() returns the next image in a list.</p></ol>
<p>The format of the GetNextImage method is:</p>
<pre class="code">
Image *GetNextImage(const Image *images)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="GetNextImageAttribute">GetNextImageAttribute</a></h2>
</div>
<p>GetNextImageAttribute() gets the next image attribute.</p></ol>
<p>The format of the GetNextImageAttribute method is:</p>
<pre class="code">
const ImageAttribute *GetNextImageAttribute(const Image *image)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="GetNumberScenes">GetNumberScenes</a></h2>
</div>
<p>GetNumberScenes() returns the number of images in the list.</p></ol>
<p>The format of the GetNumberScenes method is:</p>
<pre class="code">
unsigned int GetNumberScenes(const Image *images)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="GetOnePixel">GetOnePixel</a></h2>
</div>
<p>GetOnePixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.</p></ol>
<p>The format of the GetOnePixel() method is:</p>
<pre class="code">
PixelPacket GetOnePixel(const Image image,const long x,const long y)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>x,y</h5>
<ol><p>These values define the location of the pixel to return.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="GetPixels">GetPixels</a></h2>
</div>
<p>GetPixels() returns the pixels associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p></ol>
<p>The format of the GetPixels() method is:</p>
<pre class="code">
PixelPacket *GetPixels(const Image image)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>pixels</h5>
<ol><p>GetPixels() returns the pixels associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="GetPreviousImage">GetPreviousImage</a></h2>
</div>
<p>GetPreviousImage() returns the previous image in a list.</p></ol>
<p>The format of the GetPreviousImage method is:</p>
<pre class="code">
Image *GetPreviousImage(const Image *images)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="HSLTransform">HSLTransform</a></h2>
</div>
<p>HSLTransform() converts a (hue, saturation, lightness) to a (red, green, blue) triple.</p></ol>
<p>The format of the HSLTransformImage method is:</p>
<pre class="code">
void HSLTransform(const double hue,const double saturation,
const double lightness,Quantum *red,Quantum *green,Quantum *blue)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>hue, saturation, lightness</h5>
<ol><p>A double value representing a component of the HSL color space.</p></ol>
<h5>red, green, blue</h5>
<ol><p>A pointer to a pixel component of type Quantum.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="IdentityAffine">IdentityAffine</a></h2>
</div>
<p>IdentityAffine() initializes the affine transform to the identity matrix.</p></ol>
<p>The format of the IdentityAffine method is:</p>
<pre class="code">
IdentityAffine(AffineMatrix *affine)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>affine</h5>
<ol><p>A pointer the affine transform of type AffineMatrix.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="InitializeMagick">InitializeMagick</a></h2>
</div>
<p>InitializeMagick() initializes the ImageMagick environment.</p></ol>
<p>The format of the InitializeMagick function is:</p>
<pre class="text">
InitializeMagick(const char *path)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>path</h5>
<ol><p>the execution path of the current ImageMagick client.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="InterpolatePixelColor">InterpolatePixelColor</a></h2>
</div>
<p>InterpolatePixelColor() applies bi-linear or tri-linear interpolation between a pixel and it's neighbors.</p></ol>
<p>The format of the InterpolatePixelColor method is:</p>
<pre class="code">
MagickPixelPacket InterpolatePixelColor(const Image *image,
ViewInfo *view_info,InterpolatePixelMethod method,const double x,
const double y,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>image_view</h5>
<ol><p>the image cache view.</p></ol>
<h5>type</h5>
<ol><p>the type of pixel color interpolation.</p></ol>
<h5>x,y</h5>
<ol><p>A double representing the current (x,y) position of the pixel.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="InterpretImageAttributes">InterpretImageAttributes</a></h2>
</div>
<p>InterpretImageAttributes() replaces any embedded formatting characters with the appropriate image attribute and returns the translated text.</p></ol>
<p>The format of the InterpretImageAttributes method is:</p>
<pre class="code">
char *InterpretImageAttributes(const ImageInfo *image_info,Image *image,
const char *embed_text)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image_info</h5>
<ol><p>the image info.</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>embed_text</h5>
<ol><p>the address of a character string containing the embedded formatting characters.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="LiberateMemory">LiberateMemory</a></h2>
</div>
<p>LiberateMemory() frees memory that has already been allocated, and NULL's the pointer to it.</p></ol>
<p>The format of the LiberateMemory method is:</p>
<pre class="code">
void LiberateMemory(void **memory)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>memory</h5>
<ol><p>A pointer to a block of memory to free for reuse.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="LiberateSemaphoreInfo">LiberateSemaphoreInfo</a></h2>
</div>
<p>LiberateSemaphoreInfo() relinquishes a semaphore.</p></ol>
<p>The format of the LiberateSemaphoreInfo method is:</p>
<pre class="code">
LiberateSemaphoreInfo(void **semaphore_info)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>semaphore_info</h5>
<ol><p>Specifies a pointer to an SemaphoreInfo structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="MagickIncarnate">MagickIncarnate</a></h2>
</div>
<p>MagickIncarnate() initializes the ImageMagick environment.</p></ol>
<p>The format of the MagickIncarnate function is:</p>
<pre class="text">
MagickIncarnate(const char *path)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>path</h5>
<ol><p>the execution path of the current ImageMagick client.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="MagickMonitor">MagickMonitor</a></h2>
</div>
<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>
<p>The format of the MagickMonitor method is:</p>
<pre class="code">
MagickBooleanType MagickMonitor(const char *text,
const MagickOffsetType offset,const MagickSizeType span,
void *client_data)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>offset</h5>
<ol><p>the position relative to the span parameter which represents how much progress has been made toward completing a task.</p></ol>
<h5>span</h5>
<ol><p>the span relative to completing a task.</p></ol>
<h5>client_data</h5>
<ol><p>the client data.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="MapImage">MapImage</a></h2>
</div>
<p>MapImage() replaces the colors of an image with the closest color from a reference image.</p></ol>
<p>The format of the MapImage method is:</p>
<pre class="code">
MagickBooleanType MapImage(Image *image,const Image *map_image,
const MagickBooleanType dither)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>Specifies a pointer to an Image structure.</p></ol>
<h5>map_image</h5>
<ol><p>the image. Reduce image to a set of colors represented by this image.</p></ol>
<h5>dither</h5>
<ol><p>Set this integer value to something other than zero to dither the mapped image.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="MapImages">MapImages</a></h2>
</div>
<p>MapImages() replaces the colors of a sequence of images with the closest color from a reference image.</p></ol>
<p>The format of the MapImage method is:</p>
<pre class="code">
MagickBooleanType MapImages(Image *images,Image *map_image,
const MagickBooleanType dither)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>Specifies a pointer to a set of Image structures.</p></ol>
<h5>map_image</h5>
<ol><p>the image. Reduce image to a set of colors represented by this image.</p></ol>
<h5>dither</h5>
<ol><p>Set this integer value to something other than zero to dither the quantized image.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="MatteFloodfill">MatteFloodfill</a></h2>
</div>
<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>
<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>
<p>The format of the MatteFloodfillImage method is:</p>
<pre class="code">
MagickBooleanType MatteFloodfillImage(Image *image,
const PixelPacket target,const Quantum opacity,const long x_offset,
const long y_offset,const PaintMethod method)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>target</h5>
<ol><p>the RGB value of the target color.</p></ol>
<h5>opacity</h5>
<ol><p>the level of transparency: 0 is fully opaque and QuantumRange is fully transparent.</p></ol>
<h5>x,y</h5>
<ol><p>the starting location of the operation.</p></ol>
<h5>method</h5>
<ol><p>Choose either FloodfillMethod or FillToBorderMethod.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="MosaicImages">MosaicImages</a></h2>
</div>
<p>MosaicImages() Obsolete Function: Use MergeImageLayers() instead.</p></ol>
<p>The format of the MosaicImage method is:</p>
<pre class="code">
Image *MosaicImages(const Image *image,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image list to be composited together</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="OpaqueImage">OpaqueImage</a></h2>
</div>
<p>OpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
<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>
<p>The format of the OpaqueImage method is:</p>
<pre class="code">
MagickBooleanType OpaqueImage(Image *image,
const PixelPacket *target,const PixelPacket fill)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>target</h5>
<ol><p>the RGB value of the target color.</p></ol>
<h5>fill</h5>
<ol><p>the replacement color.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="OpenCacheView">OpenCacheView</a></h2>
</div>
<p>OpenCacheView() opens a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p></ol>
<p>The format of the OpenCacheView method is:</p>
<pre class="code">
ViewInfo *OpenCacheView(const Image *image)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="PaintFloodfill">PaintFloodfill</a></h2>
</div>
<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>
<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>
<p>The format of the PaintFloodfillImage method is:</p>
<pre class="code">
MagickBooleanType PaintFloodfillImage(Image *image,
const ChannelType channel,const MagickPixelPacket target,const long x,
const long y,const DrawInfo *draw_info,const PaintMethod method)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>channel</h5>
<ol><p>the channel(s).</p></ol>
<h5>target</h5>
<ol><p>the RGB value of the target color.</p></ol>
<h5>x,y</h5>
<ol><p>the starting location of the operation.</p></ol>
<h5>draw_info</h5>
<ol><p>the draw info.</p></ol>
<h5>method</h5>
<ol><p>Choose either FloodfillMethod or FillToBorderMethod.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="PaintOpaqueImage">PaintOpaqueImage</a></h2>
</div>
<p>PaintOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
<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>
<p>The format of the PaintOpaqueImage method is:</p>
<pre class="code">
MagickBooleanType PaintOpaqueImage(Image *image,
const PixelPacket *target,const PixelPacket *fill)
MagickBooleanType PaintOpaqueImageChannel(Image *image,
const ChannelType channel,const PixelPacket *target,
const PixelPacket *fill)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>channel</h5>
<ol><p>the channel(s).</p></ol>
<h5>target</h5>
<ol><p>the RGB value of the target color.</p></ol>
<h5>fill</h5>
<ol><p>the replacement color.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="PaintTransparentImage">PaintTransparentImage</a></h2>
</div>
<p>PaintTransparentImage() changes the opacity value associated with any pixel that matches color to the value defined by opacity.</p></ol>
<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>
<p>The format of the PaintTransparentImage method is:</p>
<pre class="code">
MagickBooleanType PaintTransparentImage(Image *image,
const MagickPixelPacket *target,const Quantum opacity)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>target</h5>
<ol><p>the RGB value of the target color.</p></ol>
<h5>opacity</h5>
<ol><p>the replacement opacity value.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="ParseSizeGeometry">ParseSizeGeometry</a></h2>
</div>
<p>ParseSizeGeometry() returns a region as defined by the geometry string with respect to the image dimensions and aspect ratio.</p></ol>
<p>The format of the ParseSizeGeometry method is:</p>
<pre class="code">
MagickStatusType ParseSizeGeometry(const Image *image,
const char *geometry,RectangeInfo *region_info)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>geometry</h5>
<ol><p>The geometry (e.g. 100x100+10+10).</p></ol>
<h5>region_info</h5>
<ol><p>the region as defined by the geometry string.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="PopImageList">PopImageList</a></h2>
</div>
<p>PopImageList() removes the last image in the list.</p></ol>
<p>The format of the PopImageList method is:</p>
<pre class="code">
Image *PopImageList(Image **images)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="PopImagePixels">PopImagePixels</a></h2>
</div>
<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>
<p>The format of the PopImagePixels method is:</p>
<pre class="code">
size_t PopImagePixels(Image *,const QuantumType quantum,
unsigned char *destination)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>quantum</h5>
<ol><p>Declare which pixel components to transfer (RGB, RGBA, etc).</p></ol>
<h5>destination</h5>
<ol><p>The components are transferred to this buffer.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="PostscriptGeometry">PostscriptGeometry</a></h2>
</div>
<p>PostscriptGeometry() replaces any page mneumonic with the equivalent size in picas.</p></ol>
<p>The format of the PostscriptGeometry method is:</p>
<pre class="code">
char *PostscriptGeometry(const char *page)
</pre>
<p>A description of each parameter follows.</p></ol>
<h5> page</h5>
<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>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="PushImageList">PushImageList</a></h2>
</div>
<p>PushImageList() adds an image to the end of the list.</p></ol>
<p>The format of the PushImageList method is:</p>
<pre class="code">
unsigned int PushImageList(Image *images,const Image *image,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="PushImagePixels">PushImagePixels</a></h2>
</div>
<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>
<p>The format of the PushImagePixels method is:</p>
<pre class="code">
size_t PushImagePixels(Image *image,const QuantumType quantum,
const unsigned char *source)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>quantum</h5>
<ol><p>Declare which pixel components to transfer (red, green, blue, opacity, RGB, or RGBA).</p></ol>
<h5>source</h5>
<ol><p>The pixel components are transferred from this buffer.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="QuantizationError">QuantizationError</a></h2>
</div>
<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>
<pre class="text">
o mean_error_per_pixel: This value is the mean error for any single
pixel in the image.
</pre>
<h5>normalized_mean_square_error</h5>
<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>
<h5>normalized_maximum_square_error</h5>
<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>
<p>The format of the QuantizationError method is:</p>
<pre class="code">
unsigned int QuantizationError(Image *image)
</pre>
<p>A description of each parameter follows.</p></ol>
<h5>image</h5>
<ol><p>Specifies a pointer to an Image structure; returned from ReadImage.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="RandomChannelThresholdImage">RandomChannelThresholdImage</a></h2>
</div>
<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>
<p>The format of the RandomChannelThresholdImage method is:</p>
<pre class="code">
unsigned int RandomChannelThresholdImage(Image *image,
const char *channel, const char *thresholds,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>channel</h5>
<ol><p>the channel or channels to be thresholded.</p></ol>
<h5>thresholds</h5>
<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>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="ReacquireMemory">ReacquireMemory</a></h2>
</div>
<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>
<p>The format of the ReacquireMemory method is:</p>
<pre class="code">
void ReacquireMemory(void **memory,const size_t size)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>memory</h5>
<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>
<h5>size</h5>
<ol><p>the new size of the allocated memory.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="ResetImageAttributeIterator">ResetImageAttributeIterator</a></h2>
</div>
<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>
<p>The format of the ResetImageAttributeIterator method is:</p>
<pre class="code">
ResetImageAttributeIterator(const ImageInfo *image)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="SetCacheViewPixels">SetCacheViewPixels</a></h2>
</div>
<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>
<p>The format of the SetCacheViewPixels method is:</p>
<pre class="code">
PixelPacket *SetCacheViewPixels(ViewInfo *cache_view,const long x,
const long y,const unsigned long columns,const unsigned long rows)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>cache_view</h5>
<ol><p>the cache view.</p></ol>
<h5>x,y,columns,rows</h5>
<ol><p>These values define the perimeter of a region of pixels.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="SetExceptionInfo">SetExceptionInfo</a></h2>
</div>
<p>SetExceptionInfo() sets the exception severity.</p></ol>
<p>The format of the SetExceptionInfo method is:</p>
<pre class="code">
MagickBooleanType SetExceptionInfo(ExceptionInfo *exception,
ExceptionType severity)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>exception</h5>
<ol><p>the exception info.</p></ol>
<h5>severity</h5>
<ol><p>the exception severity.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="SetImage">SetImage</a></h2>
</div>
<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>
<p>The format of the SetImage method is:</p>
<pre class="code">
void SetImage(Image *image,const Quantum opacity)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>opacity</h5>
<ol><p>Set each pixel to this level of transparency.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="SetImageAttribute">SetImageAttribute</a></h2>
</div>
<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>
<p>The format of the SetImageAttribute method is:</p>
<pre class="code">
MagickBooleanType SetImageAttribute(Image *image,const char *key,
const char *value)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>key</h5>
<ol><p>the key.</p></ol>
<h5>value</h5>
<ol><p>the value.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="SetImageList">SetImageList</a></h2>
</div>
<p>SetImageList() inserts an image into the list at the specified position.</p></ol>
<p>The format of the SetImageList method is:</p>
<pre class="code">
unsigned int SetImageList(Image *images,const Image *image,
const long offset,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>offset</h5>
<ol><p>the position within the list.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="SetImagePixels">SetImagePixels</a></h2>
</div>
<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>
<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>
<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>
<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>
<p>The format of the SetImagePixels() method is:</p>
<pre class="code">
PixelPacket *SetImagePixels(Image *image,const long x,const long y,
const unsigned long columns,const unsigned long rows)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>pixels</h5>
<ol><p>SetImagePixels returns a pointer to the pixels if they are transferred, otherwise a NULL is returned.</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>x,y,columns,rows</h5>
<ol><p>These values define the perimeter of a region of pixels.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="SetMagickRegistry">SetMagickRegistry</a></h2>
</div>
<p>SetMagickRegistry() sets a blob into the registry and returns a unique ID. If an error occurs, -1 is returned.</p></ol>
<p>The format of the SetMagickRegistry method is:</p>
<pre class="code">
long SetMagickRegistry(const RegistryType type,const void *blob,
const size_t length,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>type</h5>
<ol><p>the registry type.</p></ol>
<h5>blob</h5>
<ol><p>the address of a Binary Large OBject.</p></ol>
<h5>length</h5>
<ol><p>For a registry type of ImageRegistryType use sizeof(Image) otherise the blob length in number of bytes.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="SetMonitorHandler">SetMonitorHandler</a></h2>
</div>
<p>SetMonitorHandler() sets the monitor handler to the specified method and returns the previous monitor handler.</p></ol>
<p>The format of the SetMonitorHandler method is:</p>
<pre class="code">
MonitorHandler SetMonitorHandler(MonitorHandler handler)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>handler</h5>
<ol><p>Specifies a pointer to a method to handle monitors.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="ShiftImageList">ShiftImageList</a></h2>
</div>
<p>ShiftImageList() removes an image from the beginning of the list.</p></ol>
<p>The format of the ShiftImageList method is:</p>
<pre class="code">
Image *ShiftImageList(Image **images)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="SpliceImageList">SpliceImageList</a></h2>
</div>
<p>SpliceImageList() removes the images designated by offset and length from the list and replaces them with the specified list.</p></ol>
<p>The format of the SpliceImageList method is:</p>
<pre class="code">
Image *SpliceImageList(Image *images,const long offset,
const unsigned long length,const Image *splices,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<h5>offset</h5>
<ol><p>the position within the list.</p></ol>
<h5>length</h5>
<ol><p>the length of the image list to remove.</p></ol>
<h5>splice</h5>
<ol><p>Replace the removed image list with this list.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="Strip">Strip</a></h2>
</div>
<p>Strip() strips any whitespace or quotes from the beginning and end of a string of characters.</p></ol>
<p>The format of the Strip method is:</p>
<pre class="code">
void Strip(char *message)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>message</h5>
<ol><p>Specifies an array of characters.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="SyncCacheView">SyncCacheView</a></h2>
</div>
<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>
<p>The format of the SyncCacheView method is:</p>
<pre class="code">
MagickBooleanType SyncCacheView(ViewInfo *cache_view)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>cache_view</h5>
<ol><p>the cache view.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="SyncCacheViewPixels">SyncCacheViewPixels</a></h2>
</div>
<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>
<p>The format of the SyncCacheViewPixels method is:</p>
<pre class="code">
MagickBooleanType SyncCacheViewPixels(ViewInfo *cache_view)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>cache_view</h5>
<ol><p>the cache view.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="SyncImagePixels">SyncImagePixels</a></h2>
</div>
<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>
<p>The format of the SyncImagePixels() method is:</p>
<pre class="code">
MagickBooleanType SyncImagePixels(Image *image)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="TemporaryFilename">TemporaryFilename</a></h2>
</div>
<p>TemporaryFilename() replaces the contents of path by a unique path name.</p></ol>
<p>The format of the TemporaryFilename method is:</p>
<pre class="code">
void TemporaryFilename(char *path)
</pre>
<p>A description of each parameter follows.</p></ol>
<h5> path</h5>
<ol><p>Specifies a pointer to an array of characters. The unique path name is returned in this array.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="ThresholdImage">ThresholdImage</a></h2>
</div>
<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>
<p>The format of the ThresholdImage method is:</p>
<pre class="code">
unsigned int ThresholdImage(Image *image,const double threshold)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>threshold</h5>
<ol><p>Define the threshold value</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="ThresholdImageChannel">ThresholdImageChannel</a></h2>
</div>
<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>
<p>The format of the ThresholdImageChannel method is:</p>
<pre class="code">
unsigned int ThresholdImageChannel(Image *image,const char *threshold)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>threshold</h5>
<ol><p>define the threshold values.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="TransformHSL">TransformHSL</a></h2>
</div>
<p>TransformHSL() converts a (red, green, blue) to a (hue, saturation, lightness) triple.</p></ol>
<p>The format of the TransformHSL method is:</p>
<pre class="code">
void TransformHSL(const Quantum red,const Quantum green,
const Quantum blue,double *hue,double *saturation,double *lightness)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>red, green, blue</h5>
<ol><p>A Quantum value representing the red, green, and blue component of a pixel..</p></ol>
<h5>hue, saturation, lightness</h5>
<ol><p>A pointer to a double value representing a component of the HSL color space.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="TranslateText">TranslateText</a></h2>
</div>
<p>TranslateText() replaces any embedded formatting characters with the appropriate image attribute and returns the translated text.</p></ol>
<p>The format of the TranslateText method is:</p>
<pre class="code">
char *TranslateText(const ImageInfo *image_info,Image *image,
const char *embed_text)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image_info</h5>
<ol><p>the image info.</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>embed_text</h5>
<ol><p>the address of a character string containing the embedded formatting characters.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="TransparentImage">TransparentImage</a></h2>
</div>
<p>TransparentImage() changes the opacity value associated with any pixel that matches color to the value defined by opacity.</p></ol>
<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>
<p>The format of the TransparentImage method is:</p>
<pre class="code">
MagickBooleanType TransparentImage(Image *image,
const PixelPacket target,const Quantum opacity)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>target</h5>
<ol><p>the RGB value of the target color.</p></ol>
<h5>opacity</h5>
<ol><p>the replacement opacity value.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
_8c.html" target="source" name="UnshiftImageList">UnshiftImageList</a></h2>
</div>
<p>UnshiftImageList() adds the image to the beginning of the list.</p></ol>
<p>The format of the UnshiftImageList method is:</p>
<pre class="code">
unsigned int UnshiftImageList(Image *images,const Image *image,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>images</h5>
<ol><p>the image list.</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<h5>exception</h5>
<ol><p>return any errors or warnings in this structure.</p></ol>
</div>
<div id="linkbar">
<!-- <span id="linkbar-west"> </span> -->
<span id="linkbar-center">
<a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
<a href="../../www/mailing-list.html">Mailing Lists</a> •
<a href="http://cafe.imagemagick.org">Cafe</a> •
<a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
</span>
<span id="linkbar-east"> </span>
</div>
<div class="footer">
<span id="footer-west">© 1999-2009 ImageMagick Studio LLC</span>
<span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
</div>
<div style="clear: both; margin: 0; width: 100%; "></div>
</body>
</html>