granicus.if.org Git - imagemagick/blob - www/api/magick-wand.html

   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: Wand Methods @ ImageMagick</title>
  11   <meta name="application-name" content="ImageMagick" />
  12   <meta name="description" content="ImageMagick® creates, edits, composes, and converts 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:, wmethods, 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-2019 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="magick-wand.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   <header>
  39   <nav class="navbar navbar-expand-md navbar-dark fixed-top bg-dark">
  40     <a class="navbar-brand" href="../index.html"><img class="d-block" id="icon" alt="ImageMagick" width="32" height="32" src="../images/wand.ico"/></a>
  41     <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarsMagick" aria-controls="navbarsMagick" aria-expanded="false" aria-label="Toggle navigation">
  42       <span class="navbar-toggler-icon"></span>
  43     </button>
  44
  45     <div class="navbar-collapse collapse" id="navbarsMagick" style="">
  46     <ul class="navbar-nav mr-auto">
  47       <li class="nav-item ">
  48         <a class="nav-link" href="montage.html">Home <span class="sr-only">(current)</span></a>
  49       </li>
  50       <li class="nav-item ">
  51         <a class="nav-link" href="../www/download.html">Download</a>
  52       </li>
  53       <li class="nav-item ">
  54         <a class="nav-link" href="../www/command-line-tools.html">Tools</a>
  55       </li>
  56       <li class="nav-item ">
  57         <a class="nav-link" href="../www/command-line-processing.html">Command-line</a>
  58       </li>
  59       <li class="nav-item ">
  60         <a class="nav-link" href="../www/resources.html">Resources</a>
  61       </li>
  62       <li class="nav-item ">
  63         <a class="nav-link" href="../www/develop.html">Develop</a>
  64       </li>
  65       <li class="nav-item">
  66         <a class="nav-link" target="_blank" href="../https://imagemagick.org/discourse-server//">Community</a>
  67       </li>
  68     </ul>
  69     <form class="form-inline my-2 my-lg-0" action="../https://imagemagick.org/script/search.php">
  70       <input class="form-control mr-sm-2" type="text" name="q" placeholder="Search" aria-label="Search">
  71       <button class="btn btn-outline-success my-2 my-sm-0" type="submit" name="sa">Search</button>
  72     </form>
  73     </div>
  74   </nav>
  75   <div class="container">
  76    <script async="async" src="https://localhost/pagead/js/adsbygoogle.js"></script>    <ins class="adsbygoogle"
  77          style="display:block"
  78          data-ad-client="ca-pub-3129977114552745"
  79          data-ad-slot="6345125851"
  80          data-ad-format="auto"></ins>
  81     <script>
  82       (adsbygoogle = window.adsbygoogle || []).push({});
  83     </script>
  84
  85   </div>
  86   </header>
  87   <main class="container">
  88     <div class="magick-template">
  89 <div class="magick-header">
  90 <p class="text-center"><a href="magick-wand.html#ClearMagickWand">ClearMagickWand</a> &#8226; <a href="magick-wand.html#CloneMagickWand">CloneMagickWand</a> &#8226; <a href="magick-wand.html#DestroyMagickWand">DestroyMagickWand</a> &#8226; <a href="magick-wand.html#IsMagickWand">IsMagickWand</a> &#8226; <a href="magick-wand.html#MagickClearException">MagickClearException</a> &#8226; <a href="magick-wand.html#MagickGetException">MagickGetException</a> &#8226; <a href="magick-wand.html#MagickGetExceptionType">MagickGetExceptionType</a> &#8226; <a href="magick-wand.html#MagickGetIteratorIndex">MagickGetIteratorIndex</a> &#8226; <a href="magick-wand.html#MagickQueryConfigureOption">MagickQueryConfigureOption</a> &#8226; <a href="magick-wand.html#MagickQueryConfigureOptions">MagickQueryConfigureOptions</a> &#8226; <a href="magick-wand.html#MagickQueryFontMetrics">MagickQueryFontMetrics</a> &#8226; <a href="magick-wand.html#MagickQueryMultilineFontMetrics">MagickQueryMultilineFontMetrics</a> &#8226; <a href="magick-wand.html#MagickQueryFonts">MagickQueryFonts</a> &#8226; <a href="magick-wand.html#MagickQueryFormats">MagickQueryFormats</a> &#8226; <a href="magick-wand.html#MagickRelinquishMemory">MagickRelinquishMemory</a> &#8226; <a href="magick-wand.html#MagickResetIterator">MagickResetIterator</a> &#8226; <a href="magick-wand.html#MagickSetFirstIterator">MagickSetFirstIterator</a> &#8226; <a href="magick-wand.html#MagickSetIteratorIndex">MagickSetIteratorIndex</a> &#8226; <a href="magick-wand.html#MagickSetLastIterator">MagickSetLastIterator</a> &#8226; <a href="magick-wand.html#MagickWandGenesis">MagickWandGenesis</a> &#8226; <a href="magick-wand.html#MagickWandTerminus">MagickWandTerminus</a> &#8226; <a href="magick-wand.html#NewMagickWand">NewMagickWand</a> &#8226; <a href="magick-wand.html#NewMagickWandFromImage">NewMagickWandFromImage</a> &#8226; <a href="magick-wand.html#IsMagickWandInstantiated">IsMagickWandInstantiated</a></p>
  91
  92 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="ClearMagickWand">ClearMagickWand</a></h2>
  93
  94 <p>ClearMagickWand() clears resources associated with the wand, leaving the wand blank, and ready to be used for a new set of images.</p>
  95
  96 <p>The format of the ClearMagickWand method is:</p>
  97
  98 <pre class="text">
  99 void ClearMagickWand(MagickWand *wand)
 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>wand</dt>
 110 <dd>the magick wand. </dd>
 111
 112 <dd>  </dd>
 113 </dl>
 114 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="CloneMagickWand">CloneMagickWand</a></h2>
 115
 116 <p>CloneMagickWand() makes an exact copy of the specified wand.</p>
 117
 118 <p>The format of the CloneMagickWand method is:</p>
 119
 120 <pre class="text">
 121 MagickWand *CloneMagickWand(const MagickWand *wand)
 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>wand</dt>
 132 <dd>the magick wand. </dd>
 133
 134 <dd>  </dd>
 135 </dl>
 136 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="DestroyMagickWand">DestroyMagickWand</a></h2>
 137
 138 <p>DestroyMagickWand() deallocates memory associated with an MagickWand.</p>
 139
 140 <p>The format of the DestroyMagickWand method is:</p>
 141
 142 <pre class="text">
 143 MagickWand *DestroyMagickWand(MagickWand *wand)
 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>wand</dt>
 154 <dd>the magick wand. </dd>
 155
 156 <dd>  </dd>
 157 </dl>
 158 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="IsMagickWand">IsMagickWand</a></h2>
 159
 160 <p>IsMagickWand() returns MagickTrue if the wand is verified as a magick wand.</p>
 161
 162 <p>The format of the IsMagickWand method is:</p>
 163
 164 <pre class="text">
 165 MagickBooleanType IsMagickWand(const MagickWand *wand)
 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>wand</dt>
 176 <dd>the magick wand. </dd>
 177
 178 <dd>  </dd>
 179 </dl>
 180 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickClearException">MagickClearException</a></h2>
 181
 182 <p>MagickClearException() clears any exceptions associated with the wand.</p>
 183
 184 <p>The format of the MagickClearException method is:</p>
 185
 186 <pre class="text">
 187 MagickBooleanType MagickClearException(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/magick-wand_8c.html" id="MagickGetException">MagickGetException</a></h2>
 203
 204 <p>MagickGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p>
 205
 206 <p>The format of the MagickGetException method is:</p>
 207
 208 <pre class="text">
 209 char *MagickGetException(const MagickWand *wand,ExceptionType *severity)
 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>wand</dt>
 220 <dd>the magick wand. </dd>
 221
 222 <dd> </dd>
 223 <dt>severity</dt>
 224 <dd>the severity of the error is returned here. </dd>
 225
 226 <dd>  </dd>
 227 </dl>
 228 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickGetExceptionType">MagickGetExceptionType</a></h2>
 229
 230 <p>MagickGetExceptionType() returns the exception type associated with the wand.  If no exception has occurred, UndefinedExceptionType is returned.</p>
 231
 232 <p>The format of the MagickGetExceptionType method is:</p>
 233
 234 <pre class="text">
 235 ExceptionType MagickGetExceptionType(const MagickWand *wand)
 236 </pre>
 237
 238 <p>A description of each parameter follows:</p>
 239
 240 <dd>
 241 </dd>
 242
 243 <dd> </dd>
 244 <dl class="dl-horizontal">
 245 <dt>wand</dt>
 246 <dd>the magick wand. </dd>
 247
 248 <dd>  </dd>
 249 </dl>
 250 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickGetIteratorIndex">MagickGetIteratorIndex</a></h2>
 251
 252 <p>MagickGetIteratorIndex() returns the position of the iterator in the image list.</p>
 253
 254 <p>The format of the MagickGetIteratorIndex method is:</p>
 255
 256 <pre class="text">
 257 ssize_t MagickGetIteratorIndex(MagickWand *wand)
 258 </pre>
 259
 260 <p>A description of each parameter follows:</p>
 261
 262 <dd>
 263 </dd>
 264
 265 <dd> </dd>
 266 <dl class="dl-horizontal">
 267 <dt>wand</dt>
 268 <dd>the magick wand. </dd>
 269
 270 <dd>  </dd>
 271 </dl>
 272 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickQueryConfigureOption">MagickQueryConfigureOption</a></h2>
 273
 274 <p>MagickQueryConfigureOption() returns the value associated with the specified configure option.</p>
 275
 276 <p>The format of the MagickQueryConfigureOption function is:</p>
 277
 278 <pre class="text">
 279 char *MagickQueryConfigureOption(const char *option)
 280 </pre>
 281
 282 <p>A description of each parameter follows:</p>
 283
 284 <dd>
 285 </dd>
 286
 287 <dd> </dd>
 288 <dl class="dl-horizontal">
 289 <dt>option</dt>
 290 <dd>the option name. </dd>
 291
 292 <dd>  </dd>
 293 </dl>
 294 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickQueryConfigureOptions">MagickQueryConfigureOptions</a></h2>
 295
 296 <p>MagickQueryConfigureOptions() returns any configure options that match the specified pattern (e.g.  "*" for all).  Options include NAME, VERSION, LIB_VERSION, etc.</p>
 297
 298 <p>The format of the MagickQueryConfigureOptions function is:</p>
 299
 300 <pre class="text">
 301 char **MagickQueryConfigureOptions(const char *pattern,
 302   size_t *number_options)
 303 </pre>
 304
 305 <p>A description of each parameter follows:</p>
 306
 307 <dd>
 308 </dd>
 309
 310 <dd> </dd>
 311 <dl class="dl-horizontal">
 312 <dt>pattern</dt>
 313 <dd>Specifies a pointer to a text string containing a pattern. </dd>
 314
 315 <dd> </dd>
 316 <dt>number_options</dt>
 317 <dd> Returns the number of configure options in the list. </dd>
 318
 319 <dd> </dd>
 320
 321 <dd>  </dd>
 322 </dl>
 323 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickQueryFontMetrics">MagickQueryFontMetrics</a></h2>
 324
 325 <p>MagickQueryFontMetrics() returns a 13 element array representing the following font metrics:</p>
 326
 327 <pre class="text">
 328     Element Description
 329     -------------------------------------------------
 330     0 character width
 331     1 character height
 332     2 ascender
 333     3 descender
 334     4 text width
 335     5 text height
 336     6 maximum horizontal advance
 337     7 bounding box: x1
 338     8 bounding box: y1
 339     9 bounding box: x2
 340    10 bounding box: y2
 341    11 origin: x
 342    12 origin: y
 343 </pre>
 344
 345 <p>The format of the MagickQueryFontMetrics method is:</p>
 346
 347 <pre class="text">
 348 double *MagickQueryFontMetrics(MagickWand *wand,
 349   const DrawingWand *drawing_wand,const char *text)
 350 </pre>
 351
 352 <p>A description of each parameter follows:</p>
 353
 354 <dd>
 355 </dd>
 356
 357 <dd> </dd>
 358 <dl class="dl-horizontal">
 359 <dt>wand</dt>
 360 <dd>the Magick wand. </dd>
 361
 362 <dd> </dd>
 363 <dt>drawing_wand</dt>
 364 <dd>the drawing wand. </dd>
 365
 366 <dd> </dd>
 367 <dt>text</dt>
 368 <dd>the text. </dd>
 369
 370 <dd>  </dd>
 371 </dl>
 372 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickQueryMultilineFontMetrics">MagickQueryMultilineFontMetrics</a></h2>
 373
 374 <p>MagickQueryMultilineFontMetrics() returns a 13 element array representing the following font metrics:</p>
 375
 376 <pre class="text">
 377     Element Description
 378     -------------------------------------------------
 379     0 character width
 380     1 character height
 381     2 ascender
 382     3 descender
 383     4 text width
 384     5 text height
 385     6 maximum horizontal advance
 386     7 bounding box: x1
 387     8 bounding box: y1
 388     9 bounding box: x2
 389    10 bounding box: y2
 390    11 origin: x
 391    12 origin: y
 392 </pre>
 393
 394 <p>This method is like MagickQueryFontMetrics() but it returns the maximum text width and height for multiple lines of text.</p>
 395
 396 <p>The format of the MagickQueryFontMetrics method is:</p>
 397
 398 <pre class="text">
 399 double *MagickQueryMultilineFontMetrics(MagickWand *wand,
 400   const DrawingWand *drawing_wand,const char *text)
 401 </pre>
 402
 403 <p>A description of each parameter follows:</p>
 404
 405 <dd>
 406 </dd>
 407
 408 <dd> </dd>
 409 <dl class="dl-horizontal">
 410 <dt>wand</dt>
 411 <dd>the Magick wand. </dd>
 412
 413 <dd> </dd>
 414 <dt>drawing_wand</dt>
 415 <dd>the drawing wand. </dd>
 416
 417 <dd> </dd>
 418 <dt>text</dt>
 419 <dd>the text. </dd>
 420
 421 <dd>  </dd>
 422 </dl>
 423 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickQueryFonts">MagickQueryFonts</a></h2>
 424
 425 <p>MagickQueryFonts() returns any font that match the specified pattern (e.g. "*" for all).</p>
 426
 427 <p>The format of the MagickQueryFonts function is:</p>
 428
 429 <pre class="text">
 430 char **MagickQueryFonts(const char *pattern,size_t *number_fonts)
 431 </pre>
 432
 433 <p>A description of each parameter follows:</p>
 434
 435 <dd>
 436 </dd>
 437
 438 <dd> </dd>
 439 <dl class="dl-horizontal">
 440 <dt>pattern</dt>
 441 <dd>Specifies a pointer to a text string containing a pattern. </dd>
 442
 443 <dd> </dd>
 444 <dt>number_fonts</dt>
 445 <dd> Returns the number of fonts in the list. </dd>
 446
 447 <dd> </dd>
 448
 449 <dd>  </dd>
 450 </dl>
 451 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickQueryFormats">MagickQueryFormats</a></h2>
 452
 453 <p>MagickQueryFormats() returns any image formats that match the specified pattern (e.g.  "*" for all).</p>
 454
 455 <p>The format of the MagickQueryFormats function is:</p>
 456
 457 <pre class="text">
 458 char **MagickQueryFormats(const char *pattern,size_t *number_formats)
 459 </pre>
 460
 461 <p>A description of each parameter follows:</p>
 462
 463 <dd>
 464 </dd>
 465
 466 <dd> </dd>
 467 <dl class="dl-horizontal">
 468 <dt>pattern</dt>
 469 <dd>Specifies a pointer to a text string containing a pattern. </dd>
 470
 471 <dd> </dd>
 472 <dt>number_formats</dt>
 473 <dd> This integer returns the number of image formats in the list. </dd>
 474
 475 <dd>  </dd>
 476 </dl>
 477 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickRelinquishMemory">MagickRelinquishMemory</a></h2>
 478
 479 <p>MagickRelinquishMemory() relinquishes memory resources returned by such methods as MagickIdentifyImage(), MagickGetException(), etc.</p>
 480
 481 <p>The format of the MagickRelinquishMemory method is:</p>
 482
 483 <pre class="text">
 484 void *MagickRelinquishMemory(void *resource)
 485 </pre>
 486
 487 <p>A description of each parameter follows:</p>
 488
 489 <dd>
 490 </dd>
 491
 492 <dd> </dd>
 493 <dl class="dl-horizontal">
 494 <dt>resource</dt>
 495 <dd>Relinquish the memory associated with this resource. </dd>
 496
 497 <dd>  </dd>
 498 </dl>
 499 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickResetIterator">MagickResetIterator</a></h2>
 500
 501 <p>MagickResetIterator() resets the wand iterator.</p>
 502
 503 <p>It is typically used either before iterating though images, or before calling specific functions such as  MagickAppendImages() to append all images together.</p>
 504
 505 <p>Afterward you can use MagickNextImage() to iterate over all the images in a wand container, starting with the first image.</p>
 506
 507 <p>Using this before MagickAddImages() or MagickReadImages() will cause new images to be inserted between the first and second image.</p>
 508
 509 <p>The format of the MagickResetIterator method is:</p>
 510
 511 <pre class="text">
 512 void MagickResetIterator(MagickWand *wand)
 513 </pre>
 514
 515 <p>A description of each parameter follows:</p>
 516
 517 <dd>
 518 </dd>
 519
 520 <dd> </dd>
 521 <dl class="dl-horizontal">
 522 <dt>wand</dt>
 523 <dd>the magick wand. </dd>
 524
 525 <dd>  </dd>
 526 </dl>
 527 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickSetFirstIterator">MagickSetFirstIterator</a></h2>
 528
 529 <p>MagickSetFirstIterator() sets the wand iterator to the first image.</p>
 530
 531 <p>After using any images added to the wand using MagickAddImage() or MagickReadImage() will be prepended before any image in the wand.</p>
 532
 533 <p>Also the current image has been set to the first image (if any) in the Magick Wand.  Using MagickNextImage() will then set teh current image to the second image in the list (if present).</p>
 534
 535 <p>This operation is similar to MagickResetIterator() but differs in how MagickAddImage(), MagickReadImage(), and MagickNextImage() behaves afterward.</p>
 536
 537 <p>The format of the MagickSetFirstIterator method is:</p>
 538
 539 <pre class="text">
 540 void MagickSetFirstIterator(MagickWand *wand)
 541 </pre>
 542
 543 <p>A description of each parameter follows:</p>
 544
 545 <dd>
 546 </dd>
 547
 548 <dd> </dd>
 549 <dl class="dl-horizontal">
 550 <dt>wand</dt>
 551 <dd>the magick wand. </dd>
 552
 553 <dd>  </dd>
 554 </dl>
 555 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickSetIteratorIndex">MagickSetIteratorIndex</a></h2>
 556
 557 <p>MagickSetIteratorIndex() set the iterator to the given position in the image list specified with the index parameter.  A zero index will set the first image as current, and so on.  Negative indexes can be used to specify an image relative to the end of the images in the wand, with -1 being the last image in the wand.</p>
 558
 559 <p>If the index is invalid (range too large for number of images in wand) the function will return MagickFalse, but no 'exception' will be raised, as it is not actually an error.  In that case the current image will not change.</p>
 560
 561 <p>After using any images added to the wand using MagickAddImage() or MagickReadImage() will be added after the image indexed, regardless of if a zero (first image in list) or negative index (from end) is used.</p>
 562
 563 <p>Jumping to index 0 is similar to MagickResetIterator() but differs in how MagickNextImage() behaves afterward.</p>
 564
 565 <p>The format of the MagickSetIteratorIndex method is:</p>
 566
 567 <pre class="text">
 568 MagickBooleanType MagickSetIteratorIndex(MagickWand *wand,
 569   const ssize_t index)
 570 </pre>
 571
 572 <p>A description of each parameter follows:</p>
 573
 574 <dd>
 575 </dd>
 576
 577 <dd> </dd>
 578 <dl class="dl-horizontal">
 579 <dt>wand</dt>
 580 <dd>the magick wand. </dd>
 581
 582 <dd> </dd>
 583 <dt>index</dt>
 584 <dd>the scene number. </dd>
 585
 586 <dd>  </dd>
 587 </dl>
 588 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickSetLastIterator">MagickSetLastIterator</a></h2>
 589
 590 <p>MagickSetLastIterator() sets the wand iterator to the last image.</p>
 591
 592 <p>The last image is actually the current image, and the next use of MagickPreviousImage() will not change this allowing this function to be used to iterate over the images in the reverse direction. In this sense it is more like  MagickResetIterator() than MagickSetFirstIterator().</p>
 593
 594 <p>Typically this function is used before MagickAddImage(), MagickReadImage() functions to ensure new images are appended to the very end of wand's image list.</p>
 595
 596 <p>The format of the MagickSetLastIterator method is:</p>
 597
 598 <pre class="text">
 599 void MagickSetLastIterator(MagickWand *wand)
 600 </pre>
 601
 602 <p>A description of each parameter follows:</p>
 603
 604 <dd>
 605 </dd>
 606
 607 <dd> </dd>
 608 <dl class="dl-horizontal">
 609 <dt>wand</dt>
 610 <dd>the magick wand. </dd>
 611
 612 <dd>  </dd>
 613 </dl>
 614 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickWandGenesis">MagickWandGenesis</a></h2>
 615
 616 <p>MagickWandGenesis() initializes the MagickWand environment.</p>
 617
 618 <p>The format of the MagickWandGenesis method is:</p>
 619
 620 <pre class="text">
 621 void MagickWandGenesis(void)
 622 </pre>
 623
 624 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickWandTerminus">MagickWandTerminus</a></h2>
 625
 626 <p>MagickWandTerminus() terminates the MagickWand environment.</p>
 627
 628 <p>The format of the MaickWandTerminus method is:</p>
 629
 630 <pre class="text">
 631 void MagickWandTerminus(void)
 632 </pre>
 633
 634 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="NewMagickWand">NewMagickWand</a></h2>
 635
 636 <p>NewMagickWand() returns a wand required for all other methods in the API. A fatal exception is thrown if there is not enough memory to allocate the wand.   Use DestroyMagickWand() to dispose of the wand when it is no longer needed.</p>
 637
 638 <p>The format of the NewMagickWand method is:</p>
 639
 640 <pre class="text">
 641 MagickWand *NewMagickWand(void)
 642 </pre>
 643
 644 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="NewMagickWandFromImage">NewMagickWandFromImage</a></h2>
 645
 646 <p>NewMagickWandFromImage() returns a wand with an image.</p>
 647
 648 <p>The format of the NewMagickWandFromImage method is:</p>
 649
 650 <pre class="text">
 651 MagickWand *NewMagickWandFromImage(const Image *image)
 652 </pre>
 653
 654 <p>A description of each parameter follows:</p>
 655
 656 <dd>
 657 </dd>
 658
 659 <dd> </dd>
 660 <dl class="dl-horizontal">
 661 <dt>image</dt>
 662 <dd>the image. </dd>
 663
 664 <dd>  </dd>
 665 </dl>
 666 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="IsMagickWandInstantiated">IsMagickWandInstantiated</a></h2>
 667
 668 <p>IsMagickWandInstantiated() returns MagickTrue if the ImageMagick environment is currently instantiated--  that is, MagickWandGenesis() has been called but MagickWandTerminus() has not.</p>
 669
 670 <p>The format of the IsMagickWandInstantiated method is:</p>
 671
 672 <pre class="text">
 673 MagickBooleanType IsMagickWandInstantiated(void)
 674 </pre>
 675
 676 </div>
 677     </div>
 678   </main><!-- /.container -->
 679   <footer class="magick-footer">
 680     <p><a href="../www/security-policy.html">Security</a> •
 681     <a href="../www/architecture.html">Architecture</a>
 682
 683     <a href="magick-wand.html#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../images/wand.ico"/></a>
 684
 685     <a href="../www/links.html">Related</a> •
 686      <a href="../www/sitemap.html">Sitemap</a>
 687     <br/>
 688     <a href="../www/support.html">Donate</a> •
 689     <a href="http://pgp.mit.edu/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
 690     <a href="../www/contact.html">Contact Us</a>
 691     <br/>
 692     <small>© 1999-2019 ImageMagick Studio LLC</small></p>
 693   </footer>
 694
 695   <!-- Javascript assets -->
 696   <script src="assets/magick.js" crossorigin="anonymous"></script>
 697   <script>window.jQuery || document.write('<script src="https://localhost/ajax/libs/jquery/3.3.1/jquery.min.js"><\/script>')</script>
 698 </body>
 699 </html>
 700 <!-- Magick Cache 24th April 2019 13:08 -->