Debian Codegraph @

www/api/magick-wand.html

raw ◀ ▶
Source reconstructed at patch state 3 of 4 — not the installed (fully patched) source.
4 Debian patches touch this file
1
2
3
4
5 <!DOCTYPE html>
6 <html lang="en" data-bs-theme="dark">
7 <head>
8 <script src="../assets/color-modes.js" ></script>
9 <meta charset="utf-8" />
10 <meta name="viewport" content="width=device-width, initial-scale=1" />
11 <title>ImageMagick – MagickWand, C API: Wand Methods</title>
12 <meta name="keywords" content="MagickWand, C API: Wand Methods, Image Processing, Digital Image Editing, Image Conversion, Open-Source Software, Image Manipulation, Command-Line Image Tools" />
13 <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." />
14 <meta name="application-name" content="ImageMagick" />
15 <meta name="application-url" content="https://imagemagick.org" />
16 <meta name="copyright" content="Copyright (c) 1999 ImageMagick Studio LLC" />
17 <meta itemprop='url' content='../../' />
18 <meta itemprop='title' content='ImageMagick' />
19 <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." />
20 <meta property='og:url' content='../../' />
21 <meta property='og:name' content='ImageMagick' />
22 <meta property='og:image' content='../../../../../../../../images/logo.png' />
23 <meta property='og:type' content='website' />
24 <meta property='og:site_name' content='ImageMagick' />
25 <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." />
26 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
27 <link type="images/png" sizes="64x64" href="../../../../../../../images/wand.png" rel="icon" />
28 <link type="images/icon" sizes="16x16" href="../../../../../../../images/wand.ico" rel="shortcut icon" />
29 <link href="magick-wand.html" rel="canonical" />
30 <link href="../assets/bootstrap.min.css" rel="stylesheet" />
31 </head>
32 <body>
33 <svg xmlns="http://www.w3.org/2000/svg" class="d-none">
34 <symbol id="check2" viewBox="0 0 16 16">
35 <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"/>
36 </symbol>
37 <symbol id="circle-half" viewBox="0 0 16 16">
38 <path d="M8 15A7 7 0 1 0 8 1v14zm0 1A8 8 0 1 1 8 0a8 8 0 0 1 0 16z"/>
39 </symbol>
40 <symbol id="moon-stars-fill" viewBox="0 0 16 16">
41 <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"/>
42 <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"/>
43 </symbol>
44 <symbol id="sun-fill" viewBox="0 0 16 16">
45 <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"/>
46 </symbol>
47 </svg>
48 <div class="dropdown position-fixed bottom-0 end-0 mb-3 me-3 bd-mode-toggle">
49 <button class="btn btn-bd-secondary py-2 dropdown-toggle d-flex align-items-center"
50 id="bd-theme"
51 type="button"
52 aria-expanded="false"
53 data-bs-toggle="dropdown"
54 aria-label="Toggle theme (auto)">
55 <svg class="bi my-1 theme-icon-active" width="1em" height="1em"><use href="#circle-half"></use></svg>
56 <span class="visually-hidden" id="bd-theme-text">Toggle theme</span>
57 </button>
58 <ul class="dropdown-menu dropdown-menu-end shadow" aria-labelledby="bd-theme-text">
59 <li>
60 <button type="button" class="dropdown-item d-flex align-items-center" data-bs-theme-value="light" aria-pressed="false">
61 <svg class="bi me-2 opacity-50" width="1em" height="1em"><use href="#sun-fill"></use></svg>
62 Light
63 <svg class="bi ms-auto d-none" width="1em" height="1em"><use href="#check2"></use></svg>
64 </button>
65 </li>
66 <li>
67 <button type="button" class="dropdown-item d-flex align-items-center active" data-bs-theme-value="dark" aria-pressed="false">
68 <svg class="bi me-2 opacity-50" width="1em" height="1em"><use href="#moon-stars-fill"></use></svg>
69 Dark
70 <svg class="bi ms-auto d-none" width="1em" height="1em"><use href="#check2"></use></svg>
71 </button>
72 </li>
73 <li>
74 <button type="button" class="dropdown-item d-flex align-items-center" data-bs-theme-value="auto" aria-pressed="true">
75 <svg class="bi me-2 opacity-50" width="1em" height="1em"><use href="#circle-half"></use></svg>
76 Auto
77 <svg class="bi ms-auto d-none" width="1em" height="1em"><use href="#check2"></use></svg>
78 </button>
79 </li>
80 </ul>
81 </div>
82 <svg xmlns="http://www.w3.org/2000/svg" class="d-none">
83 <symbol id="arrow-right-circle" viewBox="0 0 16 16">
84 <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"/>
85 </symbol>
86 <symbol id="color-mode" viewBox="0 0 118 94">
87 <title>Color Modes</title>
88 <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>
89 </symbol>
90 </svg>
91 <nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top">
92 <div class="container-fluid">
93 <a class="navbar-brand" href="../index.html"><img class="d-block" id="icon" alt="ImageMagick" width="32" height="32" src="../../../../../../../images/wand.ico"/></a>
94 <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">
95 <span class="navbar-toggler-icon"></span>
96 </button>
97
98 <div class="collapse navbar-collapse" id="magick-navbars">
99 <ul class="navbar-nav me-auto mb-2 mb-md-0">
100 <li class="nav-item">
101 <a class="nav-link " href="../www/download.html">Download</a>
102 </li>
103 <li class="nav-item">
104 <a class="nav-link " href="../www/command-line-tools.html">Tools</a>
105 </li>
106 <li class="nav-item">
107 <a class="nav-link " href="../www/command-line-processing.html">CLI</a>
108 </li>
109 <li class="nav-item">
110 <a class="nav-link " href="../www/develop.html">Develop</a>
111 </li>
112 <li class="nav-item">
113 <a class="nav-link" target="_blank" href="https://github.com/ImageMagick/ImageMagick/discussions">Community</a>
114 </li>
115 <li class="nav-item">
116
117 </li>
118 </ul>
119 <form class="d-flex form-inline" action="../../../../../https://imagemagick.org/script/search.php">
120 <input class="form-control me-2" type="text" name="q" placeholder="Search" aria-label="Search">
121 <button class="btn btn-outline-success" type="submit" name="sa">Search</button>
122 </form>
123 </div>
124 </div>
125 </nav>
126
127 <div class="col-lg-8 mx-auto p-4 py-md-5 text-body-secondary">
128 <header class="d-flex align-items-center pb-3 mb-5 border-bottom">
129 <a href="../index.html" class="d-flex align-items-center text-decoration-none">
130 <h1 class="mt-5 fs-3">MagickWand, C API: Wand Methods</h1>
131 </a>
132 </header>
133
134 <main class="container">
135 <h1 class="text-center">Magick-wand</h1>
136 <div class="btn-group">
137 <button class="btn btn-secondary dropdown-toggle" type="button" id="defaultDropdown" data-bs-toggle="dropdown" data-bs-auto-close="true" aria-expanded="false">
138 Select API Method
139 </button>
140 <ul class="dropdown-menu pre-scrollable" aria-labelledby="defaultDropdown">
141 <li><a href="#ClearMagickWand">ClearMagickWand</a></li>
142 <li><a href="#CloneMagickWand">CloneMagickWand</a></li>
143 <li><a href="#DestroyMagickWand">DestroyMagickWand</a></li>
144 <li><a href="#IsMagickWand">IsMagickWand</a></li>
145 <li><a href="#MagickClearException">MagickClearException</a></li>
146 <li><a href="#MagickGetException">MagickGetException</a></li>
147 <li><a href="#MagickGetExceptionType">MagickGetExceptionType</a></li>
148 <li><a href="#MagickGetIteratorIndex">MagickGetIteratorIndex</a></li>
149 <li><a href="#MagickQueryConfigureOption">MagickQueryConfigureOption</a></li>
150 <li><a href="#MagickQueryConfigureOptions">MagickQueryConfigureOptions</a></li>
151 <li><a href="#MagickQueryFontMetrics">MagickQueryFontMetrics</a></li>
152 <li><a href="#MagickQueryMultilineFontMetrics">MagickQueryMultilineFontMetrics</a></li>
153 <li><a href="#MagickQueryFonts">MagickQueryFonts</a></li>
154 <li><a href="#MagickQueryFormats">MagickQueryFormats</a></li>
155 <li><a href="#MagickRelinquishMemory">MagickRelinquishMemory</a></li>
156 <li><a href="#MagickResetIterator">MagickResetIterator</a></li>
157 <li><a href="#MagickSetFirstIterator">MagickSetFirstIterator</a></li>
158 <li><a href="#MagickSetIteratorIndex">MagickSetIteratorIndex</a></li>
159 <li><a href="#MagickSetLastIterator">MagickSetLastIterator</a></li>
160 <li><a href="#MagickWandGenesis">MagickWandGenesis</a></li>
161 <li><a href="#MagickWandTerminus">MagickWandTerminus</a></li>
162 <li><a href="#NewMagickWand">NewMagickWand</a></li>
163 <li><a href="#NewMagickWandFromImage">NewMagickWandFromImage</a></li>
164 </ul>
165 </div>
166 <br/>
167 <br/>
168 <div class="magick-header">
169 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="ClearMagickWand">ClearMagickWand</a></h2>
170
171 <p>ClearMagickWand() clears resources associated with the wand, leaving the wand blank, and ready to be used for a new set of images.</p>
172
173 <p>The format of the ClearMagickWand method is:</p>
174
175 <pre class="bg-light text-dark mx-4"><samp>void ClearMagickWand(MagickWand *wand)
176 </samp></pre>
177
178 <p>A description of each parameter follows:</p>
179
180 <dd>
181 </dd>
182
183 <dd> </dd>
184 <dl class="dl-horizontal">
185 <dt>wand</dt>
186 <dd>the magick wand. </dd>
187
188 <dd> </dd>
189 </dl>
190 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="CloneMagickWand">CloneMagickWand</a></h2>
191
192 <p>CloneMagickWand() makes an exact copy of the specified wand.</p>
193
194 <p>The format of the CloneMagickWand method is:</p>
195
196 <pre class="bg-light text-dark mx-4"><samp>MagickWand *CloneMagickWand(const MagickWand *wand)
197 </samp></pre>
198
199 <p>A description of each parameter follows:</p>
200
201 <dd>
202 </dd>
203
204 <dd> </dd>
205 <dl class="dl-horizontal">
206 <dt>wand</dt>
207 <dd>the magick wand. </dd>
208
209 <dd> </dd>
210 </dl>
211 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="DestroyMagickWand">DestroyMagickWand</a></h2>
212
213 <p>DestroyMagickWand() deallocates memory associated with an MagickWand.</p>
214
215 <p>The format of the DestroyMagickWand method is:</p>
216
217 <pre class="bg-light text-dark mx-4"><samp>MagickWand *DestroyMagickWand(MagickWand *wand)
218 </samp></pre>
219
220 <p>A description of each parameter follows:</p>
221
222 <dd>
223 </dd>
224
225 <dd> </dd>
226 <dl class="dl-horizontal">
227 <dt>wand</dt>
228 <dd>the magick wand. </dd>
229
230 <dd> </dd>
231 </dl>
232 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="IsMagickWand">IsMagickWand</a></h2>
233
234 <p>IsMagickWand() returns MagickTrue if the wand is verified as a magick wand.</p>
235
236 <p>The format of the IsMagickWand method is:</p>
237
238 <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType IsMagickWand(const MagickWand *wand)
239 </samp></pre>
240
241 <p>A description of each parameter follows:</p>
242
243 <dd>
244 </dd>
245
246 <dd> </dd>
247 <dl class="dl-horizontal">
248 <dt>wand</dt>
249 <dd>the magick wand. </dd>
250
251 <dd> </dd>
252 </dl>
253 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickClearException">MagickClearException</a></h2>
254
255 <p>MagickClearException() clears any exceptions associated with the wand.</p>
256
257 <p>The format of the MagickClearException method is:</p>
258
259 <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType MagickClearException(MagickWand *wand)
260 </samp></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>wand</dt>
270 <dd>the magick wand. </dd>
271
272 <dd> </dd>
273 </dl>
274 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickGetException">MagickGetException</a></h2>
275
276 <p>MagickGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p>
277
278 <p>Use RelinquishMagickMemory() to free the description when its no longer in use.</p>
279
280 <p>The format of the MagickGetException method is:</p>
281
282 <pre class="bg-light text-dark mx-4"><samp>char *MagickGetException(const MagickWand *wand,ExceptionType *severity)
283 </samp></pre>
284
285 <p>A description of each parameter follows:</p>
286
287 <dd>
288 </dd>
289
290 <dd> </dd>
291 <dl class="dl-horizontal">
292 <dt>wand</dt>
293 <dd>the magick wand. </dd>
294
295 <dd> </dd>
296 <dt>severity</dt>
297 <dd>the severity of the error is returned here. </dd>
298
299 <dd> </dd>
300 </dl>
301 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickGetExceptionType">MagickGetExceptionType</a></h2>
302
303 <p>MagickGetExceptionType() returns the exception type associated with the wand. If no exception has occurred, UndefinedExceptionType is returned.</p>
304
305 <p>The format of the MagickGetExceptionType method is:</p>
306
307 <pre class="bg-light text-dark mx-4"><samp>ExceptionType MagickGetExceptionType(const MagickWand *wand)
308 </samp></pre>
309
310 <p>A description of each parameter follows:</p>
311
312 <dd>
313 </dd>
314
315 <dd> </dd>
316 <dl class="dl-horizontal">
317 <dt>wand</dt>
318 <dd>the magick wand. </dd>
319
320 <dd> </dd>
321 </dl>
322 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickGetIteratorIndex">MagickGetIteratorIndex</a></h2>
323
324 <p>MagickGetIteratorIndex() returns the position of the iterator in the image list.</p>
325
326 <p>The format of the MagickGetIteratorIndex method is:</p>
327
328 <pre class="bg-light text-dark mx-4"><samp>ssize_t MagickGetIteratorIndex(MagickWand *wand)
329 </samp></pre>
330
331 <p>A description of each parameter follows:</p>
332
333 <dd>
334 </dd>
335
336 <dd> </dd>
337 <dl class="dl-horizontal">
338 <dt>wand</dt>
339 <dd>the magick wand. </dd>
340
341 <dd> </dd>
342 </dl>
343 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickQueryConfigureOption">MagickQueryConfigureOption</a></h2>
344
345 <p>MagickQueryConfigureOption() returns the value associated with the specified configure option.</p>
346
347 <p>The format of the MagickQueryConfigureOption function is:</p>
348
349 <pre class="bg-light text-dark mx-4"><samp>char *MagickQueryConfigureOption(const char *option)
350 </samp></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>option</dt>
360 <dd>the option name. </dd>
361
362 <dd> </dd>
363 </dl>
364 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickQueryConfigureOptions">MagickQueryConfigureOptions</a></h2>
365
366 <p>MagickQueryConfigureOptions() returns any configure options that match the specified pattern (e.g. "*" for all). Options include NAME, VERSION, LIB_VERSION, etc.</p>
367
368 <p>The format of the MagickQueryConfigureOptions function is:</p>
369
370 <pre class="bg-light text-dark mx-4"><samp>char **MagickQueryConfigureOptions(const char *pattern,
371 size_t *number_options)
372 </samp></pre>
373
374 <p>A description of each parameter follows:</p>
375
376 <dd>
377 </dd>
378
379 <dd> </dd>
380 <dl class="dl-horizontal">
381 <dt>pattern</dt>
382 <dd>Specifies a pointer to a text string containing a pattern. </dd>
383
384 <dd> </dd>
385 <dt>number_options</dt>
386 <dd> Returns the number of configure options in the list. </dd>
387
388 <dd> </dd>
389 </dl>
390 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickQueryFontMetrics">MagickQueryFontMetrics</a></h2>
391
392 <p>MagickQueryFontMetrics() returns a 13 element array representing the following font metrics:</p>
393
394 <pre class="bg-light text-dark mx-4"><samp> Element Description
395 -------------------------------------------------
396 0 character width
397 1 character height
398 2 ascender
399 3 descender
400 4 text width
401 5 text height
402 6 maximum horizontal advance
403 7 bounding box: x1
404 8 bounding box: y1
405 9 bounding box: x2
406 10 bounding box: y2
407 11 origin: x
408 12 origin: y
409 </samp></pre>
410
411 <p>The format of the MagickQueryFontMetrics method is:</p>
412
413 <pre class="bg-light text-dark mx-4"><samp>double *MagickQueryFontMetrics(MagickWand *wand,
414 const DrawingWand *drawing_wand,const char *text)
415 </samp></pre>
416
417 <p>A description of each parameter follows:</p>
418
419 <dd>
420 </dd>
421
422 <dd> </dd>
423 <dl class="dl-horizontal">
424 <dt>wand</dt>
425 <dd>the Magick wand. </dd>
426
427 <dd> </dd>
428 <dt>drawing_wand</dt>
429 <dd>the drawing wand. </dd>
430
431 <dd> </dd>
432 <dt>text</dt>
433 <dd>the text. </dd>
434
435 <dd> </dd>
436 </dl>
437 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickQueryMultilineFontMetrics">MagickQueryMultilineFontMetrics</a></h2>
438
439 <p>MagickQueryMultilineFontMetrics() returns a 13 element array representing the following font metrics:</p>
440
441 <pre class="bg-light text-dark mx-4"><samp> Element Description
442 -------------------------------------------------
443 0 character width
444 1 character height
445 2 ascender
446 3 descender
447 4 text width
448 5 text height
449 6 maximum horizontal advance
450 7 bounding box: x1
451 8 bounding box: y1
452 9 bounding box: x2
453 10 bounding box: y2
454 11 origin: x
455 12 origin: y
456 </samp></pre>
457
458 <p>This method is like MagickQueryFontMetrics() but it returns the maximum text width and height for multiple lines of text.</p>
459
460 <p>The format of the MagickQueryFontMetrics method is:</p>
461
462 <pre class="bg-light text-dark mx-4"><samp>double *MagickQueryMultilineFontMetrics(MagickWand *wand,
463 const DrawingWand *drawing_wand,const char *text)
464 </samp></pre>
465
466 <p>A description of each parameter follows:</p>
467
468 <dd>
469 </dd>
470
471 <dd> </dd>
472 <dl class="dl-horizontal">
473 <dt>wand</dt>
474 <dd>the Magick wand. </dd>
475
476 <dd> </dd>
477 <dt>drawing_wand</dt>
478 <dd>the drawing wand. </dd>
479
480 <dd> </dd>
481 <dt>text</dt>
482 <dd>the text. </dd>
483
484 <dd> </dd>
485 </dl>
486 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickQueryFonts">MagickQueryFonts</a></h2>
487
488 <p>MagickQueryFonts() returns any font that match the specified pattern (e.g. "*" for all).</p>
489
490 <p>The format of the MagickQueryFonts function is:</p>
491
492 <pre class="bg-light text-dark mx-4"><samp>char **MagickQueryFonts(const char *pattern,size_t *number_fonts)
493 </samp></pre>
494
495 <p>A description of each parameter follows:</p>
496
497 <dd>
498 </dd>
499
500 <dd> </dd>
501 <dl class="dl-horizontal">
502 <dt>pattern</dt>
503 <dd>Specifies a pointer to a text string containing a pattern. </dd>
504
505 <dd> </dd>
506 <dt>number_fonts</dt>
507 <dd> Returns the number of fonts in the list. </dd>
508
509 <dd> </dd>
510 </dl>
511 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickQueryFormats">MagickQueryFormats</a></h2>
512
513 <p>MagickQueryFormats() returns any image formats that match the specified pattern (e.g. "*" for all).</p>
514
515 <p>The format of the MagickQueryFormats function is:</p>
516
517 <pre class="bg-light text-dark mx-4"><samp>char **MagickQueryFormats(const char *pattern,size_t *number_formats)
518 </samp></pre>
519
520 <p>A description of each parameter follows:</p>
521
522 <dd>
523 </dd>
524
525 <dd> </dd>
526 <dl class="dl-horizontal">
527 <dt>pattern</dt>
528 <dd>Specifies a pointer to a text string containing a pattern. </dd>
529
530 <dd> </dd>
531 <dt>number_formats</dt>
532 <dd> This integer returns the number of image formats in the list. </dd>
533
534 <dd> </dd>
535 </dl>
536 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickRelinquishMemory">MagickRelinquishMemory</a></h2>
537
538 <p>MagickRelinquishMemory() relinquishes memory resources returned by such methods as MagickIdentifyImage(), MagickGetException(), etc.</p>
539
540 <p>The format of the MagickRelinquishMemory method is:</p>
541
542 <pre class="bg-light text-dark mx-4"><samp>void *MagickRelinquishMemory(void *resource)
543 </samp></pre>
544
545 <p>A description of each parameter follows:</p>
546
547 <dd>
548 </dd>
549
550 <dd> </dd>
551 <dl class="dl-horizontal">
552 <dt>resource</dt>
553 <dd>Relinquish the memory associated with this resource. </dd>
554
555 <dd> </dd>
556 </dl>
557 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickResetIterator">MagickResetIterator</a></h2>
558
559 <p>MagickResetIterator() resets the wand iterator.</p>
560
561 <p>It is typically used either before iterating though images, or before calling specific functions such as MagickAppendImages() to append all images together.</p>
562
563 <p>Afterward you can use MagickNextImage() to iterate over all the images in a wand container, starting with the first image.</p>
564
565 <p>Using this before MagickAddImages() or MagickReadImages() will cause new images to be inserted between the first and second image.</p>
566
567 <p>The format of the MagickResetIterator method is:</p>
568
569 <pre class="bg-light text-dark mx-4"><samp>void MagickResetIterator(MagickWand *wand)
570 </samp></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 </dl>
584 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickSetFirstIterator">MagickSetFirstIterator</a></h2>
585
586 <p>MagickSetFirstIterator() sets the wand iterator to the first image.</p>
587
588 <p>After using any images added to the wand using MagickAddImage() or MagickReadImage() will be prepended before any image in the wand.</p>
589
590 <p>Also the current image has been set to the first image (if any) in the Magick Wand. Using MagickNextImage() will then set the current image to the second image in the list (if present).</p>
591
592 <p>This operation is similar to MagickResetIterator() but differs in how MagickAddImage(), MagickReadImage(), and MagickNextImage() behaves afterward.</p>
593
594 <p>The format of the MagickSetFirstIterator method is:</p>
595
596 <pre class="bg-light text-dark mx-4"><samp>void MagickSetFirstIterator(MagickWand *wand)
597 </samp></pre>
598
599 <p>A description of each parameter follows:</p>
600
601 <dd>
602 </dd>
603
604 <dd> </dd>
605 <dl class="dl-horizontal">
606 <dt>wand</dt>
607 <dd>the magick wand. </dd>
608
609 <dd> </dd>
610 </dl>
611 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickSetIteratorIndex">MagickSetIteratorIndex</a></h2>
612
613 <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>
614
615 <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>
616
617 <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>
618
619 <p>Jumping to index 0 is similar to MagickResetIterator() but differs in how MagickNextImage() behaves afterward.</p>
620
621 <p>The format of the MagickSetIteratorIndex method is:</p>
622
623 <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType MagickSetIteratorIndex(MagickWand *wand,
624 const ssize_t index)
625 </samp></pre>
626
627 <p>A description of each parameter follows:</p>
628
629 <dd>
630 </dd>
631
632 <dd> </dd>
633 <dl class="dl-horizontal">
634 <dt>wand</dt>
635 <dd>the magick wand. </dd>
636
637 <dd> </dd>
638 <dt>index</dt>
639 <dd>the scene number. </dd>
640
641 <dd> </dd>
642 </dl>
643 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickSetLastIterator">MagickSetLastIterator</a></h2>
644
645 <p>MagickSetLastIterator() sets the wand iterator to the last image.</p>
646
647 <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>
648
649 <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>
650
651 <p>The format of the MagickSetLastIterator method is:</p>
652
653 <pre class="bg-light text-dark mx-4"><samp>void MagickSetLastIterator(MagickWand *wand)
654 </samp></pre>
655
656 <p>A description of each parameter follows:</p>
657
658 <dd>
659 </dd>
660
661 <dd> </dd>
662 <dl class="dl-horizontal">
663 <dt>wand</dt>
664 <dd>the magick wand. </dd>
665
666 <dd> </dd>
667 </dl>
668 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickWandGenesis">MagickWandGenesis</a></h2>
669
670 <p>MagickWandGenesis() initializes the MagickWand environment.</p>
671
672 <p>The format of the MagickWandGenesis method is:</p>
673
674 <pre class="bg-light text-dark mx-4"><samp>void MagickWandGenesis(void)
675 </samp></pre>
676
677 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="MagickWandTerminus">MagickWandTerminus</a></h2>
678
679 <p>MagickWandTerminus() is a function in the ImageMagick library that is used to clean up and release resources when shutting down an application that uses ImageMagick. This function should be called in the primary thread of the application's process during the shutdown process. It's crucial that this function is invoked only after any threads that are using ImageMagick functions have terminated.</p>
680
681 <p>ImageMagick might internally use threads via OpenMP (a method for parallel programming). As a result, it's important to ensure that any function calls into ImageMagick have completed before calling MagickWandTerminus(). This prevents issues with OpenMP worker threads accessing resources that are destroyed by this termination function.</p>
682
683 <p>If OpenMP is being used (starting from version 5.0), the OpenMP implementation itself handles starting and stopping worker threads and allocating and freeing resources using its own methods. This means that after calling MagickWandTerminus(), some OpenMP resources and worker threads might still remain allocated. To address this, the function omp_pause_resource_all(omp_pause_hard) can be invoked. This function, introduced in OpenMP version 5.0, ensures that any resources allocated by OpenMP (such as threads and thread-specific memory) are freed. It's recommended to call this function after MagickWandTerminus() has completed its execution.</p>
684
685 <p>The format of the MagickWandTerminus method is:</p>
686
687 <pre class="bg-light text-dark mx-4"><samp>void MagickWandTerminus(void)
688 </samp></pre>
689
690 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="NewMagickWand">NewMagickWand</a></h2>
691
692 <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>
693
694 <p>The format of the NewMagickWand method is:</p>
695
696 <pre class="bg-light text-dark mx-4"><samp>MagickWand *NewMagickWand(void)
697 </samp></pre>
698
699 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="NewMagickWandFromImage">NewMagickWandFromImage</a></h2>
700
701 <p>NewMagickWandFromImage() returns a wand with an image.</p>
702
703 <p>The format of the NewMagickWandFromImage method is:</p>
704
705 <pre class="bg-light text-dark mx-4"><samp>MagickWand *NewMagickWandFromImage(const Image *image)
706 </samp></pre>
707
708 <p>A description of each parameter follows:</p>
709
710 <dd>
711 </dd>
712
713 <dd> </dd>
714 <dl class="dl-horizontal">
715 <dt>image</dt>
716 <dd>the image. </dd>
717
718 <dd> </dd>
719 </dl>
720 <h2><a href="../../api/MagickWand/magick-wand_8c.html" id="IsMagickWandInstantiated">IsMagickWandInstantiated</a></h2>
721
722 <p>IsMagickWandInstantiated() returns MagickTrue if the ImageMagick environment is currently instantiated-- that is, MagickWandGenesis() has been called but MagickWandTerminus() has not.</p>
723
724 <p>The format of the IsMagickWandInstantiated method is:</p>
725
726 <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType IsMagickWandInstantiated(void)
727 </samp></pre>
728
729 </div>
730 </main><!-- /.container -->
731 <footer class="py-5 text-center text-body-secondary bg-body-tertiary">
732 <div class="container-fluid">
733 <a href="../www/security-policy.html">Security</a> •
734 <a href="../www/news.html">News</a>
735
736 <a href="#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../../../../../../../images/wand.ico"/></a>
737
738 <a href="../www/links.html">Related</a> •
739 <a href="../www/sitemap.html">Sitemap</a>
740 <br/>
741 <a href="../www/support.html">Sponsor</a> •
742 <a href="../www/cite.html">Cite</a> •
743 <a href="http://pgp.mit.edu/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
744 <a href="../www/contact.html">Contact Us</a>
745 <br/>
746 <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> •
747 <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>
748 <br/>
749 <small>Copyright © 1999 ImageMagick Studio LLC</small>
750 </div>
751 </footer>
752 </div>
753
754 <!-- Javascript assets -->
755 <script src="../assets/bootstrap.bundle.min.js" ></script>
756 </body>
757 </html>