<meta name="Distribution" content="Global"/>
<link rel="icon" href="../../images/wand.png"/>
<link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
+ <link rel="canonical" href="http://www.imagemagick.org" />\r
<link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />\r
+ <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />\r
<style type="text/css" media="all">\r
@import url("../../www/magick.css");\r
</style>\r
+ <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>\r
<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>\r
<script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>\r
- <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />\r
<script type="text/javascript">\r
$(document).ready(function() {\r
$("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({\r
<div class="menu">
<a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
</div>
-<div class="sep"></div>\r
<div class="menu">
<a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
</div>
style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
<div class="sponsbox">
<div class="sponsor">
- <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
+ <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
</div>
<div class="sponsor">
- <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
+ <a rel="follow" title="Sponsor: Search engine optimisation" href="http://www.seomoves.com.au">Search engine optimisation</a><!-- 201110010090s jen@seo lowprofilelinks -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
</div>
+<div class="sponsor">
+ <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
+</div>
+<div class="sponsor">
+ <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
+</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Web Hosting Break" href="http://www.webhostingbreak.com">Web Hosting Break</a><!-- 201109010090 ian@ian-m... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
</div>
-<div class="sponsor">
- <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
-</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
</div>
<div class="sponsor">
- <a rel="follow" title="Sponsor: Bildbearbeitung" href="http://www.bildschliff.de">Bildbearbeitung</a><!-- 2012060100300 strait.de-->
+ <a rel="follow" title="Sponsor: Notebook Reparatur" href="http://www.atlasmultimedia.de">Notebook Reparatur</a><!-- 2011100100025 atlas.multimedia-->
</div>
</div>
</div>
</div>\r
\r
<div class="eastbar">\r
-\r
+<div style="margin: 9pt 9pt 9pt 9pt;">\r
+ <div class="g-plusone" data-size="standard" data-count="false"></div>\r
+</div>\r
</div>\r
\r
<div class="main">\r
\r
<h1>Module cache Methods</h1>
-<p class="navigation-index">[<a href="#AcquirePixelCacheNexus">AcquirePixelCacheNexus</a> • <a href="#GetAuthentic
IndexQueue">GetAuthenticIndexQueue</a> • <a href="#GetAuthenticPixelQueue">GetAuthenticPixelQueue</a> • <a href="#GetAuthenticPixels">GetAuthenticPixels</a> • <a href="#GetOneAuthenticPixel">GetOneAuthenticPixel</a> • <a href="#GetOneVirtualMagickPixel">GetOneVirtualMagickPixel</a> • <a href="#GetOneVirtualMethodPixel">GetOneVirtualMethodPixel</a> • <a href="#GetOneVirtualPixel">GetOneVirtualPixel</a> • <a href="#GetVirtualIndexQueue">GetVirtualIndexQueue</a> • <a href="#VirtualPixelModulo">VirtualPixelModulo</a> • <a href="#GetVirtualPixelQueue">GetVirtualPixelQueue</a> • <a href="#GetVirtualPixels">GetVirtualPixels</a> • <a href="#QueueAuthenticPixels">QueueAuthenticPixels</a> • <a href="#SetPixelCacheVirtualMethod">SetPixelCacheVirtualMethod</a> • <a href="#SyncAuthenticPixels">SyncAuthenticPixels</a>]</p>
+<p class="navigation-index">[<a href="#AcquirePixelCacheNexus">AcquirePixelCacheNexus</a> • <a href="#GetAuthentic
Metacontent">GetAuthenticMetacontent</a> • <a href="#GetAuthenticPixelQueue">GetAuthenticPixelQueue</a> • <a href="#GetAuthenticPixels">GetAuthenticPixels</a> • <a href="#GetOneAuthenticPixel">GetOneAuthenticPixel</a> • <a href="#GetOneVirtualMagickPixel">GetOneVirtualMagickPixel</a> • <a href="#GetOneVirtualMethodPixel">GetOneVirtualMethodPixel</a> • <a href="#GetOneVirtualPixel">GetOneVirtualPixel</a> • <a href="#GetVirtualMetacontent">GetVirtualMetacontent</a> • <a href="#VirtualPixelModulo">VirtualPixelModulo</a> • <a href="#GetVirtualPixelQueue">GetVirtualPixelQueue</a> • <a href="#GetVirtualPixels">GetVirtualPixels</a> • <a href="#QueueAuthenticPixels">QueueAuthenticPixels</a> • <a href="#SetPixelCacheVirtualMethod">SetPixelCacheVirtualMethod</a> • <a href="#SyncAuthenticPixels">SyncAuthenticPixels</a>]</p>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cache_8c.html" id="AcquirePixelCacheNexus">AcquirePixelCacheNexus</a></h2>
<div class="doc-section">
<p>the number of nexus threads.</p>
</div>
-<h2><a href="http://www.imagemagick.org/api/MagickCore/cache_8c.html" id="GetAuthenticIndexQueue">GetAuthenticIndexQueue</a></h2>
+<h2><a href="http://www.imagemagick.org/api/MagickCore/cache_8c.html" id="GetAuthenticMetacontent">GetAuthenticMetacontent</a></h2>
<div class="doc-section">
-<p>GetAuthenticIndexQueue() returns the authentic black channel or the colormap indexes associated with the last call to QueueAuthenticPixels() or GetVirtualPixels(). NULL is returned if the black channel or colormap indexes are not available.</p>
+<p>GetAuthenticMetacontent() returns the authentic metacontent corresponding with the last call to QueueAuthenticPixels() or GetVirtualPixels(). NULL is returned if the associated pixels are not available.</p>
-<p>The format of the GetAuthenticIndexQueue() method is:</p>
+<p>The format of the GetAuthenticMetacontent() method is:</p>
<pre class="code">
- IndexPacket *GetAuthenticIndexQueue(const Image *image)
+ void *GetAuthenticMetacontent(const Image *image)
</pre>
<p>A description of each parameter follows:</p>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cache_8c.html" id="GetAuthenticPixelQueue">GetAuthenticPixelQueue</a></h2>
<div class="doc-section">
-<p>GetAuthenticPixelQueue() returns the authentic pixels associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p>
+<p>GetAuthenticPixelQueue() returns the authentic pixels associated corresponding with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p>
<p>The format of the GetAuthenticPixelQueue() method is:</p>
<pre class="code">
- PixelPacket *GetAuthenticPixelQueue(const Image image)
+ Quantum *GetAuthenticPixelQueue(const Image image)
</pre>
<p>A description of each parameter follows:</p>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cache_8c.html" id="GetAuthenticPixels">GetAuthenticPixels</a></h2>
<div class="doc-section">
-<p>GetAuthenticPixels() obtains a pixel region for read/write access. If the region is successfully accessed, a pointer to a PixelPacket array representing the region is returned, otherwise NULL is returned.</p>
+<p>GetAuthenticPixels() obtains a pixel region for read/write access. If the region is successfully accessed, a pointer to a Quantum array representing the region is returned, otherwise NULL is returned.</p>
<p>The returned pointer may point to a temporary working copy of the pixels or it may point to the original pixels in memory. Performance is maximized if the selected region is part of one row, or one or more full rows, since then there is opportunity to access the pixels in-place (without a copy) if the image is in memory, or in a memory-mapped file. The returned pointer must *never* be deallocated by the user.</p>
-<p>Pixels accessed via the returned pointer represent a simple array of type PixelPacket. If the image type is CMYK or if the storage class is PseduoClass, call GetAuthenticIndexQueue() after invoking GetAuthenticPixels() to obtain the black color component or colormap indexes (of type IndexPacket) corresponding to the region. Once the PixelPacket (and/or IndexPacket) array has been updated, the changes must be saved back to the underlying image using SyncAuthenticPixels() or they may be lost.</p>
+<p>Pixels accessed via the returned pointer represent a simple array of type Quantum. If the image has corresponding metacontent,call GetAuthenticMetacontent() after invoking GetAuthenticPixels() to obtain the meta-content corresponding to the region. Once the Quantum array has been updated, the changes must be saved back to the underlying image using SyncAuthenticPixels() or they may be lost.</p>
<p>The format of the GetAuthenticPixels() method is:</p>
<pre class="code">
- PixelPacket *GetAuthenticPixels(Image *image,const ssize_t x,
+ Quantum *GetAuthenticPixels(Image *image,const ssize_t x,
const ssize_t y,const size_t columns,const size_t rows,
ExceptionInfo *exception)
</pre>
<pre class="code">
MagickBooleanType GetOneVirtualMagickPixel(const Image image,
- const ssize_t x,const ssize_t y,MagickPixelPacket *pixel,
+ const ssize_t x,const ssize_t y,PixelInfo *pixel,
ExceptionInfo exception)
</pre>
<pre class="code">
MagickBooleanType GetOneVirtualMethodPixel(const Image image,
const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
- const ssize_t y,Pixelpacket *pixel,ExceptionInfo exception)
+ const ssize_t y,PixelPacket *pixel,ExceptionInfo exception)
</pre>
<p>A description of each parameter follows:</p>
<p>return any errors or warnings in this structure.</p>
</div>
-<h2><a href="http://www.imagemagick.org/api/MagickCore/cache_8c.html" id="GetVirtualIndexQueue">GetVirtualIndexQueue</a></h2>
+<h2><a href="http://www.imagemagick.org/api/MagickCore/cache_8c.html" id="GetVirtualMetacontent">GetVirtualMetacontent</a></h2>
<div class="doc-section">
-<p>GetVirtualIndexQueue() returns the virtual black channel or the colormap indexes associated with the last call to QueueAuthenticPixels() or GetVirtualPixels(). NULL is returned if the black channel or colormap indexes are not available.</p>
+<p>GetVirtualMetacontent() returns the virtual metacontent corresponding with the last call to QueueAuthenticPixels() or GetVirtualPixels(). NULL is returned if the meta-content are not available.</p>
-<p>The format of the GetVirtualIndexQueue() method is:</p>
+<p>The format of the GetVirtualMetacontent() method is:</p>
<pre class="code">
- const IndexPacket *GetVirtualIndexQueue(const Image *image)
+ const void *GetVirtualMetacontent(const Image *image)
</pre>
<p>A description of each parameter follows:</p>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cache_8c.html" id="GetVirtualPixelQueue">GetVirtualPixelQueue</a></h2>
<div class="doc-section">
-<p>GetVirtualPixelQueue() returns the virtual pixels associated with the last call to QueueAuthenticPixels() or GetVirtualPixels().</p>
+<p>GetVirtualPixelQueue() returns the virtual pixels associated corresponding with the last call to QueueAuthenticPixels() or GetVirtualPixels().</p>
<p>The format of the GetVirtualPixelQueue() method is:</p>
<pre class="code">
- const PixelPacket *GetVirtualPixelQueue(const Image image)
+ const Quantum *GetVirtualPixelQueue(const Image image)
</pre>
<p>A description of each parameter follows:</p>
<p>GetVirtualPixels() returns an immutable pixel region. If the region is successfully accessed, a pointer to it is returned, otherwise NULL is returned. The returned pointer may point to a temporary working copy of the pixels or it may point to the original pixels in memory. Performance is maximized if the selected region is part of one row, or one or more full rows, since there is opportunity to access the pixels in-place (without a copy) if the image is in memory, or in a memory-mapped file. The returned pointer must *never* be deallocated by the user.</p>
-<p>Pixels accessed via the returned pointer represent a simple array of type PixelPacket. If the image type is CMYK or the storage class is PseudoClass, call GetAuthenticIndexQueue() after invoking GetAuthenticPixels() to access the black color component or to obtain the colormap indexes (of type IndexPacket) corresponding to the region.</p>
+<p>Pixels accessed via the returned pointer represent a simple array of type Quantum. If the image type is CMYK or the storage class is PseudoClass, call GetAuthenticMetacontent() after invoking GetAuthenticPixels() to access the meta-content (of type void) corresponding to the the region.</p>
<p>If you plan to modify the pixels, use GetAuthenticPixels() instead.</p>
<p>The format of the GetVirtualPixels() method is:</p>
<pre class="code">
- const PixelPacket *GetVirtualPixels(const Image *image,const ssize_t x,
+ const Quantum *GetVirtualPixels(const Image *image,const ssize_t x,
const ssize_t y,const size_t columns,const size_t rows,
ExceptionInfo *exception)
</pre>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cache_8c.html" id="QueueAuthenticPixels">QueueAuthenticPixels</a></h2>
<div class="doc-section">
-<p>QueueAuthenticPixels() queues a mutable pixel region. If the region is successfully intialized a pointer to a PixelPacket array representing the region is returned, otherwise NULL is returned. The returned pointer may point to a temporary working buffer for the pixels or it may point to the final location of the pixels in memory.</p>
+<p>QueueAuthenticPixels() queues a mutable pixel region. If the region is successfully initialized a pointer to a Quantum array representing the region is returned, otherwise NULL is returned. The returned pointer may point to a temporary working buffer for the pixels or it may point to the final location of the pixels in memory.</p>
<p>Write-only access means that any existing pixel values corresponding to the region are ignored. This is useful if the initial image is being created from scratch, or if the existing pixel values are to be completely replaced without need to refer to their pre-existing values. The application is free to read and write the pixel buffer returned by QueueAuthenticPixels() any way it pleases. QueueAuthenticPixels() does not initialize the pixel array values. Initializing pixel array values is the application's responsibility.</p>
<p>Performance is maximized if the selected region is part of one row, or one or more full rows, since then there is opportunity to access the pixels in-place (without a copy) if the image is in memory, or in a memory-mapped file. The returned pointer must *never* be deallocated by the user.</p>
-<p>Pixels accessed via the returned pointer represent a simple array of type PixelPacket. If the image type is CMYK or the storage class is PseudoClass, call GetAuthenticIndexQueue() after invoking GetAuthenticPixels() to obtain the black color component or the colormap indexes (of type IndexPacket) corresponding to the region. Once the PixelPacket (and/or IndexPacket) array has been updated, the changes must be saved back to the underlying image using SyncAuthenticPixels() or they may be lost.</p>
+<p>Pixels accessed via the returned pointer represent a simple array of type Quantum. If the image type is CMYK or the storage class is PseudoClass, call GetAuthenticMetacontent() after invoking GetAuthenticPixels() to obtain the meta-content (of type void) corresponding to the region. Once the Quantum (and/or Quantum) array has been updated, the changes must be saved back to the underlying image using SyncAuthenticPixels() or they may be lost.</p>
<p>The format of the QueueAuthenticPixels() method is:</p>
<pre class="code">
- PixelPacket *QueueAuthenticPixels(Image *image,const ssize_t x,
+ Quantum *QueueAuthenticPixels(Image *image,const ssize_t x,
const ssize_t y,const size_t columns,const size_t rows,
ExceptionInfo *exception)
</pre>
projects / imagemagick / blobdiff