Home | History | Annotate | Download | only in api
      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="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:, 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-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="magick-wand.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="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>
     85 
     86 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="ClearMagickWand">ClearMagickWand</a></h2>
     87 
     88 <p>ClearMagickWand() clears resources associated with the wand, leaving the wand blank, and ready to be used for a new set of images.</p>
     89 
     90 <p>The format of the ClearMagickWand method is:</p>
     91 
     92 <pre class="text">
     93 void ClearMagickWand(MagickWand *wand)
     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>wand</dt>
    104 <dd>the magick wand. </dd>
    105 
    106 <dd>  </dd>
    107 </dl>
    108 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="CloneMagickWand">CloneMagickWand</a></h2>
    109 
    110 <p>CloneMagickWand() makes an exact copy of the specified wand.</p>
    111 
    112 <p>The format of the CloneMagickWand method is:</p>
    113 
    114 <pre class="text">
    115 MagickWand *CloneMagickWand(const MagickWand *wand)
    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>wand</dt>
    126 <dd>the magick wand. </dd>
    127 
    128 <dd>  </dd>
    129 </dl>
    130 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="DestroyMagickWand">DestroyMagickWand</a></h2>
    131 
    132 <p>DestroyMagickWand() deallocates memory associated with an MagickWand.</p>
    133 
    134 <p>The format of the DestroyMagickWand method is:</p>
    135 
    136 <pre class="text">
    137 MagickWand *DestroyMagickWand(MagickWand *wand)
    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>wand</dt>
    148 <dd>the magick wand. </dd>
    149 
    150 <dd>  </dd>
    151 </dl>
    152 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="IsMagickWand">IsMagickWand</a></h2>
    153 
    154 <p>IsMagickWand() returns MagickTrue if the wand is verified as a magick wand.</p>
    155 
    156 <p>The format of the IsMagickWand method is:</p>
    157 
    158 <pre class="text">
    159 MagickBooleanType IsMagickWand(const MagickWand *wand)
    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>wand</dt>
    170 <dd>the magick wand. </dd>
    171 
    172 <dd>  </dd>
    173 </dl>
    174 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickClearException">MagickClearException</a></h2>
    175 
    176 <p>MagickClearException() clears any exceptions associated with the wand.</p>
    177 
    178 <p>The format of the MagickClearException method is:</p>
    179 
    180 <pre class="text">
    181 MagickBooleanType MagickClearException(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/magick-wand_8c.html" id="MagickGetException">MagickGetException</a></h2>
    197 
    198 <p>MagickGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p>
    199 
    200 <p>The format of the MagickGetException method is:</p>
    201 
    202 <pre class="text">
    203 char *MagickGetException(const MagickWand *wand,ExceptionType *severity)
    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>wand</dt>
    214 <dd>the magick wand. </dd>
    215 
    216 <dd> </dd>
    217 <dt>severity</dt>
    218 <dd>the severity of the error is returned here. </dd>
    219 
    220 <dd>  </dd>
    221 </dl>
    222 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickGetExceptionType">MagickGetExceptionType</a></h2>
    223 
    224 <p>MagickGetExceptionType() returns the exception type associated with the wand.  If no exception has occurred, UndefinedExceptionType is returned.</p>
    225 
    226 <p>The format of the MagickGetExceptionType method is:</p>
    227 
    228 <pre class="text">
    229 ExceptionType MagickGetExceptionType(const MagickWand *wand)
    230 </pre>
    231 
    232 <p>A description of each parameter follows:</p>
    233 
    234 <dd>
    235 </dd>
    236 
    237 <dd> </dd>
    238 <dl class="dl-horizontal">
    239 <dt>wand</dt>
    240 <dd>the magick wand. </dd>
    241 
    242 <dd>  </dd>
    243 </dl>
    244 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickGetIteratorIndex">MagickGetIteratorIndex</a></h2>
    245 
    246 <p>MagickGetIteratorIndex() returns the position of the iterator in the image list.</p>
    247 
    248 <p>The format of the MagickGetIteratorIndex method is:</p>
    249 
    250 <pre class="text">
    251 ssize_t MagickGetIteratorIndex(MagickWand *wand)
    252 </pre>
    253 
    254 <p>A description of each parameter follows:</p>
    255 
    256 <dd>
    257 </dd>
    258 
    259 <dd> </dd>
    260 <dl class="dl-horizontal">
    261 <dt>wand</dt>
    262 <dd>the magick wand. </dd>
    263 
    264 <dd>  </dd>
    265 </dl>
    266 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickQueryConfigureOption">MagickQueryConfigureOption</a></h2>
    267 
    268 <p>MagickQueryConfigureOption() returns the value associated with the specified configure option.</p>
    269 
    270 <p>The format of the MagickQueryConfigureOption function is:</p>
    271 
    272 <pre class="text">
    273 char *MagickQueryConfigureOption(const char *option)
    274 </pre>
    275 
    276 <p>A description of each parameter follows:</p>
    277 
    278 <dd>
    279 </dd>
    280 
    281 <dd> </dd>
    282 <dl class="dl-horizontal">
    283 <dt>option</dt>
    284 <dd>the option name. </dd>
    285 
    286 <dd>  </dd>
    287 </dl>
    288 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickQueryConfigureOptions">MagickQueryConfigureOptions</a></h2>
    289 
    290 <p>MagickQueryConfigureOptions() returns any configure options that match the specified pattern (e.g.  "*" for all).  Options include NAME, VERSION, LIB_VERSION, etc.</p>
    291 
    292 <p>The format of the MagickQueryConfigureOptions function is:</p>
    293 
    294 <pre class="text">
    295 char **MagickQueryConfigureOptions(const char *pattern,
    296   size_t *number_options)
    297 </pre>
    298 
    299 <p>A description of each parameter follows:</p>
    300 
    301 <dd>
    302 </dd>
    303 
    304 <dd> </dd>
    305 <dl class="dl-horizontal">
    306 <dt>pattern</dt>
    307 <dd>Specifies a pointer to a text string containing a pattern. </dd>
    308 
    309 <dd> </dd>
    310 <dt>number_options</dt>
    311 <dd> Returns the number of configure options in the list. </dd>
    312 
    313 <dd> </dd>
    314 
    315 <dd>  </dd>
    316 </dl>
    317 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickQueryFontMetrics">MagickQueryFontMetrics</a></h2>
    318 
    319 <p>MagickQueryFontMetrics() returns a 13 element array representing the following font metrics:</p>
    320 
    321 <pre class="text">
    322     Element Description
    323     -------------------------------------------------
    324     0 character width
    325     1 character height
    326     2 ascender
    327     3 descender
    328     4 text width
    329     5 text height
    330     6 maximum horizontal advance
    331     7 bounding box: x1
    332     8 bounding box: y1
    333     9 bounding box: x2
    334    10 bounding box: y2
    335    11 origin: x
    336    12 origin: y
    337 </pre>
    338 
    339 <p>The format of the MagickQueryFontMetrics method is:</p>
    340 
    341 <pre class="text">
    342 double *MagickQueryFontMetrics(MagickWand *wand,
    343   const DrawingWand *drawing_wand,const char *text)
    344 </pre>
    345 
    346 <p>A description of each parameter follows:</p>
    347 
    348 <dd>
    349 </dd>
    350 
    351 <dd> </dd>
    352 <dl class="dl-horizontal">
    353 <dt>wand</dt>
    354 <dd>the Magick wand. </dd>
    355 
    356 <dd> </dd>
    357 <dt>drawing_wand</dt>
    358 <dd>the drawing wand. </dd>
    359 
    360 <dd> </dd>
    361 <dt>text</dt>
    362 <dd>the text. </dd>
    363 
    364 <dd>  </dd>
    365 </dl>
    366 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickQueryMultilineFontMetrics">MagickQueryMultilineFontMetrics</a></h2>
    367 
    368 <p>MagickQueryMultilineFontMetrics() returns a 13 element array representing the following font metrics:</p>
    369 
    370 <pre class="text">
    371     Element Description
    372     -------------------------------------------------
    373     0 character width
    374     1 character height
    375     2 ascender
    376     3 descender
    377     4 text width
    378     5 text height
    379     6 maximum horizontal advance
    380     7 bounding box: x1
    381     8 bounding box: y1
    382     9 bounding box: x2
    383    10 bounding box: y2
    384    11 origin: x
    385    12 origin: y
    386 </pre>
    387 
    388 <p>This method is like MagickQueryFontMetrics() but it returns the maximum text width and height for multiple lines of text.</p>
    389 
    390 <p>The format of the MagickQueryFontMetrics method is:</p>
    391 
    392 <pre class="text">
    393 double *MagickQueryMultilineFontMetrics(MagickWand *wand,
    394   const DrawingWand *drawing_wand,const char *text)
    395 </pre>
    396 
    397 <p>A description of each parameter follows:</p>
    398 
    399 <dd>
    400 </dd>
    401 
    402 <dd> </dd>
    403 <dl class="dl-horizontal">
    404 <dt>wand</dt>
    405 <dd>the Magick wand. </dd>
    406 
    407 <dd> </dd>
    408 <dt>drawing_wand</dt>
    409 <dd>the drawing wand. </dd>
    410 
    411 <dd> </dd>
    412 <dt>text</dt>
    413 <dd>the text. </dd>
    414 
    415 <dd>  </dd>
    416 </dl>
    417 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickQueryFonts">MagickQueryFonts</a></h2>
    418 
    419 <p>MagickQueryFonts() returns any font that match the specified pattern (e.g. "*" for all).</p>
    420 
    421 <p>The format of the MagickQueryFonts function is:</p>
    422 
    423 <pre class="text">
    424 char **MagickQueryFonts(const char *pattern,size_t *number_fonts)
    425 </pre>
    426 
    427 <p>A description of each parameter follows:</p>
    428 
    429 <dd>
    430 </dd>
    431 
    432 <dd> </dd>
    433 <dl class="dl-horizontal">
    434 <dt>pattern</dt>
    435 <dd>Specifies a pointer to a text string containing a pattern. </dd>
    436 
    437 <dd> </dd>
    438 <dt>number_fonts</dt>
    439 <dd> Returns the number of fonts in the list. </dd>
    440 
    441 <dd> </dd>
    442 
    443 <dd>  </dd>
    444 </dl>
    445 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickQueryFormats">MagickQueryFormats</a></h2>
    446 
    447 <p>MagickQueryFormats() returns any image formats that match the specified pattern (e.g.  "*" for all).</p>
    448 
    449 <p>The format of the MagickQueryFormats function is:</p>
    450 
    451 <pre class="text">
    452 char **MagickQueryFormats(const char *pattern,size_t *number_formats)
    453 </pre>
    454 
    455 <p>A description of each parameter follows:</p>
    456 
    457 <dd>
    458 </dd>
    459 
    460 <dd> </dd>
    461 <dl class="dl-horizontal">
    462 <dt>pattern</dt>
    463 <dd>Specifies a pointer to a text string containing a pattern. </dd>
    464 
    465 <dd> </dd>
    466 <dt>number_formats</dt>
    467 <dd> This integer returns the number of image formats in the list. </dd>
    468 
    469 <dd>  </dd>
    470 </dl>
    471 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickRelinquishMemory">MagickRelinquishMemory</a></h2>
    472 
    473 <p>MagickRelinquishMemory() relinquishes memory resources returned by such methods as MagickIdentifyImage(), MagickGetException(), etc.</p>
    474 
    475 <p>The format of the MagickRelinquishMemory method is:</p>
    476 
    477 <pre class="text">
    478 void *MagickRelinquishMemory(void *resource)
    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>resource</dt>
    489 <dd>Relinquish the memory associated with this resource. </dd>
    490 
    491 <dd>  </dd>
    492 </dl>
    493 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickResetIterator">MagickResetIterator</a></h2>
    494 
    495 <p>MagickResetIterator() resets the wand iterator.</p>
    496 
    497 <p>It is typically used either before iterating though images, or before calling specific functions such as  MagickAppendImages() to append all images together.</p>
    498 
    499 <p>Afterward you can use MagickNextImage() to iterate over all the images in a wand container, starting with the first image.</p>
    500 
    501 <p>Using this before MagickAddImages() or MagickReadImages() will cause new images to be inserted between the first and second image.</p>
    502 
    503 <p>The format of the MagickResetIterator method is:</p>
    504 
    505 <pre class="text">
    506 void MagickResetIterator(MagickWand *wand)
    507 </pre>
    508 
    509 <p>A description of each parameter follows:</p>
    510 
    511 <dd>
    512 </dd>
    513 
    514 <dd> </dd>
    515 <dl class="dl-horizontal">
    516 <dt>wand</dt>
    517 <dd>the magick wand. </dd>
    518 
    519 <dd>  </dd>
    520 </dl>
    521 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickSetFirstIterator">MagickSetFirstIterator</a></h2>
    522 
    523 <p>MagickSetFirstIterator() sets the wand iterator to the first image.</p>
    524 
    525 <p>After using any images added to the wand using MagickAddImage() or MagickReadImage() will be prepended before any image in the wand.</p>
    526 
    527 <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>
    528 
    529 <p>This operation is similar to MagickResetIterator() but differs in how MagickAddImage(), MagickReadImage(), and MagickNextImage() behaves afterward.</p>
    530 
    531 <p>The format of the MagickSetFirstIterator method is:</p>
    532 
    533 <pre class="text">
    534 void MagickSetFirstIterator(MagickWand *wand)
    535 </pre>
    536 
    537 <p>A description of each parameter follows:</p>
    538 
    539 <dd>
    540 </dd>
    541 
    542 <dd> </dd>
    543 <dl class="dl-horizontal">
    544 <dt>wand</dt>
    545 <dd>the magick wand. </dd>
    546 
    547 <dd>  </dd>
    548 </dl>
    549 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickSetIteratorIndex">MagickSetIteratorIndex</a></h2>
    550 
    551 <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>
    552 
    553 <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>
    554 
    555 <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>
    556 
    557 <p>Jumping to index 0 is similar to MagickResetIterator() but differs in how MagickNextImage() behaves afterward.</p>
    558 
    559 <p>The format of the MagickSetIteratorIndex method is:</p>
    560 
    561 <pre class="text">
    562 MagickBooleanType MagickSetIteratorIndex(MagickWand *wand,
    563   const ssize_t index)
    564 </pre>
    565 
    566 <p>A description of each parameter follows:</p>
    567 
    568 <dd>
    569 </dd>
    570 
    571 <dd> </dd>
    572 <dl class="dl-horizontal">
    573 <dt>wand</dt>
    574 <dd>the magick wand. </dd>
    575 
    576 <dd> </dd>
    577 <dt>index</dt>
    578 <dd>the scene number. </dd>
    579 
    580 <dd>  </dd>
    581 </dl>
    582 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickSetLastIterator">MagickSetLastIterator</a></h2>
    583 
    584 <p>MagickSetLastIterator() sets the wand iterator to the last image.</p>
    585 
    586 <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>
    587 
    588 <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>
    589 
    590 <p>The format of the MagickSetLastIterator method is:</p>
    591 
    592 <pre class="text">
    593 void MagickSetLastIterator(MagickWand *wand)
    594 </pre>
    595 
    596 <p>A description of each parameter follows:</p>
    597 
    598 <dd>
    599 </dd>
    600 
    601 <dd> </dd>
    602 <dl class="dl-horizontal">
    603 <dt>wand</dt>
    604 <dd>the magick wand. </dd>
    605 
    606 <dd>  </dd>
    607 </dl>
    608 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickWandGenesis">MagickWandGenesis</a></h2>
    609 
    610 <p>MagickWandGenesis() initializes the MagickWand environment.</p>
    611 
    612 <p>The format of the MagickWandGenesis method is:</p>
    613 
    614 <pre class="text">
    615 void MagickWandGenesis(void)
    616 </pre>
    617 
    618 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickWandTerminus">MagickWandTerminus</a></h2>
    619 
    620 <p>MagickWandTerminus() terminates the MagickWand environment.</p>
    621 
    622 <p>The format of the MaickWandTerminus method is:</p>
    623 
    624 <pre class="text">
    625 void MagickWandTerminus(void)
    626 </pre>
    627 
    628 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="NewMagickWand">NewMagickWand</a></h2>
    629 
    630 <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>
    631 
    632 <p>The format of the NewMagickWand method is:</p>
    633 
    634 <pre class="text">
    635 MagickWand *NewMagickWand(void)
    636 </pre>
    637 
    638 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="NewMagickWandFromImage">NewMagickWandFromImage</a></h2>
    639 
    640 <p>NewMagickWandFromImage() returns a wand with an image.</p>
    641 
    642 <p>The format of the NewMagickWandFromImage method is:</p>
    643 
    644 <pre class="text">
    645 MagickWand *NewMagickWandFromImage(const Image *image)
    646 </pre>
    647 
    648 <p>A description of each parameter follows:</p>
    649 
    650 <dd>
    651 </dd>
    652 
    653 <dd> </dd>
    654 <dl class="dl-horizontal">
    655 <dt>image</dt>
    656 <dd>the image. </dd>
    657 
    658 <dd>  </dd>
    659 </dl>
    660 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="IsMagickWandInstantiated">IsMagickWandInstantiated</a></h2>
    661 
    662 <p>IsMagickWandInstantiated() returns MagickTrue if the ImageMagick environment is currently instantiated--  that is, MagickWandGenesis() has been called but MagickWandTerminus() has not.</p>
    663 
    664 <p>The format of the IsMagickWandInstantiated method is:</p>
    665 
    666 <pre class="text">
    667 MagickBooleanType IsMagickWandInstantiated(void)
    668 </pre>
    669 
    670 </div>
    671     </div>
    672   </main><!-- /.container -->
    673   <footer class="magick-footer">
    674     <p><a href="../../www/security-policy.html">Security</a> 
    675     <a href="../../www/architecture.html">Architecture</a> 
    676     <a href="../../www/links.html">Related</a> 
    677      <a href="../../www/sitemap.html">Sitemap</a>
    678        
    679     <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>
    680        
    681     <a href="http://pgp.mit.edu/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> 
    682     <a href="../../www/support.html">Donate</a> 
    683     <a href="../../www/contact.html">Contact Us</a>
    684     <br/>
    685     <small> 1999-2019 ImageMagick Studio LLC</small></p>
    686   </footer>
    687 
    688   <!-- Javascript assets -->
    689   <script src="../assets/magick.js" crossorigin="anonymous"></script>
    690   <script>window.jQuery || document.write('<script src="https://localhost/ajax/libs/jquery/3.3.1/jquery.min.js"><\/script>')</script>
    691 </body>
    692 </html>
    693 <!-- Magick Cache 31st December 2018 06:24 -->