diff options
Diffstat (limited to 'www/api/pixel_cache.html')
| -rw-r--r-- | www/api/pixel_cache.html | 750 |
1 files changed, 354 insertions, 396 deletions
diff --git a/www/api/pixel_cache.html b/www/api/pixel_cache.html index 8d161a6..bf7ce17 100644 --- a/www/api/pixel_cache.html +++ b/www/api/pixel_cache.html @@ -1,12 +1,14 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<!DOCTYPE html> +<html lang="en"> <head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.16: http://docutils.sourceforge.net/" /> -<title>pixel_cache</title> -<link rel="stylesheet" href="../docutils-api.css" type="text/css" /> + <meta charset="utf-8"> + <meta content="en" name="language"> + <title>pixel_cache</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <link media="screen" href="../docutils-api.css" type="text/css" rel="stylesheet"> + </head> + <body> <div class="banner"> @@ -19,6 +21,7 @@ </form> </div> + <div class="navmenu"> <ul> <li><a href="../index.html">Home</a></li> @@ -32,70 +35,68 @@ <li><a href="../reference.html">Reference</a></li> </ul> </div> + <div class="document" id="pixel-cache"> <h1 class="title">pixel_cache</h1> -<h2 class="subtitle" id="image-pixel-cache-working-pixels">Image pixel cache (working pixels).</h2> - +<p class="subtitle" id="image-pixel-cache-working-pixels">Image pixel cache (working pixels).</p> <div class="contents topic" id="contents"> <p class="topic-title">Contents</p> <ul class="simple"> -<li><a class="reference internal" href="#accesscacheviewpixels" id="id63">AccessCacheViewPixels</a></li> -<li><a class="reference internal" href="#accessimmutableindexes" id="id64">AccessImmutableIndexes</a></li> -<li><a class="reference internal" href="#accessmutableindexes" id="id65">AccessMutableIndexes</a></li> -<li><a class="reference internal" href="#accessmutablepixels" id="id66">AccessMutablePixels</a></li> -<li><a class="reference internal" href="#acquirecacheviewpixels" id="id67">AcquireCacheViewPixels</a></li> -<li><a class="reference internal" href="#acquirecacheviewindexes" id="id68">AcquireCacheViewIndexes</a></li> -<li><a class="reference internal" href="#acquireimagepixels" id="id69">AcquireImagePixels</a></li> -<li><a class="reference internal" href="#acquireonecacheviewpixel" id="id70">AcquireOneCacheViewPixel</a></li> -<li><a class="reference internal" href="#acquireonepixel" id="id71">AcquireOnePixel</a></li> -<li><a class="reference internal" href="#acquireonepixelbyreference" id="id72">AcquireOnePixelByReference</a></li> -<li><a class="reference internal" href="#checkimagepixellimits" id="id73">CheckImagePixelLimits</a></li> -<li><a class="reference internal" href="#destroycacheinfo" id="id74">DestroyCacheInfo</a></li> -<li><a class="reference internal" href="#destroyimagepixels" id="id75">DestroyImagePixels</a></li> -<li><a class="reference internal" href="#getcacheviewpixels" id="id76">GetCacheViewPixels</a></li> -<li><a class="reference internal" href="#getcacheviewimage" id="id77">GetCacheViewImage</a></li> -<li><a class="reference internal" href="#getcacheviewindexes" id="id78">GetCacheViewIndexes</a></li> -<li><a class="reference internal" href="#getimagepixels" id="id79">GetImagePixels</a></li> -<li><a class="reference internal" href="#getimagepixelsex" id="id80">GetImagePixelsEx</a></li> -<li><a class="reference internal" href="#getimagevirtualpixelmethod" id="id81">GetImageVirtualPixelMethod</a></li> -<li><a class="reference internal" href="#getindexes" id="id82">GetIndexes</a></li> -<li><a class="reference internal" href="#getonepixel" id="id83">GetOnePixel</a></li> -<li><a class="reference internal" href="#getpixels" id="id84">GetPixels</a></li> -<li><a class="reference internal" href="#modifycache" id="id85">ModifyCache</a></li> -<li><a class="reference internal" href="#opencacheview" id="id86">OpenCacheView</a></li> -<li><a class="reference internal" href="#referencecache" id="id87">ReferenceCache</a></li> -<li><a class="reference internal" href="#setcacheviewpixels" id="id88">SetCacheViewPixels</a></li> -<li><a class="reference internal" href="#setimagepixels" id="id89">SetImagePixels</a></li> -<li><a class="reference internal" href="#setimagepixelsex" id="id90">SetImagePixelsEx</a></li> -<li><a class="reference internal" href="#setimagevirtualpixelmethod" id="id91">SetImageVirtualPixelMethod</a></li> -<li><a class="reference internal" href="#synccacheviewpixels" id="id92">SyncCacheViewPixels</a></li> -<li><a class="reference internal" href="#syncimagepixels" id="id93">SyncImagePixels</a></li> -<li><a class="reference internal" href="#syncimagepixelsex" id="id94">SyncImagePixelsEx</a></li> +<li><p><a class="reference internal" href="#accesscacheviewpixels" id="id63">AccessCacheViewPixels</a></p></li> +<li><p><a class="reference internal" href="#accessimmutableindexes" id="id64">AccessImmutableIndexes</a></p></li> +<li><p><a class="reference internal" href="#accessmutableindexes" id="id65">AccessMutableIndexes</a></p></li> +<li><p><a class="reference internal" href="#accessmutablepixels" id="id66">AccessMutablePixels</a></p></li> +<li><p><a class="reference internal" href="#acquirecacheviewpixels" id="id67">AcquireCacheViewPixels</a></p></li> +<li><p><a class="reference internal" href="#acquirecacheviewindexes" id="id68">AcquireCacheViewIndexes</a></p></li> +<li><p><a class="reference internal" href="#acquireimagepixels" id="id69">AcquireImagePixels</a></p></li> +<li><p><a class="reference internal" href="#acquireonecacheviewpixel" id="id70">AcquireOneCacheViewPixel</a></p></li> +<li><p><a class="reference internal" href="#acquireonepixel" id="id71">AcquireOnePixel</a></p></li> +<li><p><a class="reference internal" href="#acquireonepixelbyreference" id="id72">AcquireOnePixelByReference</a></p></li> +<li><p><a class="reference internal" href="#checkimagepixellimits" id="id73">CheckImagePixelLimits</a></p></li> +<li><p><a class="reference internal" href="#destroycacheinfo" id="id74">DestroyCacheInfo</a></p></li> +<li><p><a class="reference internal" href="#destroyimagepixels" id="id75">DestroyImagePixels</a></p></li> +<li><p><a class="reference internal" href="#getcacheviewpixels" id="id76">GetCacheViewPixels</a></p></li> +<li><p><a class="reference internal" href="#getcacheviewimage" id="id77">GetCacheViewImage</a></p></li> +<li><p><a class="reference internal" href="#getcacheviewindexes" id="id78">GetCacheViewIndexes</a></p></li> +<li><p><a class="reference internal" href="#getimagepixels" id="id79">GetImagePixels</a></p></li> +<li><p><a class="reference internal" href="#getimagepixelsex" id="id80">GetImagePixelsEx</a></p></li> +<li><p><a class="reference internal" href="#getimagevirtualpixelmethod" id="id81">GetImageVirtualPixelMethod</a></p></li> +<li><p><a class="reference internal" href="#getindexes" id="id82">GetIndexes</a></p></li> +<li><p><a class="reference internal" href="#getonepixel" id="id83">GetOnePixel</a></p></li> +<li><p><a class="reference internal" href="#getpixels" id="id84">GetPixels</a></p></li> +<li><p><a class="reference internal" href="#modifycache" id="id85">ModifyCache</a></p></li> +<li><p><a class="reference internal" href="#opencacheview" id="id86">OpenCacheView</a></p></li> +<li><p><a class="reference internal" href="#referencecache" id="id87">ReferenceCache</a></p></li> +<li><p><a class="reference internal" href="#setcacheviewpixels" id="id88">SetCacheViewPixels</a></p></li> +<li><p><a class="reference internal" href="#setimagepixels" id="id89">SetImagePixels</a></p></li> +<li><p><a class="reference internal" href="#setimagepixelsex" id="id90">SetImagePixelsEx</a></p></li> +<li><p><a class="reference internal" href="#setimagevirtualpixelmethod" id="id91">SetImageVirtualPixelMethod</a></p></li> +<li><p><a class="reference internal" href="#synccacheviewpixels" id="id92">SyncCacheViewPixels</a></p></li> +<li><p><a class="reference internal" href="#syncimagepixels" id="id93">SyncImagePixels</a></p></li> +<li><p><a class="reference internal" href="#syncimagepixelsex" id="id94">SyncImagePixelsEx</a></p></li> </ul> </div> <div class="section" id="accesscacheviewpixels"> <h1><a class="toc-backref" href="#id63">AccessCacheViewPixels</a></h1> <div class="section" id="synopsis"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *AccessCacheViewPixels( const <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *AccessCacheViewPixels( const <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view );</pre> </div> <div class="section" id="description"> <h2>Description</h2> <p>Method AccessCacheViewPixels returns writeable pixels associated with the specified view.</p> <p>The format of the AccessCacheViewPixels method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *AccessCacheViewPixels( const <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *AccessCacheViewPixels( const <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>indexes:</dt> -<dd>Method AccessCacheViewPixels returns the pixels associated with -the specified view.</dd> +<dd><p>Method AccessCacheViewPixels returns the pixels associated with +the specified view.</p> +</dd> <dt>view:</dt> -<dd>The address of a structure of type ViewInfo.</dd> +<dd><p>The address of a structure of type ViewInfo.</p> +</dd> </dl> </div> </div> @@ -103,9 +104,7 @@ the specified view.</dd> <h1><a class="toc-backref" href="#id64">AccessImmutableIndexes</a></h1> <div class="section" id="id1"> <h2>Synopsis</h2> -<pre class="literal-block"> -const IndexPacket *AccessImmutableIndexes( const <a class="reference external" href="../api/types.html#image">Image</a> *image ); -</pre> +<pre class="literal-block">const IndexPacket *AccessImmutableIndexes( const <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre> </div> <div class="section" id="id2"> <h2>Description</h2> @@ -113,16 +112,16 @@ const IndexPacket *AccessImmutableIndexes( const <a class="reference external" h the last call to AcquireImagePixels(). NULL is returned if colormap indexes are not available.</p> <p>The format of the AccessImmutableIndexes() method is:</p> -<pre class="literal-block"> -const IndexPacket *AccessImmutableIndexes( const <a class="reference external" href="../api/types.html#image">Image</a> *image ); -</pre> +<pre class="literal-block">const IndexPacket *AccessImmutableIndexes( const <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>indexes:</dt> -<dd>The indexes associated with the last call to -AcquireImagePixels().</dd> +<dd><p>The indexes associated with the last call to +AcquireImagePixels().</p> +</dd> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> </dl> </div> </div> @@ -130,9 +129,7 @@ AcquireImagePixels().</dd> <h1><a class="toc-backref" href="#id65">AccessMutableIndexes</a></h1> <div class="section" id="id3"> <h2>Synopsis</h2> -<pre class="literal-block"> -IndexPacket *AccessMutableIndexes( <a class="reference external" href="../api/types.html#image">Image</a> *image ); -</pre> +<pre class="literal-block">IndexPacket *AccessMutableIndexes( <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre> </div> <div class="section" id="id4"> <h2>Description</h2> @@ -140,16 +137,16 @@ IndexPacket *AccessMutableIndexes( <a class="reference external" href="../api/ty the last call to SetImagePixels() or GetImagePixels(). NULL is returned if colormap indexes are not available.</p> <p>The format of the AccessMutagleIndexes() method is:</p> -<pre class="literal-block"> -IndexPacket *AccessMutableIndexes( <a class="reference external" href="../api/types.html#image">Image</a> *image ); -</pre> +<pre class="literal-block">IndexPacket *AccessMutableIndexes( <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>indexes:</dt> -<dd>The indexes associated with the last call to -AcquireImagePixels().</dd> +<dd><p>The indexes associated with the last call to +AcquireImagePixels().</p> +</dd> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> </dl> </div> </div> @@ -157,9 +154,7 @@ AcquireImagePixels().</dd> <h1><a class="toc-backref" href="#id66">AccessMutablePixels</a></h1> <div class="section" id="id5"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *AccessMutablePixels( <a class="reference external" href="../api/types.html#image">Image</a> image ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *AccessMutablePixels( <a class="reference external" href="../api/types.html#image">Image</a> image );</pre> </div> <div class="section" id="id6"> <h2>Description</h2> @@ -167,16 +162,16 @@ AcquireImagePixels().</dd> SetImagePixels() or GetImagePixels(). This is useful in order to access an already selected region without passing the geometry of the region.</p> <p>The format of the AccessMutablePixels() method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *AccessMutablePixels( <a class="reference external" href="../api/types.html#image">Image</a> image ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *AccessMutablePixels( <a class="reference external" href="../api/types.html#image">Image</a> image );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>pixels:</dt> -<dd>The pixels associated with the last call to SetImagePixels() -or GetImagePixels().</dd> +<dd><p>The pixels associated with the last call to SetImagePixels() +or GetImagePixels().</p> +</dd> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> </dl> </div> </div> @@ -184,12 +179,10 @@ or GetImagePixels().</dd> <h1><a class="toc-backref" href="#id67">AcquireCacheViewPixels</a></h1> <div class="section" id="id7"> <h2>Synopsis</h2> -<pre class="literal-block"> -const <a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *AcquireCacheViewPixels( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, const long x, const long y, +<pre class="literal-block">const <a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *AcquireCacheViewPixels( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, const long x, const long y, const unsigned long columns, const unsigned long rows, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id8"> <h2>Description</h2> @@ -198,23 +191,25 @@ cache as defined by the geometry parameters for read-only access. A pointer to the pixels is returned if the pixels are transferred, otherwise NULL is returned.</p> <p>The format of the AcquireCacheViewPixels method is:</p> -<pre class="literal-block"> -const <a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *AcquireCacheViewPixels( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, const long x, const long y, +<pre class="literal-block">const <a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *AcquireCacheViewPixels( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, const long x, const long y, const unsigned long columns, const unsigned long rows, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>pixels:</dt> -<dd>Method AcquireCacheViewPixels returns a null pointer if an error -occurs, otherwise a pointer to the view pixels.</dd> +<dd><p>Method AcquireCacheViewPixels returns a null pointer if an error +occurs, otherwise a pointer to the view pixels.</p> +</dd> <dt>view:</dt> -<dd>The address of a structure of type ViewInfo.</dd> +<dd><p>The address of a structure of type ViewInfo.</p> +</dd> <dt>x,y,columns,rows:</dt> -<dd>These values define the perimeter of a region of -pixels.</dd> +<dd><p>These values define the perimeter of a region of +pixels.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -222,25 +217,23 @@ pixels.</dd> <h1><a class="toc-backref" href="#id68">AcquireCacheViewIndexes</a></h1> <div class="section" id="id9"> <h2>Synopsis</h2> -<pre class="literal-block"> -const IndexPacket *AcquireCacheViewIndexes( const <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view ); -</pre> +<pre class="literal-block">const IndexPacket *AcquireCacheViewIndexes( const <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view );</pre> </div> <div class="section" id="id10"> <h2>Description</h2> <p>Method AcquireCacheViewIndexes returns read-only indexes associated with the specified view.</p> <p>The format of the AcquireCacheViewIndexes method is:</p> -<pre class="literal-block"> -const IndexPacket *AcquireCacheViewIndexes( const <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view ); -</pre> +<pre class="literal-block">const IndexPacket *AcquireCacheViewIndexes( const <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>indexes:</dt> -<dd>Method AcquireCacheViewIndexes returns the indexes -associated with the specified view.</dd> +<dd><p>Method AcquireCacheViewIndexes returns the indexes +associated with the specified view.</p> +</dd> <dt>view:</dt> -<dd>The address of a structure of type ViewInfo.</dd> +<dd><p>The address of a structure of type ViewInfo.</p> +</dd> </dl> </div> </div> @@ -248,11 +241,9 @@ associated with the specified view.</dd> <h1><a class="toc-backref" href="#id69">AcquireImagePixels</a></h1> <div class="section" id="id11"> <h2>Synopsis</h2> -<pre class="literal-block"> -const <a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *AcquireImagePixels( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const long x, const long y, +<pre class="literal-block">const <a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *AcquireImagePixels( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const long x, const long y, const unsigned long columns, const unsigned long rows, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id12"> <h2>Description</h2> @@ -270,22 +261,24 @@ after invoking GetImagePixels() to obtain the colormap indexes (of type IndexPacket) corresponding to the region.</p> <p>If you plan to modify the pixels, use GetImagePixels() instead.</p> <p>The format of the AcquireImagePixels() method is:</p> -<pre class="literal-block"> -const <a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *AcquireImagePixels( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const long x, const long y, +<pre class="literal-block">const <a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *AcquireImagePixels( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const long x, const long y, const unsigned long columns, const unsigned long rows, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>status:</dt> -<dd>AcquireImagePixels() returns a pointer to the pixels if they -are transferred, otherwise a NULL is returned.</dd> +<dd><p>AcquireImagePixels() returns a pointer to the pixels if they +are transferred, otherwise a NULL is returned.</p> +</dd> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>x,y,columns,rows:</dt> -<dd>These values define the perimeter of a region of -pixels.</dd> +<dd><p>These values define the perimeter of a region of +pixels.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -293,11 +286,9 @@ pixels.</dd> <h1><a class="toc-backref" href="#id70">AcquireOneCacheViewPixel</a></h1> <div class="section" id="id13"> <h2>Synopsis</h2> -<pre class="literal-block"> -MagickPassFail AcquireOneCacheViewPixel( const <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, <a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *pixel, +<pre class="literal-block">MagickPassFail AcquireOneCacheViewPixel( const <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, <a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *pixel, const long x, const long y, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id14"> <h2>Description</h2> @@ -306,20 +297,22 @@ pixel cache as defined by the geometry parameters for read-only access. The image background color is returned if there is an error retrieving the pixel.</p> <p>The format of the AcquireOneCacheViewPixel method is:</p> -<pre class="literal-block"> -MagickPassFail AcquireOneCacheViewPixel( const <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, <a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *pixel, +<pre class="literal-block">MagickPassFail AcquireOneCacheViewPixel( const <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, <a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *pixel, const long x, const long y, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>view:</dt> -<dd>The address of a structure of type ViewInfo.</dd> +<dd><p>The address of a structure of type ViewInfo.</p> +</dd> <dt>pixel:</dt> -<dd>Pointer to PixelPacket to update.</dd> +<dd><p>Pointer to PixelPacket to update.</p> +</dd> <dt>x,y:</dt> -<dd>Coordinate of pixel to retrieve</dd> +<dd><p>Coordinate of pixel to retrieve</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -327,10 +320,8 @@ MagickPassFail AcquireOneCacheViewPixel( const <a class="reference external" hre <h1><a class="toc-backref" href="#id71">AcquireOnePixel</a></h1> <div class="section" id="id15"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> AcquireOnePixel( const <a class="reference external" href="../api/types.html#image">Image</a> image, const long x, const long y, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> exception ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> AcquireOnePixel( const <a class="reference external" href="../api/types.html#image">Image</a> image, const long x, const long y, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> exception );</pre> </div> <div class="section" id="id16"> <h2>Description</h2> @@ -339,20 +330,22 @@ The image background color is returned if an error occurs. If errors are to be returned to the image, use GetOnePixel() instead. This function is convenient but performance will be poor if it is used too often.</p> <p>The format of the AcquireOnePixel() method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> AcquireOnePixel( const <a class="reference external" href="../api/types.html#image">Image</a> image, const long x, const long y, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> exception ); -</pre> -<dl class="docutils"> +<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> AcquireOnePixel( const <a class="reference external" href="../api/types.html#image">Image</a> image, const long x, const long y, + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> exception );</pre> +<dl class="simple"> <dt>pixels:</dt> -<dd>AcquireOnePixel() returns a pixel at the specified (x,y) -location.</dd> +<dd><p>AcquireOnePixel() returns a pixel at the specified (x,y) +location.</p> +</dd> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>x,y:</dt> -<dd>These values define the location of the pixel to return.</dd> +<dd><p>These values define the location of the pixel to return.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -360,11 +353,9 @@ location.</dd> <h1><a class="toc-backref" href="#id72">AcquireOnePixelByReference</a></h1> <div class="section" id="id17"> <h2>Synopsis</h2> -<pre class="literal-block"> -MagickPassFail AcquireOnePixelByReference( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *pixel, +<pre class="literal-block">MagickPassFail AcquireOnePixelByReference( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *pixel, const long x, const long y, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id18"> <h2>Description</h2> @@ -373,23 +364,26 @@ location. The image background color is returned if an error occurs. This function is convenient but performance will be poor if it is used too often.</p> <p>The format of the AcquireOnePixelByReference() method is:</p> -<pre class="literal-block"> -MagickPassFail AcquireOnePixelByReference( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *pixel, +<pre class="literal-block">MagickPassFail AcquireOnePixelByReference( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *pixel, const long x, const long y, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>pixels:</dt> -<dd>AcquireOnePixel() returns a pixel at the specified (x,y) -location.</dd> +<dd><p>AcquireOnePixel() returns a pixel at the specified (x,y) +location.</p> +</dd> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>pixel:</dt> -<dd>A reference to the pixel to update.</dd> +<dd><p>A reference to the pixel to update.</p> +</dd> <dt>x,y:</dt> -<dd>These values define the location of the pixel to return.</dd> +<dd><p>These values define the location of the pixel to return.</p> +</dd> <dt>exception:</dt> -<dd>Return any errors or warnings in this structure.</dd> +<dd><p>Return any errors or warnings in this structure.</p> +</dd> </dl> </div> </div> @@ -397,9 +391,7 @@ location.</dd> <h1><a class="toc-backref" href="#id73">CheckImagePixelLimits</a></h1> <div class="section" id="id19"> <h2>Synopsis</h2> -<pre class="literal-block"> -MagickPassFail CheckImagePixelLimits( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block">MagickPassFail CheckImagePixelLimits( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id20"> <h2>Description</h2> @@ -413,14 +405,14 @@ further processing of the image. Such additional limits should be after any 'ping' mode processing so that the image dimensions can still be shown by 'identify'.</p> <p>The format of the CheckImagePixelLimits() method is:</p> -<pre class="literal-block"> -MagickPassFail CheckImagePixelLimits( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> +<pre class="literal-block">MagickPassFail CheckImagePixelLimits( const <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>image:</dt> -<dd>Image to verify rows/columns.</dd> +<dd><p>Image to verify rows/columns.</p> +</dd> <dt>exception:</dt> -<dd>Throw exception into this ExceptionInfo structure.</dd> +<dd><p>Throw exception into this ExceptionInfo structure.</p> +</dd> </dl> </div> </div> @@ -428,21 +420,18 @@ MagickPassFail CheckImagePixelLimits( const <a class="reference external" href=" <h1><a class="toc-backref" href="#id74">DestroyCacheInfo</a></h1> <div class="section" id="id21"> <h2>Synopsis</h2> -<pre class="literal-block"> -void DestroyCacheInfo( <a class="reference external" href="../api/types.html#cache">Cache</a> cache ); -</pre> +<pre class="literal-block">void DestroyCacheInfo( <a class="reference external" href="../api/types.html#cache">Cache</a> cache );</pre> </div> <div class="section" id="id22"> <h2>Description</h2> <p>DestroyCacheInfo() deallocates memory associated with the pixel cache.</p> <p>The format of the DestroyCacheInfo() method is:</p> -<pre class="literal-block"> -void DestroyCacheInfo( <a class="reference external" href="../api/types.html#cache">Cache</a> cache ); -</pre> +<pre class="literal-block">void DestroyCacheInfo( <a class="reference external" href="../api/types.html#cache">Cache</a> cache );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>cache:</dt> -<dd>Specifies a pointer to a Cache structure.</dd> +<dd><p>Specifies a pointer to a Cache structure.</p> +</dd> </dl> </div> </div> @@ -450,21 +439,18 @@ void DestroyCacheInfo( <a class="reference external" href="../api/types.html#cac <h1><a class="toc-backref" href="#id75">DestroyImagePixels</a></h1> <div class="section" id="id23"> <h2>Synopsis</h2> -<pre class="literal-block"> -void DestroyImagePixels( <a class="reference external" href="../api/types.html#image">Image</a> *image ); -</pre> +<pre class="literal-block">void DestroyImagePixels( <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre> </div> <div class="section" id="id24"> <h2>Description</h2> <p>DestroyImagePixels() deallocates memory associated with the pixel cache.</p> <p>The format of the DestroyImagePixels() method is:</p> -<pre class="literal-block"> -void DestroyImagePixels( <a class="reference external" href="../api/types.html#image">Image</a> *image ); -</pre> +<pre class="literal-block">void DestroyImagePixels( <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> </dl> </div> </div> @@ -472,11 +458,9 @@ void DestroyImagePixels( <a class="reference external" href="../api/types.html#i <h1><a class="toc-backref" href="#id76">GetCacheViewPixels</a></h1> <div class="section" id="id25"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *GetCacheViewPixels( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, const long x, const long y, +<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *GetCacheViewPixels( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, const long x, const long y, const unsigned long columns, const unsigned long rows, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id26"> <h2>Description</h2> @@ -484,22 +468,24 @@ void DestroyImagePixels( <a class="reference external" href="../api/types.html#i 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> <p>The format of the GetCacheViewPixels method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *GetCacheViewPixels( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, const long x, const long y, +<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *GetCacheViewPixels( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, const long x, const long y, const unsigned long columns, const unsigned long rows, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>pixels:</dt> -<dd>Method GetCacheViewPixels returns a null pointer if an error -occurs, otherwise a pointer to the view pixels.</dd> +<dd><p>Method GetCacheViewPixels returns a null pointer if an error +occurs, otherwise a pointer to the view pixels.</p> +</dd> <dt>view:</dt> -<dd>The address of a structure of type ViewInfo.</dd> +<dd><p>The address of a structure of type ViewInfo.</p> +</dd> <dt>x,y,columns,rows:</dt> -<dd>These values define the perimeter of a region of -pixels.</dd> +<dd><p>These values define the perimeter of a region of +pixels.</p> +</dd> <dt>exception:</dt> -<dd>Any errors are reported here.</dd> +<dd><p>Any errors are reported here.</p> +</dd> </dl> </div> </div> @@ -507,24 +493,22 @@ pixels.</dd> <h1><a class="toc-backref" href="#id77">GetCacheViewImage</a></h1> <div class="section" id="id27"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *GetCacheViewImage( const <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *GetCacheViewImage( const <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view );</pre> </div> <div class="section" id="id28"> <h2>Description</h2> <p>Method GetCacheViewImage returns the image which allocated the view.</p> <p>The format of the GetCacheViewImage method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#image">Image</a> *GetCacheViewImage( const <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *GetCacheViewImage( const <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>image:</dt> -<dd>Method GetCacheViewImage returns the image which allocated -the view.</dd> +<dd><p>Method GetCacheViewImage returns the image which allocated +the view.</p> +</dd> <dt>view:</dt> -<dd>The address of a structure of type ViewInfo.</dd> +<dd><p>The address of a structure of type ViewInfo.</p> +</dd> </dl> </div> </div> @@ -532,25 +516,23 @@ the view.</dd> <h1><a class="toc-backref" href="#id78">GetCacheViewIndexes</a></h1> <div class="section" id="id29"> <h2>Synopsis</h2> -<pre class="literal-block"> -IndexPacket *GetCacheViewIndexes( const <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view ); -</pre> +<pre class="literal-block">IndexPacket *GetCacheViewIndexes( const <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view );</pre> </div> <div class="section" id="id30"> <h2>Description</h2> <p>Method GetCacheViewIndexes returns writeable indexes associated with the specified view.</p> <p>The format of the GetCacheViewIndexes method is:</p> -<pre class="literal-block"> -IndexPacket *GetCacheViewIndexes( const <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view ); -</pre> +<pre class="literal-block">IndexPacket *GetCacheViewIndexes( const <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>indexes:</dt> -<dd>Method GetCacheViewIndexes returns the indexes associated with -the specified view.</dd> +<dd><p>Method GetCacheViewIndexes returns the indexes associated with +the specified view.</p> +</dd> <dt>view:</dt> -<dd>The address of a structure of type ViewInfo.</dd> +<dd><p>The address of a structure of type ViewInfo.</p> +</dd> </dl> </div> </div> @@ -558,10 +540,8 @@ the specified view.</dd> <h1><a class="toc-backref" href="#id79">GetImagePixels</a></h1> <div class="section" id="id31"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *GetImagePixels( <a class="reference external" href="../api/types.html#image">Image</a> *image, const long x, const long y, - const unsigned long columns, const unsigned long rows ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *GetImagePixels( <a class="reference external" href="../api/types.html#image">Image</a> *image, const long x, const long y, + const unsigned long columns, const unsigned long rows );</pre> </div> <div class="section" id="id32"> <h2>Description</h2> @@ -581,19 +561,20 @@ 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 SyncImagePixels() or they may be lost.</p> <p>The format of the GetImagePixels() method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *GetImagePixels( <a class="reference external" href="../api/types.html#image">Image</a> *image, const long x, const long y, - const unsigned long columns, const unsigned long rows ); -</pre> -<dl class="docutils"> +<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *GetImagePixels( <a class="reference external" href="../api/types.html#image">Image</a> *image, const long x, const long y, + const unsigned long columns, const unsigned long rows );</pre> +<dl class="simple"> <dt>status:</dt> -<dd>GetImagePixels() returns a pointer to the pixels if they are -transferred, otherwise a NULL is returned.</dd> +<dd><p>GetImagePixels() returns a pointer to the pixels if they are +transferred, otherwise a NULL is returned.</p> +</dd> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>x,y,columns,rows:</dt> -<dd>These values define the perimeter of a region of -pixels.</dd> +<dd><p>These values define the perimeter of a region of +pixels.</p> +</dd> </dl> </div> </div> @@ -601,11 +582,9 @@ pixels.</dd> <h1><a class="toc-backref" href="#id80">GetImagePixelsEx</a></h1> <div class="section" id="id33"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *GetImagePixelsEx( <a class="reference external" href="../api/types.html#image">Image</a> *image, const long x, const long y, +<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *GetImagePixelsEx( <a class="reference external" href="../api/types.html#image">Image</a> *image, const long x, const long y, const unsigned long columns, const unsigned long rows, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id34"> <h2>Description</h2> @@ -613,22 +592,24 @@ pixels.</dd> similar to GetImagePixels() except that it reports any error information to a user provided exception structure.</p> <p>The format of the GetImagePixelsEx() method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *GetImagePixelsEx( <a class="reference external" href="../api/types.html#image">Image</a> *image, const long x, const long y, +<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *GetImagePixelsEx( <a class="reference external" href="../api/types.html#image">Image</a> *image, const long x, const long y, const unsigned long columns, const unsigned long rows, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>status:</dt> -<dd>GetImagePixelsEx() returns a pointer to the pixels if they are -transferred, otherwise a NULL is returned.</dd> +<dd><p>GetImagePixelsEx() returns a pointer to the pixels if they are +transferred, otherwise a NULL is returned.</p> +</dd> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>x,y,columns,rows:</dt> -<dd>These values define the perimeter of a region of -pixels.</dd> +<dd><p>These values define the perimeter of a region of +pixels.</p> +</dd> <dt>exception:</dt> -<dd>Any error details are reported here.</dd> +<dd><p>Any error details are reported here.</p> +</dd> </dl> </div> </div> @@ -636,9 +617,7 @@ pixels.</dd> <h1><a class="toc-backref" href="#id81">GetImageVirtualPixelMethod</a></h1> <div class="section" id="id35"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#virtualpixelmethod">VirtualPixelMethod</a> GetImageVirtualPixelMethod( const <a class="reference external" href="../api/types.html#image">Image</a> *image ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#virtualpixelmethod">VirtualPixelMethod</a> GetImageVirtualPixelMethod( const <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre> </div> <div class="section" id="id36"> <h2>Description</h2> @@ -646,13 +625,12 @@ pixels.</dd> image. A virtual pixel is any pixel access that is outside the boundaries of the image cache.</p> <p>The format of the GetImageVirtualPixelMethod() method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#virtualpixelmethod">VirtualPixelMethod</a> GetImageVirtualPixelMethod( const <a class="reference external" href="../api/types.html#image">Image</a> *image ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#virtualpixelmethod">VirtualPixelMethod</a> GetImageVirtualPixelMethod( const <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> </dl> </div> </div> @@ -660,9 +638,7 @@ of the image cache.</p> <h1><a class="toc-backref" href="#id82">GetIndexes</a></h1> <div class="section" id="id37"> <h2>Synopsis</h2> -<pre class="literal-block"> -IndexPacket *GetIndexes( const <a class="reference external" href="../api/types.html#image">Image</a> *image ); -</pre> +<pre class="literal-block">IndexPacket *GetIndexes( const <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre> </div> <div class="section" id="id38"> <h2>Description</h2> @@ -670,16 +646,16 @@ IndexPacket *GetIndexes( const <a class="reference external" href="../api/types. SetImagePixels() or GetImagePixels(). NULL is returned if colormap indexes are not available.</p> <p>The format of the GetIndexes() method is:</p> -<pre class="literal-block"> -IndexPacket *GetIndexes( const <a class="reference external" href="../api/types.html#image">Image</a> *image ); -</pre> +<pre class="literal-block">IndexPacket *GetIndexes( const <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>indexes:</dt> -<dd>GetIndexes() returns the indexes associated with the last -call to SetImagePixels() or GetImagePixels().</dd> +<dd><p>GetIndexes() returns the indexes associated with the last +call to SetImagePixels() or GetImagePixels().</p> +</dd> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> </dl> </div> </div> @@ -687,9 +663,7 @@ call to SetImagePixels() or GetImagePixels().</dd> <h1><a class="toc-backref" href="#id83">GetOnePixel</a></h1> <div class="section" id="id39"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> GetOnePixel( const <a class="reference external" href="../api/types.html#image">Image</a> image, const long x, const long y ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> GetOnePixel( const <a class="reference external" href="../api/types.html#image">Image</a> image, const long x, const long y );</pre> </div> <div class="section" id="id40"> <h2>Description</h2> @@ -699,15 +673,15 @@ is convenient but performance will be poor if it is used too often. GetOnePixel() is identical to AcquireOnePixel() except that exceptions are implicitly delivered to the image.</p> <p>The format of the GetOnePixel() method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> GetOnePixel( const <a class="reference external" href="../api/types.html#image">Image</a> image, const long x, const long y ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> GetOnePixel( const <a class="reference external" href="../api/types.html#image">Image</a> image, const long x, const long y );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>x,y:</dt> -<dd>These values define the location of the pixel to return.</dd> +<dd><p>These values define the location of the pixel to return.</p> +</dd> </dl> </div> </div> @@ -715,9 +689,7 @@ are implicitly delivered to the image.</p> <h1><a class="toc-backref" href="#id84">GetPixels</a></h1> <div class="section" id="id41"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *GetPixels( const <a class="reference external" href="../api/types.html#image">Image</a> image ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *GetPixels( const <a class="reference external" href="../api/types.html#image">Image</a> image );</pre> </div> <div class="section" id="id42"> <h2>Description</h2> @@ -725,16 +697,16 @@ are implicitly delivered to the image.</p> SetImagePixels() or GetImagePixels(). This is useful in order to access an already selected region without passing the geometry of the region.</p> <p>The format of the GetPixels() method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *GetPixels( const <a class="reference external" href="../api/types.html#image">Image</a> image ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *GetPixels( const <a class="reference external" href="../api/types.html#image">Image</a> image );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>pixels:</dt> -<dd>GetPixels() returns the pixels associated with the last call -to SetImagePixels() or GetImagePixels().</dd> +<dd><p>GetPixels() returns the pixels associated with the last call +to SetImagePixels() or GetImagePixels().</p> +</dd> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> </dl> </div> </div> @@ -742,9 +714,7 @@ to SetImagePixels() or GetImagePixels().</dd> <h1><a class="toc-backref" href="#id85">ModifyCache</a></h1> <div class="section" id="id43"> <h2>Synopsis</h2> -<pre class="literal-block"> -MagickPassFail ModifyCache( <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block">MagickPassFail ModifyCache( <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id44"> <h2>Description</h2> @@ -753,15 +723,15 @@ cache to be modified, updating the provided cache pointer to point to a clone of the original pixel cache if necessary. This is used to implement copy on write.</p> <p>The format of the ModifyCache method is:</p> -<pre class="literal-block"> -MagickPassFail ModifyCache( <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block">MagickPassFail ModifyCache( <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>exception:</dt> -<dd>Errors are reported here.</dd> +<dd><p>Errors are reported here.</p> +</dd> </dl> </div> </div> @@ -769,21 +739,18 @@ MagickPassFail ModifyCache( <a class="reference external" href="../api/types.htm <h1><a class="toc-backref" href="#id86">OpenCacheView</a></h1> <div class="section" id="id45"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *OpenCacheView( <a class="reference external" href="../api/types.html#image">Image</a> *image ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *OpenCacheView( <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre> </div> <div class="section" id="id46"> <h2>Description</h2> <p>OpenCacheView() opens a view into the pixel cache.</p> <p>The format of the OpenCacheView method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *OpenCacheView( <a class="reference external" href="../api/types.html#image">Image</a> *image ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *OpenCacheView( <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> </dl> </div> </div> @@ -791,22 +758,19 @@ MagickPassFail ModifyCache( <a class="reference external" href="../api/types.htm <h1><a class="toc-backref" href="#id87">ReferenceCache</a></h1> <div class="section" id="id47"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#cache">Cache</a> ReferenceCache( <a class="reference external" href="../api/types.html#cache">Cache</a> cache_info ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#cache">Cache</a> ReferenceCache( <a class="reference external" href="../api/types.html#cache">Cache</a> cache_info );</pre> </div> <div class="section" id="id48"> <h2>Description</h2> <p>ReferenceCache() increments the reference count associated with the pixel cache returning a pointer to the cache.</p> <p>The format of the ReferenceCache method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#cache">Cache</a> ReferenceCache( <a class="reference external" href="../api/types.html#cache">Cache</a> cache_info ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#cache">Cache</a> ReferenceCache( <a class="reference external" href="../api/types.html#cache">Cache</a> cache_info );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>cache_info:</dt> -<dd>The cache_info.</dd> +<dd><p>The cache_info.</p> +</dd> </dl> </div> </div> @@ -814,10 +778,8 @@ cache returning a pointer to the cache.</p> <h1><a class="toc-backref" href="#id88">SetCacheViewPixels</a></h1> <div class="section" id="id49"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *SetCacheViewPixels( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, const long x, const long y, - const unsigned long columns, const unsigned long rows ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *SetCacheViewPixels( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, const long x, const long y, + const unsigned long columns, const unsigned long rows );</pre> </div> <div class="section" id="id50"> <h2>Description</h2> @@ -825,18 +787,19 @@ cache returning a pointer to the cache.</p> defined by the geometry parameters. A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.</p> <p>The format of the SetCacheViewPixels method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *SetCacheViewPixels( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, const long x, const long y, - const unsigned long columns, const unsigned long rows ); -</pre> -<dl class="docutils"> +<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *SetCacheViewPixels( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, const long x, const long y, + const unsigned long columns, const unsigned long rows );</pre> +<dl class="simple"> <dt>view:</dt> -<dd>The address of a structure of type ViewInfo.</dd> +<dd><p>The address of a structure of type ViewInfo.</p> +</dd> <dt>x,y,columns,rows:</dt> -<dd>These values define the perimeter of a region of -pixels.</dd> +<dd><p>These values define the perimeter of a region of +pixels.</p> +</dd> <dt>exception:</dt> -<dd>Any errors are reported here.</dd> +<dd><p>Any errors are reported here.</p> +</dd> </dl> </div> </div> @@ -844,10 +807,8 @@ pixels.</dd> <h1><a class="toc-backref" href="#id89">SetImagePixels</a></h1> <div class="section" id="id51"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *SetImagePixels( <a class="reference external" href="../api/types.html#image">Image</a> *image, const long x, const long y, - const unsigned long columns, const unsigned long rows ); -</pre> +<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *SetImagePixels( <a class="reference external" href="../api/types.html#image">Image</a> *image, const long x, const long y, + const unsigned long columns, const unsigned long rows );</pre> </div> <div class="section" id="id52"> <h2>Description</h2> @@ -876,19 +837,20 @@ 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 SyncCacheNexus() or they may be lost.</p> <p>The format of the SetImagePixels() method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *SetImagePixels( <a class="reference external" href="../api/types.html#image">Image</a> *image, const long x, const long y, - const unsigned long columns, const unsigned long rows ); -</pre> -<dl class="docutils"> +<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *SetImagePixels( <a class="reference external" href="../api/types.html#image">Image</a> *image, const long x, const long y, + const unsigned long columns, const unsigned long rows );</pre> +<dl class="simple"> <dt>pixels:</dt> -<dd>SetImagePixels returns a pointer to the pixels if they are -transferred, otherwise a NULL is returned.</dd> +<dd><p>SetImagePixels returns a pointer to the pixels if they are +transferred, otherwise a NULL is returned.</p> +</dd> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>x,y,columns,rows:</dt> -<dd>These values define the perimeter of a region of -pixels.</dd> +<dd><p>These values define the perimeter of a region of +pixels.</p> +</dd> </dl> </div> </div> @@ -896,11 +858,9 @@ pixels.</dd> <h1><a class="toc-backref" href="#id90">SetImagePixelsEx</a></h1> <div class="section" id="id53"> <h2>Synopsis</h2> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *SetImagePixelsEx( <a class="reference external" href="../api/types.html#image">Image</a> *image, const long x, const long y, +<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *SetImagePixelsEx( <a class="reference external" href="../api/types.html#image">Image</a> *image, const long x, const long y, const unsigned long columns, const unsigned long rows, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id54"> <h2>Description</h2> @@ -908,22 +868,24 @@ pixels.</dd> It is similar to SetImagePixels() except that any exception information is written to a user provided exception structure.</p> <p>The format of the SetImagePixelsEx() method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *SetImagePixelsEx( <a class="reference external" href="../api/types.html#image">Image</a> *image, const long x, const long y, +<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *SetImagePixelsEx( <a class="reference external" href="../api/types.html#image">Image</a> *image, const long x, const long y, const unsigned long columns, const unsigned long rows, - <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> + <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>pixels:</dt> -<dd>SetImagePixelsEx returns a pointer to the pixels if they are -transferred, otherwise a NULL is returned.</dd> +<dd><p>SetImagePixelsEx returns a pointer to the pixels if they are +transferred, otherwise a NULL is returned.</p> +</dd> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>x,y,columns,rows:</dt> -<dd>These values define the perimeter of a region of -pixels.</dd> +<dd><p>These values define the perimeter of a region of +pixels.</p> +</dd> <dt>exception:</dt> -<dd>Any error details are reported here.</dd> +<dd><p>Any error details are reported here.</p> +</dd> </dl> </div> </div> @@ -931,9 +893,7 @@ pixels.</dd> <h1><a class="toc-backref" href="#id91">SetImageVirtualPixelMethod</a></h1> <div class="section" id="id55"> <h2>Synopsis</h2> -<pre class="literal-block"> -SetImageVirtualPixelMethod( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#virtualpixelmethod">VirtualPixelMethod</a> method ); -</pre> +<pre class="literal-block">SetImageVirtualPixelMethod( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#virtualpixelmethod">VirtualPixelMethod</a> method );</pre> </div> <div class="section" id="id56"> <h2>Description</h2> @@ -941,14 +901,14 @@ SetImageVirtualPixelMethod( const <a class="reference external" href="../api/typ image. A virtual pixel is any pixel access that is outside the boundaries of the image cache.</p> <p>The format of the SetImageVirtualPixelMethod() method is:</p> -<pre class="literal-block"> -SetImageVirtualPixelMethod( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#virtualpixelmethod">VirtualPixelMethod</a> method ); -</pre> -<dl class="docutils"> +<pre class="literal-block">SetImageVirtualPixelMethod( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#virtualpixelmethod">VirtualPixelMethod</a> method );</pre> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>type:</dt> -<dd>choose from these access types:</dd> +<dd><p>choose from these access types:</p> +</dd> </dl> <p>EdgeVPType: the edge pixels of the image extend infinitely. Any pixel outside the image is assigned the same value as the @@ -964,9 +924,7 @@ defines by the pixel parameter.</p> <h1><a class="toc-backref" href="#id92">SyncCacheViewPixels</a></h1> <div class="section" id="id57"> <h2>Synopsis</h2> -<pre class="literal-block"> -MagickPassFail SyncCacheViewPixels( const <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block">MagickPassFail SyncCacheViewPixels( const <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id58"> <h2>Description</h2> @@ -974,14 +932,14 @@ MagickPassFail SyncCacheViewPixels( const <a class="reference external" href=".. The method returns MagickPass if the pixel region is synced, otherwise MagickFail.</p> <p>The format of the SyncCacheViewPixels method is:</p> -<pre class="literal-block"> -MagickPassFail SyncCacheViewPixels( const <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> -<dl class="docutils"> +<pre class="literal-block">MagickPassFail SyncCacheViewPixels( const <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> +<dl class="simple"> <dt>view:</dt> -<dd>The address of a structure of type ViewInfo.</dd> +<dd><p>The address of a structure of type ViewInfo.</p> +</dd> <dt>exception:</dt> -<dd>Any errors are reported here.</dd> +<dd><p>Any errors are reported here.</p> +</dd> </dl> </div> </div> @@ -989,25 +947,23 @@ MagickPassFail SyncCacheViewPixels( const <a class="reference external" href=".. <h1><a class="toc-backref" href="#id93">SyncImagePixels</a></h1> <div class="section" id="id59"> <h2>Synopsis</h2> -<pre class="literal-block"> -MagickPassFail SyncImagePixels( <a class="reference external" href="../api/types.html#image">Image</a> *image ); -</pre> +<pre class="literal-block">MagickPassFail SyncImagePixels( <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre> </div> <div class="section" id="id60"> <h2>Description</h2> <p>SyncImagePixels() saves the image pixels to the in-memory or disk cache. The method returns MagickPass if the pixel region is synced, otherwise MagickFail.</p> <p>The format of the SyncImagePixels() method is:</p> -<pre class="literal-block"> -MagickPassFail SyncImagePixels( <a class="reference external" href="../api/types.html#image">Image</a> *image ); -</pre> +<pre class="literal-block">MagickPassFail SyncImagePixels( <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>status:</dt> -<dd>SyncImagePixels() returns MagickPass if the image pixels are -transferred to the in-memory or disk cache otherwise MagickFail.</dd> +<dd><p>SyncImagePixels() returns MagickPass if the image pixels are +transferred to the in-memory or disk cache otherwise MagickFail.</p> +</dd> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> </dl> </div> </div> @@ -1015,9 +971,7 @@ transferred to the in-memory or disk cache otherwise MagickFail.</dd> <h1><a class="toc-backref" href="#id94">SyncImagePixelsEx</a></h1> <div class="section" id="id61"> <h2>Synopsis</h2> -<pre class="literal-block"> -MagickPassFail SyncImagePixelsEx( <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block">MagickPassFail SyncImagePixelsEx( <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> </div> <div class="section" id="id62"> <h2>Description</h2> @@ -1025,26 +979,30 @@ MagickPassFail SyncImagePixelsEx( <a class="reference external" href="../api/typ The method returns MagickPass if the pixel region is synced, otherwise MagickFail.</p> <p>The format of the SyncImagePixelsEx() method is:</p> -<pre class="literal-block"> -MagickPassFail SyncImagePixelsEx( <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception ); -</pre> +<pre class="literal-block">MagickPassFail SyncImagePixelsEx( <a class="reference external" href="../api/types.html#image">Image</a> *image, <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>status:</dt> -<dd>SyncImagePixelsEx() returns MagickPass if the image pixels are -transferred to the in-memory or disk cache otherwise MagickFail.</dd> +<dd><p>SyncImagePixelsEx() returns MagickPass if the image pixels are +transferred to the in-memory or disk cache otherwise MagickFail.</p> +</dd> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>exception:</dt> -<dd>Any error details are reported here.</dd> +<dd><p>Any error details are reported here.</p> +</dd> </dl> </div> </div> </div> + <hr class="docutils"> <div class="document"> - <p><a href="../Copyright.html">Copyright</a> © GraphicsMagick Group 2002 - 2022<!--SPONSOR_LOGO--></p> + <p><a href="../Copyright.html">Copyright</a> © GraphicsMagick Group 2002 - 2023<!--SPONSOR_LOGO--></p> +</div> + </div> </body> </html> |