1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
|
<!DOCTYPE html>
<html lang="en" data-bs-theme="dark">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>ImageMagick – MagickWand, C API: Wand View Methods</title>
<meta name="keywords" content="MagickWand, C API: Wand View Methods, Image Processing, Digital Image Editing, Image Conversion, Open-Source Software, Image Manipulation, Command-Line Image Tools" />
<meta name="description" content="ImageMagick is a powerful, open-source software suite for creating, editing, converting, and manipulating images in over 200 formats. Ideal for web developers, graphic designers, and researchers, it offers versatile tools for image processing, including batch processing, format conversion, and complex image transformations." />
<meta name="application-name" content="ImageMagick" />
<meta name="application-url" content="https://imagemagick.org" />
<meta name="copyright" content="Copyright (c) 1999 ImageMagick Studio LLC" />
<meta itemprop='url' content='../../' />
<meta itemprop='title' content='ImageMagick' />
<meta itemprop='description' content="ImageMagick is a powerful, open-source software suite for creating, editing, converting, and manipulating images in over 200 formats. Ideal for web developers, graphic designers, and researchers, it offers versatile tools for image processing, including batch processing, format conversion, and complex image transformations." />
<meta property='og:url' content='../../' />
<meta property='og:name' content='ImageMagick' />
<meta property='og:image' content='../../../images/logo.png' />
<meta property='og:type' content='website' />
<meta property='og:site_name' content='ImageMagick' />
<meta property='og:description' content="ImageMagick is a powerful, open-source software suite for creating, editing, converting, and manipulating images in over 200 formats. Ideal for web developers, graphic designers, and researchers, it offers versatile tools for image processing, including batch processing, format conversion, and complex image transformations." />
<meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
<link type="images/png" sizes="64x64" href="../../images/wand.png" rel="icon" />
<link type="images/icon" sizes="16x16" href="../../images/wand.ico" rel="shortcut icon" />
<link href="wand-view.html" rel="canonical" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@docsearch/css@3" />
<link href="../assets/magick.css" rel="stylesheet" />
<script src="../assets/color-modes.js" ></script>
</head>
<body>
<svg xmlns="http://www.w3.org/2000/svg" class="d-none">
<symbol id="check2" viewBox="0 0 16 16">
<path d="M13.854 3.646a.5.5 0 0 1 0 .708l-7 7a.5.5 0 0 1-.708 0l-3.5-3.5a.5.5 0 1 1 .708-.708L6.5 10.293l6.646-6.647a.5.5 0 0 1 .708 0z"/>
</symbol>
<symbol id="circle-half" viewBox="0 0 16 16">
<path d="M8 15A7 7 0 1 0 8 1v14zm0 1A8 8 0 1 1 8 0a8 8 0 0 1 0 16z"/>
</symbol>
<symbol id="moon-stars-fill" viewBox="0 0 16 16">
<path d="M6 .278a.768.768 0 0 1 .08.858 7.208 7.208 0 0 0-.878 3.46c0 4.021 3.278 7.277 7.318 7.277.527 0 1.04-.055 1.533-.16a.787.787 0 0 1 .81.316.733.733 0 0 1-.031.893A8.349 8.349 0 0 1 8.344 16C3.734 16 0 12.286 0 7.71 0 4.266 2.114 1.312 5.124.06A.752.752 0 0 1 6 .278z"/>
<path d="M10.794 3.148a.217.217 0 0 1 .412 0l.387 1.162c.173.518.579.924 1.097 1.097l1.162.387a.217.217 0 0 1 0 .412l-1.162.387a1.734 1.734 0 0 0-1.097 1.097l-.387 1.162a.217.217 0 0 1-.412 0l-.387-1.162A1.734 1.734 0 0 0 9.31 6.593l-1.162-.387a.217.217 0 0 1 0-.412l1.162-.387a1.734 1.734 0 0 0 1.097-1.097l.387-1.162zM13.863.099a.145.145 0 0 1 .274 0l.258.774c.115.346.386.617.732.732l.774.258a.145.145 0 0 1 0 .274l-.774.258a1.156 1.156 0 0 0-.732.732l-.258.774a.145.145 0 0 1-.274 0l-.258-.774a1.156 1.156 0 0 0-.732-.732l-.774-.258a.145.145 0 0 1 0-.274l.774-.258c.346-.115.617-.386.732-.732L13.863.1z"/>
</symbol>
<symbol id="sun-fill" viewBox="0 0 16 16">
<path d="M8 12a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM8 0a.5.5 0 0 1 .5.5v2a.5.5 0 0 1-1 0v-2A.5.5 0 0 1 8 0zm0 13a.5.5 0 0 1 .5.5v2a.5.5 0 0 1-1 0v-2A.5.5 0 0 1 8 13zm8-5a.5.5 0 0 1-.5.5h-2a.5.5 0 0 1 0-1h2a.5.5 0 0 1 .5.5zM3 8a.5.5 0 0 1-.5.5h-2a.5.5 0 0 1 0-1h2A.5.5 0 0 1 3 8zm10.657-5.657a.5.5 0 0 1 0 .707l-1.414 1.415a.5.5 0 1 1-.707-.708l1.414-1.414a.5.5 0 0 1 .707 0zm-9.193 9.193a.5.5 0 0 1 0 .707L3.05 13.657a.5.5 0 0 1-.707-.707l1.414-1.414a.5.5 0 0 1 .707 0zm9.193 2.121a.5.5 0 0 1-.707 0l-1.414-1.414a.5.5 0 0 1 .707-.707l1.414 1.414a.5.5 0 0 1 0 .707zM4.464 4.465a.5.5 0 0 1-.707 0L2.343 3.05a.5.5 0 1 1 .707-.707l1.414 1.414a.5.5 0 0 1 0 .708z"/>
</symbol>
</svg>
<div class="dropdown position-fixed bottom-0 end-0 mb-3 me-3 bd-mode-toggle">
<button class="btn btn-bd-secondary py-2 dropdown-toggle d-flex align-items-center"
id="bd-theme"
type="button"
aria-expanded="false"
data-bs-toggle="dropdown"
aria-label="Toggle theme (auto)">
<svg class="bi my-1 theme-icon-active" width="1em" height="1em"><use href="#circle-half"></use></svg>
<span class="visually-hidden" id="bd-theme-text">Toggle theme</span>
</button>
<ul class="dropdown-menu dropdown-menu-end shadow" aria-labelledby="bd-theme-text">
<li>
<button type="button" class="dropdown-item d-flex align-items-center" data-bs-theme-value="light" aria-pressed="false">
<svg class="bi me-2 opacity-50" width="1em" height="1em"><use href="#sun-fill"></use></svg>
Light
<svg class="bi ms-auto d-none" width="1em" height="1em"><use href="#check2"></use></svg>
</button>
</li>
<li>
<button type="button" class="dropdown-item d-flex align-items-center active" data-bs-theme-value="dark" aria-pressed="false">
<svg class="bi me-2 opacity-50" width="1em" height="1em"><use href="#moon-stars-fill"></use></svg>
Dark
<svg class="bi ms-auto d-none" width="1em" height="1em"><use href="#check2"></use></svg>
</button>
</li>
<li>
<button type="button" class="dropdown-item d-flex align-items-center" data-bs-theme-value="auto" aria-pressed="true">
<svg class="bi me-2 opacity-50" width="1em" height="1em"><use href="#circle-half"></use></svg>
Auto
<svg class="bi ms-auto d-none" width="1em" height="1em"><use href="#check2"></use></svg>
</button>
</li>
</ul>
</div>
<svg xmlns="http://www.w3.org/2000/svg" class="d-none">
<symbol id="arrow-right-circle" viewBox="0 0 16 16">
<path d="M8 0a8 8 0 1 1 0 16A8 8 0 0 1 8 0zM4.5 7.5a.5.5 0 0 0 0 1h5.793l-2.147 2.146a.5.5 0 0 0 .708.708l3-3a.5.5 0 0 0 0-.708l-3-3a.5.5 0 1 0-.708.708L10.293 7.5H4.5z"/>
</symbol>
<symbol id="color-mode" viewBox="0 0 118 94">
<title>Color Modes</title>
<path fill-rule="evenodd" clip-rule="evenodd" d="M24.509 0c-6.733 0-11.715 5.893-11.492 12.284.214 6.14-.064 14.092-2.066 20.577C8.943 39.365 5.547 43.485 0 44.014v5.972c5.547.529 8.943 4.649 10.951 11.153 2.002 6.485 2.28 14.437 2.066 20.577C12.794 88.106 17.776 94 24.51 94H93.5c6.733 0 11.714-5.893 11.491-12.284-.214-6.14.064-14.092 2.066-20.577 2.009-6.504 5.396-10.624 10.943-11.153v-5.972c-5.547-.529-8.934-4.649-10.943-11.153-2.002-6.484-2.28-14.437-2.066-20.577C105.214 5.894 100.233 0 93.5 0H24.508zM80 57.863C80 66.663 73.436 72 62.543 72H44a2 2 0 01-2-2V24a2 2 0 012-2h18.437c9.083 0 15.044 4.92 15.044 12.474 0 5.302-4.01 10.049-9.119 10.88v.277C75.317 46.394 80 51.21 80 57.863zM60.521 28.34H49.948v14.934h8.905c6.884 0 10.68-2.772 10.68-7.727 0-4.643-3.264-7.207-9.012-7.207zM49.948 49.2v16.458H60.91c7.167 0 10.964-2.876 10.964-8.281 0-5.406-3.903-8.178-11.425-8.178H49.948z"></path>
</symbol>
</svg>
<nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top">
<div class="container-fluid">
<a class="navbar-brand" href="../index.html"><img class="d-block" id="icon" alt="ImageMagick" width="32" height="32" src="../../images/wand.ico"/></a>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#magick-navbars" aria-controls="magick-navbars" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse" id="magick-navbars">
<ul class="navbar-nav me-auto mb-2 mb-md-0">
<li class="nav-item">
<a class="nav-link " href="../www/download.html">Download</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../www/command-line-tools.html">Tools</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../www/command-line-processing.html">CLI</a>
</li>
<li class="nav-item">
<a class="nav-link " href="../www/develop.html">Develop</a>
</li>
<li class="nav-item">
<a class="nav-link" target="_blank" href="https://github.com/ImageMagick/ImageMagick/discussions">Community</a>
</li>
<li class="nav-item">
</li>
</ul>
<form class="d-flex form-inline" action="https://imagemagick.org/script/search.php">
<input class="form-control me-2" type="text" name="q" placeholder="Search" aria-label="Search" />
<button class="btn btn-outline-success" type="submit" name="sa">Search</button>
</form>
</div>
</div>
</nav>
<div class="col-lg-8 mx-auto p-4 py-md-5 text-body-secondary">
<header class="d-flex align-items-center pb-3 mb-5 border-bottom">
<a href="../index.html" class="d-flex align-items-center text-decoration-none">
<h1 class="fs-4">MagickWand, C API: Wand View Methods</h1>
</a>
</header>
<main class="container">
<h1 class="text-center">Wand-view</h1>
<div class="btn-group">
<button class="btn btn-secondary dropdown-toggle" type="button" id="defaultDropdown" data-bs-toggle="dropdown" data-bs-auto-close="true" aria-expanded="false">
Select API Method
</button>
<ul class="dropdown-menu pre-scrollable" aria-labelledby="defaultDropdown">
<li><a href="#CloneWandView">CloneWandView</a></li>
<li><a href="#DestroyWandView">DestroyWandView</a></li>
<li><a href="#DuplexTransferWandViewIterator">DuplexTransferWandViewIterator</a></li>
<li><a href="#GetWandViewException">GetWandViewException</a></li>
<li><a href="#GetWandViewExtent">GetWandViewExtent</a></li>
<li><a href="#GetWandViewIterator">GetWandViewIterator</a></li>
<li><a href="#GetWandViewPixels">GetWandViewPixels</a></li>
<li><a href="#GetWandViewWand">GetWandViewWand</a></li>
<li><a href="#IsWandView">IsWandView</a></li>
<li><a href="#NewWandView">NewWandView</a></li>
<li><a href="#NewWandViewExtent">NewWandViewExtent</a></li>
<li><a href="#SetWandViewDescription">SetWandViewDescription</a></li>
<li><a href="#SetWandViewIterator">SetWandViewIterator</a></li>
<li><a href="#TransferWandViewIterator">TransferWandViewIterator</a></li>
</ul>
</div>
<br/>
<br/>
<div class="magick-header">
<h2><a href="../../api/MagickWand/wand-view_8c.html" id="CloneWandView">CloneWandView</a></h2>
<p>CloneWandView() makes a copy of the specified wand view.</p>
<p>The format of the CloneWandView method is:</p>
<pre class="bg-light text-dark mx-4"><samp>WandView *CloneWandView(const WandView *wand_view)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>wand_view</dt>
<dd>the wand view. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickWand/wand-view_8c.html" id="DestroyWandView">DestroyWandView</a></h2>
<p>DestroyWandView() deallocates memory associated with a wand view.</p>
<p>The format of the DestroyWandView method is:</p>
<pre class="bg-light text-dark mx-4"><samp>WandView *DestroyWandView(WandView *wand_view)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>wand_view</dt>
<dd>the wand view. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickWand/wand-view_8c.html" id="DuplexTransferWandViewIterator">DuplexTransferWandViewIterator</a></h2>
<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="bg-light text-dark mx-4"><samp>MagickBooleanType DuplexTransferImageViewMethod(const WandView *source,
const WandView *duplex,WandView *destination,const ssize_t y,
const int thread_id,void *context)
</samp></pre>
<p>Use this pragma if the view is not single threaded:</p>
<pre class="bg-light text-dark mx-4"><samp> #pragma omp critical
</samp></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="bg-light text-dark mx-4"><samp>MagickBooleanType DuplexTransferWandViewIterator(WandView *source,
WandView *duplex,WandView *destination,
DuplexTransferWandViewMethod transfer,void *context)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>source</dt>
<dd>the source wand view. </dd>
<dd> </dd>
<dt>duplex</dt>
<dd>the duplex wand view. </dd>
<dd> </dd>
<dt>destination</dt>
<dd>the destination wand view. </dd>
<dd> </dd>
<dt>transfer</dt>
<dd>the transfer callback method. </dd>
<dd> </dd>
<dt>context</dt>
<dd>the user defined context. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickWand/wand-view_8c.html" id="GetWandViewException">GetWandViewException</a></h2>
<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="bg-light text-dark mx-4"><samp>char *GetWandViewException(const WandView *wand_view,
ExceptionType *severity)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>wand_view</dt>
<dd>the pixel wand_view. </dd>
<dd> </dd>
<dt>severity</dt>
<dd>the severity of the error is returned here. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickWand/wand-view_8c.html" id="GetWandViewExtent">GetWandViewExtent</a></h2>
<p>GetWandViewExtent() returns the wand view extent.</p>
<p>The format of the GetWandViewExtent method is:</p>
<pre class="bg-light text-dark mx-4"><samp>RectangleInfo GetWandViewExtent(const WandView *wand_view)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>wand_view</dt>
<dd>the wand view. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickWand/wand-view_8c.html" id="GetWandViewIterator">GetWandViewIterator</a></h2>
<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="bg-light text-dark mx-4"><samp>MagickBooleanType GetImageViewMethod(const WandView *source,
const ssize_t y,const int thread_id,void *context)
</samp></pre>
<p>Use this pragma if the view is not single threaded:</p>
<pre class="bg-light text-dark mx-4"><samp> #pragma omp critical
</samp></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="bg-light text-dark mx-4"><samp>MagickBooleanType GetWandViewIterator(WandView *source,
GetWandViewMethod get,void *context)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>source</dt>
<dd>the source wand view. </dd>
<dd> </dd>
<dt>get</dt>
<dd>the get callback method. </dd>
<dd> </dd>
<dt>context</dt>
<dd>the user defined context. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickWand/wand-view_8c.html" id="GetWandViewPixels">GetWandViewPixels</a></h2>
<p>GetWandViewPixels() returns the wand view pixel_wands.</p>
<p>The format of the GetWandViewPixels method is:</p>
<pre class="bg-light text-dark mx-4"><samp>PixelWand *GetWandViewPixels(const WandView *wand_view)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>wand_view</dt>
<dd>the wand view. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickWand/wand-view_8c.html" id="GetWandViewWand">GetWandViewWand</a></h2>
<p>GetWandViewWand() returns the magick wand associated with the wand view.</p>
<p>The format of the GetWandViewWand method is:</p>
<pre class="bg-light text-dark mx-4"><samp>MagickWand *GetWandViewWand(const WandView *wand_view)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>wand_view</dt>
<dd>the wand view. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickWand/wand-view_8c.html" id="IsWandView">IsWandView</a></h2>
<p>IsWandView() returns MagickTrue if the parameter is verified as a wand view object.</p>
<p>The format of the IsWandView method is:</p>
<pre class="bg-light text-dark mx-4"><samp>MagickBooleanType IsWandView(const WandView *wand_view)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>wand_view</dt>
<dd>the wand view. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickWand/wand-view_8c.html" id="NewWandView">NewWandView</a></h2>
<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="bg-light text-dark mx-4"><samp>WandView *NewWandView(MagickWand *wand)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>wand</dt>
<dd>the wand. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickWand/wand-view_8c.html" id="NewWandViewExtent">NewWandViewExtent</a></h2>
<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="bg-light text-dark mx-4"><samp>WandView *NewWandViewExtent(MagickWand *wand,const ssize_t x,
const ssize_t y,const size_t width,const size_t height)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>wand</dt>
<dd>the magick wand. </dd>
<dd> </dd>
<dt>x,y,columns,rows</dt>
<dd> These values define the perimeter of a extent of pixel_wands view. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickWand/wand-view_8c.html" id="SetWandViewDescription">SetWandViewDescription</a></h2>
<p>SetWandViewDescription() associates a description with an image view.</p>
<p>The format of the SetWandViewDescription method is:</p>
<pre class="bg-light text-dark mx-4"><samp>void SetWandViewDescription(WandView *image_view,const char *description)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>wand_view</dt>
<dd>the wand view. </dd>
<dd> </dd>
<dt>description</dt>
<dd>the wand view description. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickWand/wand-view_8c.html" id="SetWandViewIterator">SetWandViewIterator</a></h2>
<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 initially 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="bg-light text-dark mx-4"><samp>MagickBooleanType SetImageViewMethod(ImageView *destination,
const ssize_t y,const int thread_id,void *context)
</samp></pre>
<p>Use this pragma if the view is not single threaded:</p>
<pre class="bg-light text-dark mx-4"><samp> #pragma omp critical
</samp></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="bg-light text-dark mx-4"><samp>MagickBooleanType SetWandViewIterator(WandView *destination,
SetWandViewMethod set,void *context)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>destination</dt>
<dd>the wand view. </dd>
<dd> </dd>
<dt>set</dt>
<dd>the set callback method. </dd>
<dd> </dd>
<dt>context</dt>
<dd>the user defined context. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickWand/wand-view_8c.html" id="TransferWandViewIterator">TransferWandViewIterator</a></h2>
<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="bg-light text-dark mx-4"><samp>MagickBooleanType TransferImageViewMethod(const WandView *source,
WandView *destination,const ssize_t y,const int thread_id,
void *context)
</samp></pre>
<p>Use this pragma if the view is not single threaded:</p>
<pre class="bg-light text-dark mx-4"><samp> #pragma omp critical
</samp></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="bg-light text-dark mx-4"><samp>MagickBooleanType TransferWandViewIterator(WandView *source,
WandView *destination,TransferWandViewMethod transfer,void *context)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>source</dt>
<dd>the source wand view. </dd>
<dd> </dd>
<dt>destination</dt>
<dd>the destination wand view. </dd>
<dd> </dd>
<dt>transfer</dt>
<dd>the transfer callback method. </dd>
<dd> </dd>
<dt>context</dt>
<dd>the user defined context. </dd>
<dd> </dd>
</dl>
<h2><a href="../../api/MagickWand/wand-view_8c.html" id="UpdateWandViewIterator">UpdateWandViewIterator</a></h2>
<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="bg-light text-dark mx-4"><samp>MagickBooleanType UpdateImageViewMethod(WandView *source,const ssize_t y,
const int thread_id,void *context)
</samp></pre>
<p>Use this pragma if the view is not single threaded:</p>
<pre class="bg-light text-dark mx-4"><samp> #pragma omp critical
</samp></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="bg-light text-dark mx-4"><samp>MagickBooleanType UpdateWandViewIterator(WandView *source,
UpdateWandViewMethod update,void *context)
</samp></pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>source</dt>
<dd>the source wand view. </dd>
<dd> </dd>
<dt>update</dt>
<dd>the update callback method. </dd>
<dd> </dd>
<dt>context</dt>
<dd>the user defined context. </dd>
<dd> </dd>
</dl>
</div>
</main><!-- /.container -->
<footer class="py-5 text-center text-body-secondary bg-body-tertiary">
<div class="container-fluid">
<a href="../www/security-policy.html">Security</a> •
<a href="../www/news.html">News</a>
<a href="#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../../images/wand.ico"/></a>
<a href="../www/links.html">Related</a> •
<a href="../www/sitemap.html">Sitemap</a>
<br/>
<a href="../www/support.html">Sponsor</a> •
<a href="../www/cite.html">Cite</a> •
<a href="http://pgp.mit.edu/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> •
<a href="../www/contact.html">Contact Us</a>
<br/>
<a href="https://github.com/imagemagick/imagemagick" target="_blank" rel="noopener" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 512 499.36" width="2%" height="2%" role="img" focusable="false"><title>GitHub</title><path fill="currentColor" fill-rule="evenodd" d="M256 0C114.64 0 0 114.61 0 256c0 113.09 73.34 209 175.08 242.9 12.8 2.35 17.47-5.56 17.47-12.34 0-6.08-.22-22.18-.35-43.54-71.2 15.49-86.2-34.34-86.2-34.34-11.64-29.57-28.42-37.45-28.42-37.45-23.27-15.84 1.73-15.55 1.73-15.55 25.69 1.81 39.21 26.38 39.21 26.38 22.84 39.12 59.92 27.82 74.5 21.27 2.33-16.54 8.94-27.82 16.25-34.22-56.84-6.43-116.6-28.43-116.6-126.49 0-27.95 10-50.8 26.35-68.69-2.63-6.48-11.42-32.5 2.51-67.75 0 0 21.49-6.88 70.4 26.24a242.65 242.65 0 0 1 128.18 0c48.87-33.13 70.33-26.24 70.33-26.24 14 35.25 5.18 61.27 2.55 67.75 16.41 17.9 26.31 40.75 26.31 68.69 0 98.35-59.85 120-116.88 126.32 9.19 7.9 17.38 23.53 17.38 47.41 0 34.22-.31 61.83-.31 70.23 0 6.85 4.61 14.81 17.6 12.31C438.72 464.97 512 369.08 512 256.02 512 114.62 397.37 0 256 0z"/></svg></a> •
<a href="https://twitter.com/imagemagick" target="_blank" rel="noopener" aria-label="Twitter"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 300 300" width="2%" height="2%" role="img" focusable="false"><title>Twitter</title><path d="M178.57 127.15 290.27 0h-26.46l-97.03 110.38L89.34 0H0l117.13 166.93L0 300.25h26.46l102.4-116.59 81.8 116.59h89.34M36.01 19.54H76.66l187.13 262.13h-40.66"/></svg></a>
<br/>
<small>Copyright © 1999 ImageMagick Studio LLC</small>
</div>
</footer>
</div>
<!-- Javascript assets -->
<script src="../assets/magick.js" ></script>
</body>
</html>
|