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