diff options
Diffstat (limited to 'www/api/deprecate.html')
| -rw-r--r-- | www/api/deprecate.html | 268 |
1 files changed, 127 insertions, 141 deletions
diff --git a/www/api/deprecate.html b/www/api/deprecate.html index 7acd215..1bcac9d 100644 --- a/www/api/deprecate.html +++ b/www/api/deprecate.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>deprecate</title> -<link rel="stylesheet" href="../docutils-api.css" type="text/css" /> + <meta charset="utf-8"> + <meta content="en" name="language"> + <title>deprecate</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,35 +35,33 @@ <li><a href="../reference.html">Reference</a></li> </ul> </div> + <div class="document" id="deprecate"> <h1 class="title">deprecate</h1> -<h2 class="subtitle" id="methods-which-should-no-longer-be-used">Methods which should no longer be used</h2> - +<p class="subtitle" id="methods-which-should-no-longer-be-used">Methods which should no longer be used</p> <div class="contents topic" id="contents"> <p class="topic-title">Contents</p> <ul class="simple"> -<li><a class="reference internal" href="#acquirecacheview" id="id21">AcquireCacheView</a></li> -<li><a class="reference internal" href="#acquirememory" id="id22">AcquireMemory</a></li> -<li><a class="reference internal" href="#clonememory" id="id23">CloneMemory</a></li> -<li><a class="reference internal" href="#getcacheview" id="id24">GetCacheView</a></li> -<li><a class="reference internal" href="#liberatememory" id="id25">LiberateMemory</a></li> -<li><a class="reference internal" href="#popimagepixels" id="id26">PopImagePixels</a></li> -<li><a class="reference internal" href="#pushimagepixels" id="id27">PushImagePixels</a></li> -<li><a class="reference internal" href="#reacquirememory" id="id28">ReacquireMemory</a></li> -<li><a class="reference internal" href="#setcacheview" id="id29">SetCacheView</a></li> -<li><a class="reference internal" href="#synccacheview" id="id30">SyncCacheView</a></li> -<li><a class="reference internal" href="#strip" id="id31">Strip</a></li> +<li><p><a class="reference internal" href="#acquirecacheview" id="id21">AcquireCacheView</a></p></li> +<li><p><a class="reference internal" href="#acquirememory" id="id22">AcquireMemory</a></p></li> +<li><p><a class="reference internal" href="#clonememory" id="id23">CloneMemory</a></p></li> +<li><p><a class="reference internal" href="#getcacheview" id="id24">GetCacheView</a></p></li> +<li><p><a class="reference internal" href="#liberatememory" id="id25">LiberateMemory</a></p></li> +<li><p><a class="reference internal" href="#popimagepixels" id="id26">PopImagePixels</a></p></li> +<li><p><a class="reference internal" href="#pushimagepixels" id="id27">PushImagePixels</a></p></li> +<li><p><a class="reference internal" href="#reacquirememory" id="id28">ReacquireMemory</a></p></li> +<li><p><a class="reference internal" href="#setcacheview" id="id29">SetCacheView</a></p></li> +<li><p><a class="reference internal" href="#synccacheview" id="id30">SyncCacheView</a></p></li> +<li><p><a class="reference internal" href="#strip" id="id31">Strip</a></p></li> </ul> </div> <div class="section" id="acquirecacheview"> <h1><a class="toc-backref" href="#id21">AcquireCacheView</a></h1> <div class="section" id="synopsis"> <h2>Synopsis</h2> -<pre class="literal-block"> -const <a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *AcquireCacheView( <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> *AcquireCacheView( <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="description"> <h2>Description</h2> @@ -69,22 +70,24 @@ 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 AcquireCacheView method is:</p> -<pre class="literal-block"> -const <a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *AcquireCacheView( <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> *AcquireCacheView( <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 AcquireCacheView returns a null pointer if an error -occurs, otherwise a pointer to the view pixels.</dd> +<dd><p>Method AcquireCacheView 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> @@ -92,9 +95,7 @@ pixels.</dd> <h1><a class="toc-backref" href="#id22">AcquireMemory</a></h1> <div class="section" id="id1"> <h2>Synopsis</h2> -<pre class="literal-block"> -void *AcquireMemory( const size_t size ); -</pre> +<pre class="literal-block">void *AcquireMemory( const size_t size );</pre> </div> <div class="section" id="id2"> <h2>Description</h2> @@ -102,13 +103,12 @@ void *AcquireMemory( const size_t size ); bytes suitably aligned for any use. NULL is returned if insufficient memory is available or the requested size is zero.</p> <p>The format of the AcquireMemory method is:</p> -<pre class="literal-block"> -void *AcquireMemory( const size_t size ); -</pre> +<pre class="literal-block">void *AcquireMemory( const size_t size );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>size:</dt> -<dd>The size of the memory in bytes to allocate.</dd> +<dd><p>The size of the memory in bytes to allocate.</p> +</dd> </dl> </div> </div> @@ -116,9 +116,7 @@ void *AcquireMemory( const size_t size ); <h1><a class="toc-backref" href="#id23">CloneMemory</a></h1> <div class="section" id="id3"> <h2>Synopsis</h2> -<pre class="literal-block"> -void *CloneMemory( void *destination, const void *source, const size_t size ); -</pre> +<pre class="literal-block">void *CloneMemory( void *destination, const void *source, const size_t size );</pre> </div> <div class="section" id="id4"> <h2>Description</h2> @@ -126,13 +124,12 @@ void *CloneMemory( void *destination, const void *source, const size_t size ); destination. Copying between objects that overlap will take place correctly. It returns destination.</p> <p>The format of the CloneMemory method is:</p> -<pre class="literal-block"> -void *CloneMemory( void *destination, const void *source, const size_t size ); -</pre> +<pre class="literal-block">void *CloneMemory( void *destination, const void *source, const size_t size );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>size:</dt> -<dd>The size of the memory in bytes to allocate.</dd> +<dd><p>The size of the memory in bytes to allocate.</p> +</dd> </dl> </div> </div> @@ -140,10 +137,8 @@ void *CloneMemory( void *destination, const void *source, const size_t size ); <h1><a class="toc-backref" href="#id24">GetCacheView</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> *GetCacheView( <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> *GetCacheView( <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="id6"> <h2>Description</h2> @@ -151,19 +146,20 @@ void *CloneMemory( void *destination, const void *source, const size_t size ); 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 GetCacheView method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *GetCacheView( <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> *GetCacheView( <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>pixels:</dt> -<dd>Method GetCacheView returns a null pointer if an error -occurs, otherwise a pointer to the view pixels.</dd> +<dd><p>Method GetCacheView 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> </dl> </div> </div> @@ -171,22 +167,19 @@ pixels.</dd> <h1><a class="toc-backref" href="#id25">LiberateMemory</a></h1> <div class="section" id="id7"> <h2>Synopsis</h2> -<pre class="literal-block"> -void LiberateMemory( void ** memory ); -</pre> +<pre class="literal-block">void LiberateMemory( void ** memory );</pre> </div> <div class="section" id="id8"> <h2>Description</h2> <p>LiberateMemory() frees memory that has already been allocated, and NULLs the pointer to it.</p> <p>The format of the LiberateMemory method is:</p> -<pre class="literal-block"> -void LiberateMemory( void ** memory ); -</pre> +<pre class="literal-block">void LiberateMemory( void ** memory );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>memory:</dt> -<dd>A pointer to a block of memory to free for reuse.</dd> +<dd><p>A pointer to a block of memory to free for reuse.</p> +</dd> </dl> </div> </div> @@ -194,10 +187,8 @@ void LiberateMemory( void ** memory ); <h1><a class="toc-backref" href="#id26">PopImagePixels</a></h1> <div class="section" id="id9"> <h2>Synopsis</h2> -<pre class="literal-block"> -unsigned int PopImagePixels( const <a class="reference external" href="../api/types.html#image">Image</a> *, const <a class="reference external" href="../api/types.html#quantumtype">QuantumType</a> quantum, - unsigned char *destination ); -</pre> +<pre class="literal-block">unsigned int PopImagePixels( const <a class="reference external" href="../api/types.html#image">Image</a> *, const <a class="reference external" href="../api/types.html#quantumtype">QuantumType</a> quantum, + unsigned char *destination );</pre> </div> <div class="section" id="id10"> <h2>Description</h2> @@ -205,20 +196,22 @@ unsigned int PopImagePixels( const <a class="reference external" href="../api/ty cache to a user supplied buffer. True is returned if the pixels are successfully transferred, otherwise False.</p> <p>The format of the PopImagePixels method is:</p> -<pre class="literal-block"> -unsigned int PopImagePixels( const <a class="reference external" href="../api/types.html#image">Image</a> *, const <a class="reference external" href="../api/types.html#quantumtype">QuantumType</a> quantum, - unsigned char *destination ); -</pre> -<dl class="docutils"> +<pre class="literal-block">unsigned int PopImagePixels( const <a class="reference external" href="../api/types.html#image">Image</a> *, const <a class="reference external" href="../api/types.html#quantumtype">QuantumType</a> quantum, + unsigned char *destination );</pre> +<dl class="simple"> <dt>status:</dt> -<dd>Method PopImagePixels returns True if the pixels are -successfully transferred, otherwise False.</dd> +<dd><p>Method PopImagePixels returns True if the pixels are +successfully transferred, otherwise False.</p> +</dd> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>quantum:</dt> -<dd>Declare which pixel components to transfer (RGB, RGBA, etc).</dd> +<dd><p>Declare which pixel components to transfer (RGB, RGBA, etc).</p> +</dd> <dt>destination:</dt> -<dd>The components are transferred to this buffer.</dd> +<dd><p>The components are transferred to this buffer.</p> +</dd> </dl> </div> </div> @@ -226,10 +219,8 @@ successfully transferred, otherwise False.</dd> <h1><a class="toc-backref" href="#id27">PushImagePixels</a></h1> <div class="section" id="id11"> <h2>Synopsis</h2> -<pre class="literal-block"> -unsigned int PushImagePixels( <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#quantumtype">QuantumType</a> quantum_type, - const unsigned char *source ); -</pre> +<pre class="literal-block">unsigned int PushImagePixels( <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#quantumtype">QuantumType</a> quantum_type, + const unsigned char *source );</pre> </div> <div class="section" id="id12"> <h2>Description</h2> @@ -237,21 +228,23 @@ unsigned int PushImagePixels( <a class="reference external" href="../api/types.h supplied buffer into the image pixel cache of an image. It returns True if the pixels are successfully transferred, otherwise False.</p> <p>The format of the PushImagePixels method is:</p> -<pre class="literal-block"> -unsigned int PushImagePixels( <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#quantumtype">QuantumType</a> quantum_type, - const unsigned char *source ); -</pre> -<dl class="docutils"> +<pre class="literal-block">unsigned int PushImagePixels( <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#quantumtype">QuantumType</a> quantum_type, + const unsigned char *source );</pre> +<dl class="simple"> <dt>status:</dt> -<dd>Method PushImagePixels returns True if the pixels are -successfully transferred, otherwise False.</dd> +<dd><p>Method PushImagePixels returns True if the pixels are +successfully transferred, otherwise False.</p> +</dd> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>quantum_type:</dt> -<dd>Declare which pixel components to transfer (red, green, -blue, opacity, RGB, or RGBA).</dd> +<dd><p>Declare which pixel components to transfer (red, green, +blue, opacity, RGB, or RGBA).</p> +</dd> <dt>source:</dt> -<dd>The pixel components are transferred from this buffer.</dd> +<dd><p>The pixel components are transferred from this buffer.</p> +</dd> </dl> </div> </div> @@ -259,9 +252,7 @@ blue, opacity, RGB, or RGBA).</dd> <h1><a class="toc-backref" href="#id28">ReacquireMemory</a></h1> <div class="section" id="id13"> <h2>Synopsis</h2> -<pre class="literal-block"> -void ReacquireMemory( void ** memory, const size_t size ); -</pre> +<pre class="literal-block">void ReacquireMemory( void ** memory, const size_t size );</pre> </div> <div class="section" id="id14"> <h2>Description</h2> @@ -269,16 +260,16 @@ void ReacquireMemory( void ** memory, const size_t size ); pointer to the (possibly moved) block. The contents will be unchanged up to the lesser of the new and old sizes.</p> <p>The format of the ReacquireMemory method is:</p> -<pre class="literal-block"> -void ReacquireMemory( void ** memory, const size_t size ); -</pre> +<pre class="literal-block">void ReacquireMemory( void ** memory, const size_t size );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>memory:</dt> -<dd>A pointer to a memory allocation. On return the pointer -may change but the contents of the original allocation will not.</dd> +<dd><p>A pointer to a memory allocation. On return the pointer +may change but the contents of the original allocation will not.</p> +</dd> <dt>size:</dt> -<dd>The new size of the allocated memory.</dd> +<dd><p>The new size of the allocated memory.</p> +</dd> </dl> </div> </div> @@ -286,10 +277,8 @@ may change but the contents of the original allocation will not.</dd> <h1><a class="toc-backref" href="#id29">SetCacheView</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> *SetCacheView( <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> *SetCacheView( <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="id16"> <h2>Description</h2> @@ -297,16 +286,16 @@ may change but the contents of the original allocation will not.</dd> 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 SetCacheView method is:</p> -<pre class="literal-block"> -<a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *SetCacheView( <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> *SetCacheView( <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> </dl> </div> </div> @@ -314,9 +303,7 @@ pixels.</dd> <h1><a class="toc-backref" href="#id30">SyncCacheView</a></h1> <div class="section" id="id17"> <h2>Synopsis</h2> -<pre class="literal-block"> -MagickPassFail SyncCacheView( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view ); -</pre> +<pre class="literal-block">MagickPassFail SyncCacheView( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view );</pre> </div> <div class="section" id="id18"> <h2>Description</h2> @@ -324,13 +311,12 @@ MagickPassFail SyncCacheView( <a class="reference external" href="../api/types.h The method returns MagickPass if the pixel region is synced, otherwise MagickFail.</p> <p>The format of the SyncCacheView method is:</p> -<pre class="literal-block"> -MagickPassFail SyncCacheView( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view ); -</pre> +<pre class="literal-block">MagickPassFail SyncCacheView( <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>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> @@ -338,30 +324,30 @@ MagickPassFail SyncCacheView( <a class="reference external" href="../api/types.h <h1><a class="toc-backref" href="#id31">Strip</a></h1> <div class="section" id="id19"> <h2>Synopsis</h2> -<pre class="literal-block"> -void Strip( char *message ); -</pre> +<pre class="literal-block">void Strip( char *message );</pre> </div> <div class="section" id="id20"> <h2>Description</h2> <p>Method Strip strips any whitespace or quotes from the beginning and end of a string of characters.</p> <p>The format of the Strip method is:</p> -<pre class="literal-block"> -void Strip( char *message ); -</pre> +<pre class="literal-block">void Strip( char *message );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>message:</dt> -<dd>Specifies an array of characters.</dd> +<dd><p>Specifies an array of characters.</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> |