Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 751980dac8acbf24b155ae0d3b45fdf4c452f55c / . / www / api / wand-view.html
blob: 7ac08c9ed91eee52b627f5bb015d71378a691de3 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html version="-//W3C//DTD XHTML 1.1//EN"
xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.w3.org/1999/xhtml
http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
<meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>
<title>ImageMagick: MagickWand, C API for ImageMagick: Wand View Methods</title>
<meta http-equiv="content-language" content="en-US"/>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta http-equiv="reply-to" content="magick-users@imagemagick.org"/>
<meta name="application-name" content="ImageMagick"/>
<meta name="description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition resize, rotate, shear, distort and transform images automagically."/>
<meta name="application-url" content="http://www.imagemagick.org"/>
<meta name="generator" content="PHP"/>
<meta name="keywords" content="magickwc, api, for, imagemagick:, wview, methods, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
<meta name="rating" content="GENERAL"/>
<meta name="robots" content="INDEX, FOLLOW"/>
<meta name="generator" content="ImageMagick Studio LLC"/>
<meta name="author" content="ImageMagick Studio LLC"/>
<meta name="revisit-after" content="2 DAYS"/>
<meta name="resource-type" content="document"/>
<meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"/>
<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" />
<link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
<!-- Add jQuery library -->
<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
<!-- Optionaly include easing and/or mousewheel plugins -->
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.easing-1.3.pack.js"></script>
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.mousewheel-3.0.6.pack.js"></script>
<!-- Add fancyBox -->
<link rel="stylesheet" href="http://www.imagemagick.org/fancybox/jquery.fancybox.css?v=2.0.4" type="text/css" media="screen" />
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox.pack.js?v=2.0.4"></script>
<!-- Optionaly include button and/or thumbnail helpers -->
<link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.css?v=2.0.4" type="text/css" media="screen" />
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.js?v=2.0.4"></script>
<link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.css?v=2.0.4" type="text/css" media="screen" />
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.js?v=2.0.4"></script>
<script type="text/javascript">
$(document).ready(function() {
$(".fancybox").fancybox();
});
</script>
<!-- ImageMagick style -->
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
<style type="text/css" media="all">
@import url("../../../../../../../../../../../../../../../../www/magick.css");
</style>
</head>
<body id="www-imagemagick-org">
<div class="titlebar">
<div style="margin: 17px auto; float: left;">
<script type="text/javascript">
<!--
google_ad_client = "pub-3129977114552745";
google_ad_slot = "5439289906";
google_ad_width = 728;
google_ad_height = 90;
//-->
</script>
<script type="text/javascript"
src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
</script>
</div>
<a href="../../../../../../../../../../../../../../../../discourse-server">
<img src="../../../../../../../../../../../../../../../../images/logo.jpg"
alt="ImageMagick Logo"
style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
<a href="../../../../../../../../../../../../../../../../index.html">
<img src="../../../../../../../../../../../../../../../../images/sprite.jpg"
alt="ImageMagick Sprite"
style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
</div>
<div class="westbar">
<div class="menu">
<a title="About ImageMagick" href="../../../../../../../../../../../../../../../../index.html">About ImageMagick</a>
</div>
<div class="menu">
<a title="Binary Releases" href="../../../../../../../../../../../../../../../../www/binary-releases.html">Binary Releases</a>
</div>
<div class="sub">
<a title="Binary Release: Unix" href="../../../../../../../../../../../../../../../../www/binary-releases.html#unix">Unix</a>
</div>
<div class="sub">
<a title="Binary Release: MacOS X" href="../../../../../../../../../../../../../../../../www/binary-releases.html#macosx">Mac OS X</a>
</div>
<div class="sub">
<a title="Binary Release: iOS" href="../../../../../../../../../../../../../../../../www/binary-releases.html#iOS">iOS</a>
</div>
<div class="sub">
<a title="Binary Release: Windows" href="../../../../../../../../../../../../../../../../www/binary-releases.html#windows">Windows</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Command-line Tools" href="../../../../../../../../../../../../../../../../www/command-line-tools.html">Command-line Tools</a>
</div>
<div class="sub">
<a title="Command-line Tools: Processing" href="../../../../../../../../../../../../../../../../www/command-line-processing.html">Processing</a>
</div>
<div class="sub">
<a title="Command-line Tools: Options" href="../../../../../../../../../../../../../../../../www/command-line-options.html">Options</a>
</div>
<div class="sub">
<a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
</div>
<div class="menu">
<a title="Program Interfaces" href="../../../../../../../../../../../../../../../../www/api.html">Program Interfaces</a>
</div>
<div class="sub">
<a title="Program Interface: MagickWand" href="../../../../../../../../../../../../../../../../www/magick-wand.html">MagickWand</a>
</div>
<div class="sub">
<a title="Program Interface: MagickCore" href="../../../../../../../../../../../../../../../../www/magick-core.html">MagickCore</a>
</div>
<div class="sub">
<a title="Program Interface: PerlMagick" href="../../../../../../../../../../../../../../../../www/perl-magick.html">PerlMagick</a>
</div>
<div class="sub">
<a title="Program Interface: Magick++" href="../../../../../../../../../../../../../../../../www/magick++.html">Magick++</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Install from Source" href="../../../../../../../../../../../../../../../../www/install-source.html">Install from Source</a>
</div>
<div class="sub">
<a title="Install from Source: Unix" href="../../../../../../../../../../../../../../../../www/install-source.html#unix">Unix</a>
</div>
<div class="sub">
<a title="Install from Source: Windows" href="../../../../../../../../../../../../../../../../www/install-source.html#windows">Windows</a>
</div>
<div class="menu">
<a title="Resources" href="../../../../../../../../../../../../../../../../www/resources.html">Resources</a>
</div>
<div class="menu">
<a title="Architecture" href="../../../../../../../../../../../../../../../../www/architecture.html">Architecture</a>
</div>
<div class="menu">
<a title="Download" href="../../../../../../../../../../../../../../../../www/download.html">Download</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Search" href="../../../../../../../../../../../../../../../../www/search.html">Search</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Site Map" href="../../../../../../../../../../../../../../../../www/sitemap.html">Site Map</a>
</div>
<div class="sub">
<a title="Site Map: Links" href="../../../../../../../../../../../../../../../../www/links.html">Links</a>
</div>
<div class="sep"></div>
<div class="menu">
<a rel="follow" title="Sponsors" href="../../../../../../../../../../../../../../../../www/sponsors.html">Sponsors:</a>
<a href="http://www.networkredux.com"> <img src="../../../../../../../../../../../../../../../../images/networkredux.png" width="140" height="31" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
<a href="http://www.dinodirect.com/ipads-tablets/"> <img src="../../../../../../../../../../../../../../../../images/dino-direct.jpg" width="140" height="90" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a><!-- 201208010120 mickey@163... -->
<div class="sponsbox">
<div class="sponsor">
<a rel="follow" title="Sponsor: The Fastest &amp; Easiest Way to Find Images" href="http://www.graphicsfactory.com">The Fastest &amp; Easiest Way to Find Images</a><!-- 201210010270 graphicsfac... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201209010090 barsh@inter... -->
</div>
<div class="sponsor">
<a rel="follow" title="Werbebanner Werbeplane" href="http://www.allesbanner.de">Werbebanner Werbeplane</a><!-- 201212010450 info@druck... -->
</div>
<div class="sponsor">
<a rel="follow" title="Entertainment News &amp; Photos" href="http://www.zimbio.com">Entertainment News &amp; Photos</a><!-- 201211010540 bd@zimb... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: LED24" href="http://led24.de/">LED24</a><!-- 201207010270 info@led24... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Best Website Hosting" href="http://www.top-cheap-web-hosting.com">Best Website Hosting</a><!-- 201304010090 eunge.liu-->
</div>
<div class="sponsor">
<a rel="follow" title="Android Tablet" href="http://www.dinodirect.com/ipads-tablets/">Android Tablet</a><!-- 201208010120 mickey@163... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Web Site Hosting" href="http://webhostinggeeks.com">Web Site Hosting</a><!-- 201302010900 funds@enmob... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Premium Quality Stock Photos" href="http://www.f1online.pro/en/">Premium Quality Stock Photos</a><!-- 2012080100540 ... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Notebook Reparatur" href="http://www.notebook-reparaturen-berlin.de">Notebook Reparatur</a><!-- 2012080100300 atlas-multimedia-->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Web Hosting" href="http://www.hostucan.com">Web Hosting</a><!-- 2012120100150 racent marketing@webhosting...-->
</div>
</div>
</div>
</div>
<div class="eastbar">
<div class="g-plusone" id="gplusone"></div>
<script type="text/javascript">
window.___gcfg = {
lang: 'en-US'
};
(function() {
var po = document.createElement('script');
po.type = 'text/javascript'; po.async = true;
po.src = 'https://apis.google.com/js/plusone.js';
var script = document.getElementsByTagName('script')[0];
script.parentNode.insertBefore(po, script);
})();
var gplusone = document.getElementById("gplusone");
gplusone.setAttribute("data-size","medium");
gplusone.setAttribute("data-count","false");
</script>
</div>
<div class="main">
<h1>Module wand-view Methods</h1>
<p class="navigation-index">[<a href="wand-view.html#CloneWandView">CloneWandView</a> &bull; <a href="wand-view.html#DestroyWandView">DestroyWandView</a> &bull; <a href="wand-view.html#DuplexTransferWandViewIterator">DuplexTransferWandViewIterator</a> &bull; <a href="wand-view.html#GetWandViewException">GetWandViewException</a> &bull; <a href="wand-view.html#GetWandViewExtent">GetWandViewExtent</a> &bull; <a href="wand-view.html#GetWandViewIterator">GetWandViewIterator</a> &bull; <a href="wand-view.html#GetWandViewPixels">GetWandViewPixels</a> &bull; <a href="wand-view.html#GetWandViewWand">GetWandViewWand</a> &bull; <a href="wand-view.html#IsWandView">IsWandView</a> &bull; <a href="wand-view.html#NewWandView">NewWandView</a> &bull; <a href="wand-view.html#NewWandViewExtent">NewWandViewExtent</a> &bull; <a href="wand-view.html#SetWandViewDescription">SetWandViewDescription</a> &bull; <a href="wand-view.html#SetWandViewIterator">SetWandViewIterator</a> &bull; <a href="wand-view.html#SetWandViewThreads">SetWandViewThreads</a> &bull; <a href="wand-view.html#TransferWandViewIterator">TransferWandViewIterator</a> &bull; <a href="wand-view.html#UpdateWandViewIterator">UpdateWandViewIterator</a>]</p>
<h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view_8c.html" id="CloneWandView">CloneWandView</a></h2>
<div class="doc-section">
<p>CloneWandView() makes a copy of the specified wand view.</p>
<p>The format of the CloneWandView method is:</p>
<pre class="code">
WandView *CloneWandView(const WandView *wand_view)
</pre>
<p>A description of each parameter follows:</p>
<h5>wand_view</h5>
<p>the wand view.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view_8c.html" id="DestroyWandView">DestroyWandView</a></h2>
<div class="doc-section">
<p>DestroyWandView() deallocates memory associated with a wand view.</p>
<p>The format of the DestroyWandView method is:</p>
<pre class="code">
WandView *DestroyWandView(WandView *wand_view)
</pre>
<p>A description of each parameter follows:</p>
<h5>wand_view</h5>
<p>the wand view.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view_8c.html" id="DuplexTransferWandViewIterator">DuplexTransferWandViewIterator</a></h2>
<div class="doc-section">
<p>DuplexTransferWandViewIterator() iterates over three wand views in parallel and calls your transfer method for each scanline of the view. The source and duplex pixel extent is not confined to the image canvas-- that is you can include negative offsets or widths or heights that exceed the image dimension. However, the destination wand view is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension are permitted.</p>
<p>The callback signature is:</p>
<pre class="text">
MagickBooleanType DuplexTransferImageViewMethod(const WandView *source,
const WandView *duplex,WandView *destination,const ssize_t y,
const int thread_id,void *context)
</pre>
<p>Use this pragma if the view is not single threaded:</p>
<pre class="text">
#pragma omp critical
</pre>
<p>to define a section of code in your callback transfer method that must be executed by a single thread at a time.</p>
<p>The format of the DuplexTransferWandViewIterator method is:</p>
<pre class="code">
MagickBooleanType DuplexTransferWandViewIterator(WandView *source,
WandView *duplex,WandView *destination,
DuplexTransferWandViewMethod transfer,void *context)
</pre>
<p>A description of each parameter follows:</p>
<h5>source</h5>
<p>the source wand view.</p>
<h5>duplex</h5>
<p>the duplex wand view.</p>
<h5>destination</h5>
<p>the destination wand view.</p>
<h5>transfer</h5>
<p>the transfer callback method.</p>
<h5>context</h5>
<p>the user defined context.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view_8c.html" id="GetWandViewException">GetWandViewException</a></h2>
<div class="doc-section">
<p>GetWandViewException() returns the severity, reason, and description of any error that occurs when utilizing a wand view.</p>
<p>The format of the GetWandViewException method is:</p>
<pre class="code">
char *GetWandViewException(const WandView *wand_view,
ExceptionType *severity)
</pre>
<p>A description of each parameter follows:</p>
<h5>wand_view</h5>
<p>the pixel wand_view.</p>
<h5>severity</h5>
<p>the severity of the error is returned here.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view_8c.html" id="GetWandViewExtent">GetWandViewExtent</a></h2>
<div class="doc-section">
<p>GetWandViewExtent() returns the wand view extent.</p>
<p>The format of the GetWandViewExtent method is:</p>
<pre class="code">
RectangleInfo GetWandViewExtent(const WandView *wand_view)
</pre>
<p>A description of each parameter follows:</p>
<h5>wand_view</h5>
<p>the wand view.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view_8c.html" id="GetWandViewIterator">GetWandViewIterator</a></h2>
<div class="doc-section">
<p>GetWandViewIterator() iterates over the wand view in parallel and calls your get method for each scanline of the view. The pixel extent is not confined to the image canvas-- that is you can include negative offsets or widths or heights that exceed the image dimension. Any updates to the pixels in your callback are ignored.</p>
<p>The callback signature is:</p>
<pre class="text">
MagickBooleanType GetImageViewMethod(const WandView *source,
const ssize_t y,const int thread_id,void *context)
</pre>
<p>Use this pragma if the view is not single threaded:</p>
<pre class="text">
#pragma omp critical
</pre>
<p>to define a section of code in your callback get method that must be executed by a single thread at a time.</p>
<p>The format of the GetWandViewIterator method is:</p>
<pre class="code">
MagickBooleanType GetWandViewIterator(WandView *source,
GetWandViewMethod get,void *context)
</pre>
<p>A description of each parameter follows:</p>
<h5>source</h5>
<p>the source wand view.</p>
<h5>get</h5>
<p>the get callback method.</p>
<h5>context</h5>
<p>the user defined context.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view_8c.html" id="GetWandViewPixels">GetWandViewPixels</a></h2>
<div class="doc-section">
<p>GetWandViewPixels() returns the wand view pixel_wands.</p>
<p>The format of the GetWandViewPixels method is:</p>
<pre class="code">
PixelWand *GetWandViewPixels(const WandView *wand_view)
</pre>
<p>A description of each parameter follows:</p>
<h5>wand_view</h5>
<p>the wand view.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view_8c.html" id="GetWandViewWand">GetWandViewWand</a></h2>
<div class="doc-section">
<p>GetWandViewWand() returns the magick wand associated with the wand view.</p>
<p>The format of the GetWandViewWand method is:</p>
<pre class="code">
MagickWand *GetWandViewWand(const WandView *wand_view)
</pre>
<p>A description of each parameter follows:</p>
<h5>wand_view</h5>
<p>the wand view.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view_8c.html" id="IsWandView">IsWandView</a></h2>
<div class="doc-section">
<p>IsWandView() returns MagickTrue if the the parameter is verified as a wand view object.</p>
<p>The format of the IsWandView method is:</p>
<pre class="code">
MagickBooleanType IsWandView(const WandView *wand_view)
</pre>
<p>A description of each parameter follows:</p>
<h5>wand_view</h5>
<p>the wand view.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view_8c.html" id="NewWandView">NewWandView</a></h2>
<div class="doc-section">
<p>NewWandView() returns a wand view required for all other methods in the Wand View API.</p>
<p>The format of the NewWandView method is:</p>
<pre class="code">
WandView *NewWandView(MagickWand *wand)
</pre>
<p>A description of each parameter follows:</p>
<h5>wand</h5>
<p>the wand.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view_8c.html" id="NewWandViewExtent">NewWandViewExtent</a></h2>
<div class="doc-section">
<p>NewWandViewExtent() returns a wand view required for all other methods in the Wand View API.</p>
<p>The format of the NewWandViewExtent method is:</p>
<pre class="code">
WandView *NewWandViewExtent(MagickWand *wand,const ssize_t x,
const ssize_t y,const size_t width,const size_t height)
</pre>
<p>A description of each parameter follows:</p>
<h5>wand</h5>
<p>the magick wand.</p>
<h5>x,y,columns,rows</h5>
<p>These values define the perimeter of a extent of pixel_wands view.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view_8c.html" id="SetWandViewDescription">SetWandViewDescription</a></h2>
<div class="doc-section">
<p>SetWandViewDescription() associates a description with an image view.</p>
<p>The format of the SetWandViewDescription method is:</p>
<pre class="code">
void SetWandViewDescription(WandView *image_view,const char *description)
</pre>
<p>A description of each parameter follows:</p>
<h5>wand_view</h5>
<p>the wand view.</p>
<h5>description</h5>
<p>the wand view description.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view_8c.html" id="SetWandViewIterator">SetWandViewIterator</a></h2>
<div class="doc-section">
<p>SetWandViewIterator() iterates over the wand view in parallel and calls your set method for each scanline of the view. The pixel extent is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension. The pixels are initiallly undefined and any settings you make in the callback method are automagically synced back to your image.</p>
<p>The callback signature is:</p>
<pre class="text">
MagickBooleanType SetImageViewMethod(ImageView *destination,
const ssize_t y,const int thread_id,void *context)
</pre>
<p>Use this pragma if the view is not single threaded:</p>
<pre class="text">
#pragma omp critical
</pre>
<p>to define a section of code in your callback set method that must be executed by a single thread at a time.</p>
<p>The format of the SetWandViewIterator method is:</p>
<pre class="code">
MagickBooleanType SetWandViewIterator(WandView *destination,
SetWandViewMethod set,void *context)
</pre>
<p>A description of each parameter follows:</p>
<h5>destination</h5>
<p>the wand view.</p>
<h5>set</h5>
<p>the set callback method.</p>
<h5>context</h5>
<p>the user defined context.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view_8c.html" id="SetWandViewThreads">SetWandViewThreads</a></h2>
<div class="doc-section">
<p>SetWandViewThreads() sets the number of threads in a thread team.</p>
<p>The format of the SetWandViewDescription method is:</p>
<pre class="code">
void SetWandViewThreads(WandView *image_view,
const size_t number_threads)
</pre>
<p>A description of each parameter follows:</p>
<h5>image_view</h5>
<p>the image view.</p>
<h5>number_threads</h5>
<p>the number of threads in a thread team.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view_8c.html" id="TransferWandViewIterator">TransferWandViewIterator</a></h2>
<div class="doc-section">
<p>TransferWandViewIterator() iterates over two wand views in parallel and calls your transfer method for each scanline of the view. The source pixel extent is not confined to the image canvas-- that is you can include negative offsets or widths or heights that exceed the image dimension. However, the destination wand view is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension are permitted.</p>
<p>The callback signature is:</p>
<pre class="text">
MagickBooleanType TransferImageViewMethod(const WandView *source,
WandView *destination,const ssize_t y,const int thread_id,
void *context)
</pre>
<p>Use this pragma if the view is not single threaded:</p>
<pre class="text">
#pragma omp critical
</pre>
<p>to define a section of code in your callback transfer method that must be executed by a single thread at a time.</p>
<p>The format of the TransferWandViewIterator method is:</p>
<pre class="code">
MagickBooleanType TransferWandViewIterator(WandView *source,
WandView *destination,TransferWandViewMethod transfer,void *context)
</pre>
<p>A description of each parameter follows:</p>
<h5>source</h5>
<p>the source wand view.</p>
<h5>destination</h5>
<p>the destination wand view.</p>
<h5>transfer</h5>
<p>the transfer callback method.</p>
<h5>context</h5>
<p>the user defined context.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view_8c.html" id="UpdateWandViewIterator">UpdateWandViewIterator</a></h2>
<div class="doc-section">
<p>UpdateWandViewIterator() iterates over the wand view in parallel and calls your update method for each scanline of the view. The pixel extent is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension are permitted. Updates to pixels in your callback are automagically synced back to the image.</p>
<p>The callback signature is:</p>
<pre class="text">
MagickBooleanType UpdateImageViewMethod(WandView *source,const ssize_t y,
const int thread_id,void *context)
</pre>
<p>Use this pragma if the view is not single threaded:</p>
<pre class="text">
#pragma omp critical
</pre>
<p>to define a section of code in your callback update method that must be executed by a single thread at a time.</p>
<p>The format of the UpdateWandViewIterator method is:</p>
<pre class="code">
MagickBooleanType UpdateWandViewIterator(WandView *source,
UpdateWandViewMethod update,void *context)
</pre>
<p>A description of each parameter follows:</p>
<h5>source</h5>
<p>the source wand view.</p>
<h5>update</h5>
<p>the update callback method.</p>
<h5>context</h5>
<p>the user defined context.</p>
</div>
</div>
<div id="linkbar">
<span id="linkbar-west">&nbsp;</span>
<span id="linkbar-center">
<a href="../../../../../../../../../../../../../../../../discourse-server">Discourse Server</a> &bull;
<a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
</span>
<span id="linkbar-east">&nbsp;</span>
</div>
<div class="footer">
<span id="footer-west">&copy; 1999-2012 ImageMagick Studio LLC</span>
<span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
</div>
<div style="clear: both; margin: 0; width: 100%; "></div>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-17690367-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</body>
</html>