1 2 3 4 5<!DOCTYPE html> 6<html lang="en"> 7<head> 8 <meta charset="utf-8" /> 9 <meta name="viewport" content="width=device-width,minimum-scale=1,initial-scale=1,shrink-to-fit=no" /> 10 <title>MagickWand, C API: Pixel Iterator Methods @ ImageMagick</title> 11 <meta name="application-name" content="ImageMagick" /> 12 <meta name="description" content="Use ImageMagick® to create, edit, compose, or convert bitmap images. You can resize your image, crop it, change its shades and colors, add captions, among other operations." /> 13 <meta name="application-url" content="https://imagemagick.org" /> 14 <meta name="generator" content="PHP" /> 15 <meta name="keywords" content="magickwc, api:, pixel, iterator, methods, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert" /> 16 <meta name="rating" content="GENERAL" /> 17 <meta name="robots" content="INDEX, FOLLOW" /> 18 <meta name="generator" content="ImageMagick Studio LLC" /> 19 <meta name="author" content="ImageMagick Studio LLC" /> 20 <meta name="revisit-after" content="2 DAYS" /> 21 <meta name="resource-type" content="document" /> 22 <meta name="copyright" content="Copyright (c) 1999-2017 ImageMagick Studio LLC" /> 23 <meta name="distribution" content="Global" /> 24 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1" /> 25 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" /> 26 <link href="pixel-iterator.html" rel="canonical" /> 27 <link href="../../images/wand.png" rel="icon" /> 28 <link href="../../images/wand.ico" rel="shortcut icon" /> 29 <link href="../assets/magick.css" rel="stylesheet" /> 30</head> 31<body> 32 <header> 33 <nav class="navbar navbar-expand-md navbar-dark fixed-top bg-dark"> 34 <a class="navbar-brand" href="../../"><img class="d-block" id="icon" alt="ImageMagick" width="32" height="32" src="../../images/wand.ico"/></a> 35 <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarsMagick" aria-controls="navbarsMagick" aria-expanded="false" aria-label="Toggle navigation"> 36 <span class="navbar-toggler-icon"></span> 37 </button> 38 39 <div class="navbar-collapse collapse" id="navbarsMagick" style=""> 40 <ul class="navbar-nav mr-auto"> 41 <li class="nav-item "> 42 <a class="nav-link" href="quantize.html">Home <span class="sr-only">(current)</span></a> 43 </li> 44 <li class="nav-item "> 45 <a class="nav-link" href="../../www/download.html">Download</a> 46 </li> 47 <li class="nav-item "> 48 <a class="nav-link" href="../../www/command-line-tools.html">Tools</a> 49 </li> 50 <li class="nav-item "> 51 <a class="nav-link" href="../../www/command-line-processing.html">Command-line</a> 52 </li> 53 <li class="nav-item "> 54 <a class="nav-link" href="../../www/resources.html">Resources</a> 55 </li> 56 <li class="nav-item "> 57 <a class="nav-link" href="../../www/develop.html">Develop</a> 58 </li> 59 <li class="nav-item"> 60 <a class="nav-link" target="_blank" href="https://imagemagick.org/discourse-server/">Community</a> 61 </li> 62 </ul> 63 <form class="form-inline my-2 my-lg-0" action="https://imagemagick.org/script/search.php"> 64 <input class="form-control mr-sm-2" type="text" name="q" placeholder="Search" aria-label="Search"> 65 <button class="btn btn-outline-success my-2 my-sm-0" type="submit" name="sa">Search</button> 66 </form> 67 </div> 68 </nav> 69 <div class="container"> 70 <script async="async" src="https://localhost/pagead/js/adsbygoogle.js"></script> <ins class="adsbygoogle" 71 style="display:block" 72 data-ad-client="ca-pub-3129977114552745" 73 data-ad-slot="6345125851" 74 data-ad-format="auto"></ins> 75 <script> 76 (adsbygoogle = window.adsbygoogle || []).push({}); 77 </script> 78 79 </div> 80 </header> 81 <main class="container"> 82 <div class="magick-template"> 83<div class="magick-header"> 84<p class="text-center"><a href="pixel-iterator.html#ClearPixelIterator">ClearPixelIterator</a> • <a href="pixel-iterator.html#ClonePixelIterator">ClonePixelIterator</a> • <a href="pixel-iterator.html#DestroyPixelIterator">DestroyPixelIterator</a> • <a href="pixel-iterator.html#IsPixelIterator">IsPixelIterator</a> • <a href="pixel-iterator.html#NewPixelIterator">NewPixelIterator</a> • <a href="pixel-iterator.html#PixelClearIteratorException">PixelClearIteratorException</a> • <a href="pixel-iterator.html#NewPixelRegionIterator">NewPixelRegionIterator</a> • <a href="pixel-iterator.html#PixelGetCurrentIteratorRow">PixelGetCurrentIteratorRow</a> • <a href="pixel-iterator.html#PixelGetIteratorException">PixelGetIteratorException</a> • <a href="pixel-iterator.html#PixelGetIteratorExceptionType">PixelGetIteratorExceptionType</a> • <a href="pixel-iterator.html#PixelGetIteratorRow">PixelGetIteratorRow</a> • <a href="pixel-iterator.html#PixelGetNextIteratorRow">PixelGetNextIteratorRow</a> • <a href="pixel-iterator.html#PixelGetPreviousIteratorRow">PixelGetPreviousIteratorRow</a> • <a href="pixel-iterator.html#PixelResetIterator">PixelResetIterator</a> • <a href="pixel-iterator.html#PixelSetFirstIteratorRow">PixelSetFirstIteratorRow</a> • <a href="pixel-iterator.html#PixelSetIteratorRow">PixelSetIteratorRow</a> • <a href="pixel-iterator.html#PixelSetLastIteratorRow">PixelSetLastIteratorRow</a> • <a href="pixel-iterator.html#PixelSyncIterator">PixelSyncIterator</a></p> 85 86<h2><a href="../../api/MagickWand/pixel-iterator_8c.html" id="ClearPixelIterator">ClearPixelIterator</a></h2> 87 88<p>ClearPixelIterator() clear resources associated with a PixelIterator.</p> 89 90<p>The format of the ClearPixelIterator method is:</p> 91 92<pre class="text"> 93void ClearPixelIterator(PixelIterator *iterator) 94</pre> 95 96<p>A description of each parameter follows:</p> 97 98<dd> 99</dd> 100 101<dd> </dd> 102<dl class="dl-horizontal"> 103<dt>iterator</dt> 104<dd>the pixel iterator. </dd> 105 106<dd> </dd> 107</dl> 108<h2><a href="../../api/MagickWand/pixel-iterator_8c.html" id="ClonePixelIterator">ClonePixelIterator</a></h2> 109 110<p>ClonePixelIterator() makes an exact copy of the specified iterator.</p> 111 112<p>The format of the ClonePixelIterator method is:</p> 113 114<pre class="text"> 115PixelIterator *ClonePixelIterator(const PixelIterator *iterator) 116</pre> 117 118<p>A description of each parameter follows:</p> 119 120<dd> 121</dd> 122 123<dd> </dd> 124<dl class="dl-horizontal"> 125<dt>iterator</dt> 126<dd>the magick iterator. </dd> 127 128<dd> </dd> 129</dl> 130<h2><a href="../../api/MagickWand/pixel-iterator_8c.html" id="DestroyPixelIterator">DestroyPixelIterator</a></h2> 131 132<p>DestroyPixelIterator() deallocates resources associated with a PixelIterator.</p> 133 134<p>The format of the DestroyPixelIterator method is:</p> 135 136<pre class="text"> 137PixelIterator *DestroyPixelIterator(PixelIterator *iterator) 138</pre> 139 140<p>A description of each parameter follows:</p> 141 142<dd> 143</dd> 144 145<dd> </dd> 146<dl class="dl-horizontal"> 147<dt>iterator</dt> 148<dd>the pixel iterator. </dd> 149 150<dd> </dd> 151</dl> 152<h2><a href="../../api/MagickWand/pixel-iterator_8c.html" id="IsPixelIterator">IsPixelIterator</a></h2> 153 154<p>IsPixelIterator() returns MagickTrue if the iterator is verified as a pixel iterator.</p> 155 156<p>The format of the IsPixelIterator method is:</p> 157 158<pre class="text"> 159MagickBooleanType IsPixelIterator(const PixelIterator *iterator) 160</pre> 161 162<p>A description of each parameter follows:</p> 163 164<dd> 165</dd> 166 167<dd> </dd> 168<dl class="dl-horizontal"> 169<dt>iterator</dt> 170<dd>the magick iterator. </dd> 171 172<dd> </dd> 173</dl> 174<h2><a href="../../api/MagickWand/pixel-iterator_8c.html" id="NewPixelIterator">NewPixelIterator</a></h2> 175 176<p>NewPixelIterator() returns a new pixel iterator.</p> 177 178<p>The format of the NewPixelIterator method is:</p> 179 180<pre class="text"> 181PixelIterator *NewPixelIterator(MagickWand *wand) 182</pre> 183 184<p>A description of each parameter follows:</p> 185 186<dd> 187</dd> 188 189<dd> </dd> 190<dl class="dl-horizontal"> 191<dt>wand</dt> 192<dd>the magick wand. </dd> 193 194<dd> </dd> 195</dl> 196<h2><a href="../../api/MagickWand/pixel-iterator_8c.html" id="PixelClearIteratorException">PixelClearIteratorException</a></h2> 197 198<p>PixelClearIteratorException() clear any exceptions associated with the iterator.</p> 199 200<p>The format of the PixelClearIteratorException method is:</p> 201 202<pre class="text"> 203MagickBooleanType PixelClearIteratorException(PixelIterator *iterator) 204</pre> 205 206<p>A description of each parameter follows:</p> 207 208<dd> 209</dd> 210 211<dd> </dd> 212<dl class="dl-horizontal"> 213<dt>iterator</dt> 214<dd>the pixel iterator. </dd> 215 216<dd> </dd> 217</dl> 218<h2><a href="../../api/MagickWand/pixel-iterator_8c.html" id="NewPixelRegionIterator">NewPixelRegionIterator</a></h2> 219 220<p>NewPixelRegionIterator() returns a new pixel iterator.</p> 221 222<p>The format of the NewPixelRegionIterator method is:</p> 223 224<pre class="text"> 225PixelIterator *NewPixelRegionIterator(MagickWand *wand,const ssize_t x, 226 const ssize_t y,const size_t width,const size_t height) 227</pre> 228 229<p>A description of each parameter follows:</p> 230 231<dd> 232</dd> 233 234<dd> </dd> 235<dl class="dl-horizontal"> 236<dt>wand</dt> 237<dd>the magick wand. </dd> 238 239<dd> </dd> 240<dt>x,y,columns,rows</dt> 241<dd> These values define the perimeter of a region of pixels. </dd> 242 243<dd> </dd> 244</dl> 245<h2><a href="../../api/MagickWand/pixel-iterator_8c.html" id="PixelGetCurrentIteratorRow">PixelGetCurrentIteratorRow</a></h2> 246 247<p>PixelGetCurrentIteratorRow() returns the current row as an array of pixel wands from the pixel iterator.</p> 248 249<p>The format of the PixelGetCurrentIteratorRow method is:</p> 250 251<pre class="text"> 252PixelWand **PixelGetCurrentIteratorRow(PixelIterator *iterator, 253 size_t *number_wands) 254</pre> 255 256<p>A description of each parameter follows:</p> 257 258<dd> 259</dd> 260 261<dd> </dd> 262<dl class="dl-horizontal"> 263<dt>iterator</dt> 264<dd>the pixel iterator. </dd> 265 266<dd> </dd> 267<dt>number_wands</dt> 268<dd>the number of pixel wands. </dd> 269 270<dd> </dd> 271</dl> 272<h2><a href="../../api/MagickWand/pixel-iterator_8c.html" id="PixelGetIteratorException">PixelGetIteratorException</a></h2> 273 274<p>PixelGetIteratorException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p> 275 276<p>The format of the PixelGetIteratorException method is:</p> 277 278<pre class="text"> 279char *PixelGetIteratorException(const PixelIterator *iterator, 280 ExceptionType *severity) 281</pre> 282 283<p>A description of each parameter follows:</p> 284 285<dd> 286</dd> 287 288<dd> </dd> 289<dl class="dl-horizontal"> 290<dt>iterator</dt> 291<dd>the pixel iterator. </dd> 292 293<dd> </dd> 294<dt>severity</dt> 295<dd>the severity of the error is returned here. </dd> 296 297<dd> </dd> 298</dl> 299<h2><a href="../../api/MagickWand/pixel-iterator_8c.html" id="PixelGetIteratorExceptionType">PixelGetIteratorExceptionType</a></h2> 300 301<p>PixelGetIteratorExceptionType() the exception type associated with the iterator. If no exception has occurred, UndefinedExceptionType is returned.</p> 302 303<p>The format of the PixelGetIteratorExceptionType method is:</p> 304 305<pre class="text"> 306ExceptionType PixelGetIteratorExceptionType( 307 const PixelIterator *iterator) 308</pre> 309 310<p>A description of each parameter follows:</p> 311 312<dd> 313</dd> 314 315<dd> </dd> 316<dl class="dl-horizontal"> 317<dt>iterator</dt> 318<dd>the pixel iterator. </dd> 319 320<dd> </dd> 321</dl> 322<h2><a href="../../api/MagickWand/pixel-iterator_8c.html" id="PixelGetIteratorRow">PixelGetIteratorRow</a></h2> 323 324<p>PixelGetIteratorRow() returns the current pixel iterator row.</p> 325 326<p>The format of the PixelGetIteratorRow method is:</p> 327 328<pre class="text"> 329MagickBooleanType PixelGetIteratorRow(PixelIterator *iterator) 330</pre> 331 332<p>A description of each parameter follows:</p> 333 334<dd> 335</dd> 336 337<dd> </dd> 338<dl class="dl-horizontal"> 339<dt>iterator</dt> 340<dd>the pixel iterator. </dd> 341 342<dd> </dd> 343</dl> 344<h2><a href="../../api/MagickWand/pixel-iterator_8c.html" id="PixelGetNextIteratorRow">PixelGetNextIteratorRow</a></h2> 345 346<p>PixelGetNextIteratorRow() returns the next row as an array of pixel wands from the pixel iterator.</p> 347 348<p>The format of the PixelGetNextIteratorRow method is:</p> 349 350<pre class="text"> 351PixelWand **PixelGetNextIteratorRow(PixelIterator *iterator, 352 size_t *number_wands) 353</pre> 354 355<p>A description of each parameter follows:</p> 356 357<dd> 358</dd> 359 360<dd> </dd> 361<dl class="dl-horizontal"> 362<dt>iterator</dt> 363<dd>the pixel iterator. </dd> 364 365<dd> </dd> 366<dt>number_wands</dt> 367<dd>the number of pixel wands. </dd> 368 369<dd> </dd> 370</dl> 371<h2><a href="../../api/MagickWand/pixel-iterator_8c.html" id="PixelGetPreviousIteratorRow">PixelGetPreviousIteratorRow</a></h2> 372 373<p>PixelGetPreviousIteratorRow() returns the previous row as an array of pixel wands from the pixel iterator.</p> 374 375<p>The format of the PixelGetPreviousIteratorRow method is:</p> 376 377<pre class="text"> 378PixelWand **PixelGetPreviousIteratorRow(PixelIterator *iterator, 379 size_t *number_wands) 380</pre> 381 382<p>A description of each parameter follows:</p> 383 384<dd> 385</dd> 386 387<dd> </dd> 388<dl class="dl-horizontal"> 389<dt>iterator</dt> 390<dd>the pixel iterator. </dd> 391 392<dd> </dd> 393<dt>number_wands</dt> 394<dd>the number of pixel wands. </dd> 395 396<dd> </dd> 397</dl> 398<h2><a href="../../api/MagickWand/pixel-iterator_8c.html" id="PixelResetIterator">PixelResetIterator</a></h2> 399 400<p>PixelResetIterator() resets the pixel iterator. Use it in conjunction with PixelGetNextIteratorRow() to iterate over all the pixels in a pixel container.</p> 401 402<p>The format of the PixelResetIterator method is:</p> 403 404<pre class="text"> 405void PixelResetIterator(PixelIterator *iterator) 406</pre> 407 408<p>A description of each parameter follows:</p> 409 410<dd> 411</dd> 412 413<dd> </dd> 414<dl class="dl-horizontal"> 415<dt>iterator</dt> 416<dd>the pixel iterator. </dd> 417 418<dd> </dd> 419</dl> 420<h2><a href="../../api/MagickWand/pixel-iterator_8c.html" id="PixelSetFirstIteratorRow">PixelSetFirstIteratorRow</a></h2> 421 422<p>PixelSetFirstIteratorRow() sets the pixel iterator to the first pixel row.</p> 423 424<p>The format of the PixelSetFirstIteratorRow method is:</p> 425 426<pre class="text"> 427void PixelSetFirstIteratorRow(PixelIterator *iterator) 428</pre> 429 430<p>A description of each parameter follows:</p> 431 432<dd> 433</dd> 434 435<dd> </dd> 436<dl class="dl-horizontal"> 437<dt>iterator</dt> 438<dd>the magick iterator. </dd> 439 440<dd> </dd> 441</dl> 442<h2><a href="../../api/MagickWand/pixel-iterator_8c.html" id="PixelSetIteratorRow">PixelSetIteratorRow</a></h2> 443 444<p>PixelSetIteratorRow() set the pixel iterator row.</p> 445 446<p>The format of the PixelSetIteratorRow method is:</p> 447 448<pre class="text"> 449MagickBooleanType PixelSetIteratorRow(PixelIterator *iterator, 450 const ssize_t row) 451</pre> 452 453<p>A description of each parameter follows:</p> 454 455<dd> 456</dd> 457 458<dd> </dd> 459<dl class="dl-horizontal"> 460<dt>iterator</dt> 461<dd>the pixel iterator. </dd> 462 463<dd> </dd> 464</dl> 465<h2><a href="../../api/MagickWand/pixel-iterator_8c.html" id="PixelSetLastIteratorRow">PixelSetLastIteratorRow</a></h2> 466 467<p>PixelSetLastIteratorRow() sets the pixel iterator to the last pixel row.</p> 468 469<p>The format of the PixelSetLastIteratorRow method is:</p> 470 471<pre class="text"> 472void PixelSetLastIteratorRow(PixelIterator *iterator) 473</pre> 474 475<p>A description of each parameter follows:</p> 476 477<dd> 478</dd> 479 480<dd> </dd> 481<dl class="dl-horizontal"> 482<dt>iterator</dt> 483<dd>the magick iterator. </dd> 484 485<dd> </dd> 486</dl> 487<h2><a href="../../api/MagickWand/pixel-iterator_8c.html" id="PixelSyncIterator">PixelSyncIterator</a></h2> 488 489<p>PixelSyncIterator() syncs the pixel iterator.</p> 490 491<p>The format of the PixelSyncIterator method is:</p> 492 493<pre class="text"> 494MagickBooleanType PixelSyncIterator(PixelIterator *iterator) 495</pre> 496 497<p>A description of each parameter follows:</p> 498 499<dd> 500</dd> 501 502<dd> </dd> 503<dl class="dl-horizontal"> 504<dt>iterator</dt> 505<dd>the pixel iterator. </dd> 506 507<dd> </dd> 508</dl> 509</div> 510 </div> 511 </main><!-- /.container --> 512 <footer class="magick-footer"> 513 <p><a href="../../www/security-policy.html">Security</a> • 514 <a href="../../www/architecture.html">Architecture</a> • 515 <a href="../../www/links.html">Related</a> • 516 <a href="../../www/sitemap.html">Sitemap</a> 517 518 <a href="pixel-iterator.html#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../../images/wand.ico"/></a> 519 520 <a href="http://pgp.mit.edu/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> • 521 <a href="../../www/support.html">Donate</a> • 522 <a href="../../www/contact.html">Contact Us</a> 523 <br/> 524 <small>© 1999-2019 ImageMagick Studio LLC</small></p> 525 </footer> 526 527 <!-- Javascript assets --> 528 <script src="../assets/magick.js" crossorigin="anonymous"></script> 529 <script>window.jQuery || document.write('<script src="https://localhost/ajax/libs/jquery/3.3.1/jquery.min.js"><\/script>')</script> 530</body> 531</html> 532<!-- Magick Cache 30th December 2018 04:25 -->
