Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / ea2793ef7733b63d12c11557fd09df2f1062d61f / . / www / api / magick-deprecate.html
blob: d10d16615bfd48d1829fc303eb911194e8fcf38b [file] [log] [blame]
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1<!DOCTYPE html>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]2<html lang="en">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]3<head>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]4 <meta charset="utf-8">
5 <meta http-equiv="X-UA-Compatible" content="IE=edge">
6 <meta name="viewport" content="width=device-width, initial-scale=1">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]7 <title>ImageMagick: MagickWand, C API for ImageMagick: Deprecated Methods</title>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]8 <meta http-equiv="content-language" content="en-US">
9 <meta http-equiv="content-type" content="text/html; charset=utf-8">
10 <meta http-equiv="reply-to" content="magick-users@imagemagick.org">
11 <meta name="application-name" content="ImageMagick">
12 <meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.">
13 <meta name="application-url" content="http://www.imagemagick.org">
14 <meta name="generator" content="PHP">
15 <meta name="keywords" content="magickwc, api, for, imagemagick:, deprecated, methods, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert">
16 <meta name="rating" content="GENERAL">
17 <meta name="robots" content="INDEX, FOLLOW">
18 <meta name="generator" content="ImageMagick Studio LLC">
19 <meta name="author" content="ImageMagick Studio LLC">
20 <meta name="revisit-after" content="2 DAYS">
21 <meta name="resource-type" content="document">
cristy4e638cd2015-05-07 16:47:40 +0000[diff] [blame]22 <meta name="copyright" content="Copyright (c) 1999-2015 ImageMagick Studio LLC">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]23 <meta name="distribution" content="Global">
24 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1">
cristy2f563d42015-05-06 23:36:51 +0000[diff] [blame]25 <link rel="icon" href="../images/wand.png">
26 <link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon">
27 <link rel="stylesheet" href="../css/bootstrap.min.css">
28 <link rel="stylesheet" href="../css/magick.css">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]29</head>
30
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]31<body>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]32<div class="main">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]33<div class="magick-masthead">
34 <div class="container">
35 <script type="text/javascript">
36 <!--
37 google_ad_client = "pub-3129977114552745";
38 google_ad_slot = "5439289906";
39 google_ad_width = 728;
40 google_ad_height = 90;
41 //-->
42 </script>
43 <center><script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
44 </script></center>
45 <nav class="magick-nav">
cristy2f563d42015-05-06 23:36:51 +0000[diff] [blame]46 <a class="magick-nav-item " href="../index.html">Home</a>
cristyea2793e2015-05-31 16:52:26 +0000[diff] [blame^]47 <a class="magick-nav-item " href="../binary-releases.html">Download</a>
cristy38185362015-05-07 20:09:56 +0000[diff] [blame]48 <a class="magick-nav-item " href="../command-line-tools.html">Tools</a>
49 <a class="magick-nav-item " href="../command-line-options.html">Options</a>
cristyea2793e2015-05-31 16:52:26 +0000[diff] [blame^]50 <a class="magick-nav-item " href="../resources.html">Resources</a>
51 <a class="magick-nav-item " href="api.html">Develop</a>
cristya1890f02015-05-15 23:32:44 +0000[diff] [blame]52 <a class="magick-nav-item " href="http://www.imagemagick.org/script/search.php">Search</a>
53 <a class="magick-nav-item pull-right" href="http://www.imagemagick.org/discourse-server/">Community</a>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]54 </nav>
55 </div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]56</div>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]57<div class="container">
cristy4e638cd2015-05-07 16:47:40 +0000[diff] [blame]58<div class="magick-header">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]59<p class="text-center"><a href="magick-deprecate.html#MagickAverageImages">MagickAverageImages</a> • <a href="magick-deprecate.html#ClonePixelView">ClonePixelView</a> • <a href="magick-deprecate.html#DestroyPixelView">DestroyPixelView</a> • <a href="magick-deprecate.html#DuplexTransferPixelViewIterator">DuplexTransferPixelViewIterator</a> • <a href="magick-deprecate.html#GetPixelViewException">GetPixelViewException</a> • <a href="magick-deprecate.html#GetPixelViewHeight">GetPixelViewHeight</a> • <a href="magick-deprecate.html#GetPixelViewIterator">GetPixelViewIterator</a> • <a href="magick-deprecate.html#GetPixelViewPixels">GetPixelViewPixels</a> • <a href="magick-deprecate.html#GetPixelViewWand">GetPixelViewWand</a> • <a href="magick-deprecate.html#GetPixelViewWidth">GetPixelViewWidth</a> • <a href="magick-deprecate.html#GetPixelViewX">GetPixelViewX</a> • <a href="magick-deprecate.html#GetPixelViewY">GetPixelViewY</a> • <a href="magick-deprecate.html#IsPixelView">IsPixelView</a> • <a href="magick-deprecate.html#MagickClipPathImage">MagickClipPathImage</a> • <a href="magick-deprecate.html#DrawGetFillAlpha">DrawGetFillAlpha</a> • <a href="magick-deprecate.html#DrawGetStrokeAlpha">DrawGetStrokeAlpha</a> • <a href="magick-deprecate.html#DrawPeekGraphicWand">DrawPeekGraphicWand</a> • <a href="magick-deprecate.html#DrawPopGraphicContext">DrawPopGraphicContext</a> • <a href="magick-deprecate.html#DrawPushGraphicContext">DrawPushGraphicContext</a> • <a href="magick-deprecate.html#DrawSetFillAlpha">DrawSetFillAlpha</a> • <a href="magick-deprecate.html#DrawSetStrokeAlpha">DrawSetStrokeAlpha</a> • <a href="magick-deprecate.html#MagickColorFloodfillImage">MagickColorFloodfillImage</a> • <a href="magick-deprecate.html#MagickDescribeImage">MagickDescribeImage</a> • <a href="magick-deprecate.html#MagickFlattenImages">MagickFlattenImages</a> • <a href="magick-deprecate.html#MagickGetImageAttribute">MagickGetImageAttribute</a> • <a href="magick-deprecate.html#MagickGetImageMatte">MagickGetImageMatte</a> • <a href="magick-deprecate.html#MagickGetImagePixels">MagickGetImagePixels</a> • <a href="magick-deprecate.html#MagickGetImageSize">MagickGetImageSize</a> • <a href="magick-deprecate.html#MagickMapImage">MagickMapImage</a> • <a href="magick-deprecate.html#MagickMatteFloodfillImage">MagickMatteFloodfillImage</a> • <a href="magick-deprecate.html#MagickMedianFilterImage">MagickMedianFilterImage</a> • <a href="magick-deprecate.html#MagickMinimumImages">MagickMinimumImages</a> • <a href="magick-deprecate.html#MagickModeImage">MagickModeImage</a> • <a href="magick-deprecate.html#MagickMosaicImages">MagickMosaicImages</a> • <a href="magick-deprecate.html#MagickOpaqueImage">MagickOpaqueImage</a> • <a href="magick-deprecate.html#MagickPaintFloodfillImage">MagickPaintFloodfillImage</a> • <a href="magick-deprecate.html#MagickPaintOpaqueImage">MagickPaintOpaqueImage</a> • <a href="magick-deprecate.html#MagickPaintTransparentImage">MagickPaintTransparentImage</a> • <a href="magick-deprecate.html#MagickRadialBlurImage">MagickRadialBlurImage</a> • <a href="magick-deprecate.html#MagickRecolorImage">MagickRecolorImage</a> • <a href="magick-deprecate.html#MagickReduceNoiseImage">MagickReduceNoiseImage</a> • <a href="magick-deprecate.html#MagickMaximumImages">MagickMaximumImages</a> • <a href="magick-deprecate.html#MagickSetImageAttribute">MagickSetImageAttribute</a> • <a href="magick-deprecate.html#MagickSetImageIndex">MagickSetImageIndex</a> • <a href="magick-deprecate.html#MagickTransparentImage">MagickTransparentImage</a> • <a href="magick-deprecate.html#MagickRegionOfInterestImage">MagickRegionOfInterestImage</a> • <a href="magick-deprecate.html#MagickSetImagePixels">MagickSetImagePixels</a> • <a href="magick-deprecate.html#MagickWriteImageBlob">MagickWriteImageBlob</a> • <a href="magick-deprecate.html#NewPixelView">NewPixelView</a> • <a href="magick-deprecate.html#NewPixelViewRegion">NewPixelViewRegion</a> • <a href="magick-deprecate.html#PixelGetNextRow">PixelGetNextRow</a> • <a href="magick-deprecate.html#PixelIteratorGetException">PixelIteratorGetException</a> • <a href="magick-deprecate.html#SetPixelViewIterator">SetPixelViewIterator</a> • <a href="magick-deprecate.html#TransferPixelViewIterator">TransferPixelViewIterator</a> • <a href="magick-deprecate.html#UpdatePixelViewIterator">UpdatePixelViewIterator</a></p>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]60
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]61<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickAverageImages">MagickAverageImages</a></h2>
62
63<p>MagickAverageImages() average a set of images.</p>
64
65<p>The format of the MagickAverageImages method is:</p>
66
67<pre class="text">
68MagickWand *MagickAverageImages(MagickWand *wand)
69</pre>
70
71<p>A description of each parameter follows:</p>
72
73<dd>
74</dd>
75
76<dd> </dd>
77<dl class="dl-horizontal">
78<dt>wand</dt>
79<dd>the magick wand. </dd>
80
81<dd> </dd>
82</dl>
83<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="ClonePixelView">ClonePixelView</a></h2>
84
85<p>ClonePixelView() makes a copy of the specified pixel view.</p>
86
87<p>The format of the ClonePixelView method is:</p>
88
89<pre class="text">
90PixelView *ClonePixelView(const PixelView *pixel_view)
91</pre>
92
93<p>A description of each parameter follows:</p>
94
95<dd>
96</dd>
97
98<dd> </dd>
99<dl class="dl-horizontal">
100<dt>pixel_view</dt>
101<dd>the pixel view. </dd>
102
103<dd> </dd>
104</dl>
105<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DestroyPixelView">DestroyPixelView</a></h2>
106
107<p>DestroyPixelView() deallocates memory associated with a pixel view.</p>
108
109<p>The format of the DestroyPixelView method is:</p>
110
111<pre class="text">
112PixelView *DestroyPixelView(PixelView *pixel_view,
113 const size_t number_wands,const size_t number_threads)
114</pre>
115
116<p>A description of each parameter follows:</p>
117
118<dd>
119</dd>
120
121<dd> </dd>
122<dl class="dl-horizontal">
123<dt>pixel_view</dt>
124<dd>the pixel view. </dd>
125
126<dd> </dd>
127<dt>number_wand</dt>
128<dd>the number of pixel wands. </dd>
129
130<dd> </dd>
131<dt>number_threads</dt>
132<dd>number of threads. </dd>
133
134<dd> </dd>
135</dl>
136<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DuplexTransferPixelViewIterator">DuplexTransferPixelViewIterator</a></h2>
137
138<p>DuplexTransferPixelViewIterator() iterates over three pixel views in parallel and calls your transfer method for each scanline of the view. The source and duplex pixel region 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 pixel view is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension are permitted.</p>
139
140<p>Use this pragma:</p>
141
142<pre class="text">
143 #pragma omp critical
144</pre>
145
146<p>to define a section of code in your callback transfer method that must be executed by a single thread at a time.</p>
147
148<p>The format of the DuplexTransferPixelViewIterator method is:</p>
149
150<pre class="text">
151MagickBooleanType DuplexTransferPixelViewIterator(PixelView *source,
152 PixelView *duplex,PixelView *destination,
153 DuplexTransferPixelViewMethod transfer,void *context)
154</pre>
155
156<p>A description of each parameter follows:</p>
157
158<dd>
159</dd>
160
161<dd> </dd>
162<dl class="dl-horizontal">
163<dt>source</dt>
164<dd>the source pixel view. </dd>
165
166<dd> </dd>
167<dt>duplex</dt>
168<dd>the duplex pixel view. </dd>
169
170<dd> </dd>
171<dt>destination</dt>
172<dd>the destination pixel view. </dd>
173
174<dd> </dd>
175<dt>transfer</dt>
176<dd>the transfer callback method. </dd>
177
178<dd> </dd>
179<dt>context</dt>
180<dd>the user defined context. </dd>
181
182<dd> </dd>
183</dl>
184<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="GetPixelViewException">GetPixelViewException</a></h2>
185
186<p>GetPixelViewException() returns the severity, reason, and description of any error that occurs when utilizing a pixel view.</p>
187
188<p>The format of the GetPixelViewException method is:</p>
189
190<pre class="text">
191char *GetPixelViewException(const PixelWand *pixel_view,
192 ExceptionType *severity)
193</pre>
194
195<p>A description of each parameter follows:</p>
196
197<dd>
198</dd>
199
200<dd> </dd>
201<dl class="dl-horizontal">
202<dt>pixel_view</dt>
203<dd>the pixel pixel_view. </dd>
204
205<dd> </dd>
206<dt>severity</dt>
207<dd>the severity of the error is returned here. </dd>
208
209<dd> </dd>
210</dl>
211<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="GetPixelViewHeight">GetPixelViewHeight</a></h2>
212
213<p>GetPixelViewHeight() returns the pixel view height.</p>
214
215<p>The format of the GetPixelViewHeight method is:</p>
216
217<pre class="text">
218size_t GetPixelViewHeight(const PixelView *pixel_view)
219</pre>
220
221<p>A description of each parameter follows:</p>
222
223<dd>
224</dd>
225
226<dd> </dd>
227<dl class="dl-horizontal">
228<dt>pixel_view</dt>
229<dd>the pixel view. </dd>
230
231<dd> </dd>
232</dl>
233<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="GetPixelViewIterator">GetPixelViewIterator</a></h2>
234
235<p>GetPixelViewIterator() iterates over the pixel view in parallel and calls your get method for each scanline of the view. The pixel region 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>
236
237<p>Use this pragma:</p>
238
239<pre class="text">
240 #pragma omp critical
241</pre>
242
243<p>to define a section of code in your callback get method that must be executed by a single thread at a time.</p>
244
245<p>The format of the GetPixelViewIterator method is:</p>
246
247<pre class="text">
248MagickBooleanType GetPixelViewIterator(PixelView *source,
249 GetPixelViewMethod get,void *context)
250</pre>
251
252<p>A description of each parameter follows:</p>
253
254<dd>
255</dd>
256
257<dd> </dd>
258<dl class="dl-horizontal">
259<dt>source</dt>
260<dd>the source pixel view. </dd>
261
262<dd> </dd>
263<dt>get</dt>
264<dd>the get callback method. </dd>
265
266<dd> </dd>
267<dt>context</dt>
268<dd>the user defined context. </dd>
269
270<dd> </dd>
271</dl>
272<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="GetPixelViewPixels">GetPixelViewPixels</a></h2>
273
274<p>GetPixelViewPixels() returns the pixel view pixel_wands.</p>
275
276<p>The format of the GetPixelViewPixels method is:</p>
277
278<pre class="text">
279PixelWand *GetPixelViewPixels(const PixelView *pixel_view)
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>pixel_view</dt>
290<dd>the pixel view. </dd>
291
292<dd> </dd>
293</dl>
294<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="GetPixelViewWand">GetPixelViewWand</a></h2>
295
296<p>GetPixelViewWand() returns the magick wand associated with the pixel view.</p>
297
298<p>The format of the GetPixelViewWand method is:</p>
299
300<pre class="text">
301MagickWand *GetPixelViewWand(const PixelView *pixel_view)
302</pre>
303
304<p>A description of each parameter follows:</p>
305
306<dd>
307</dd>
308
309<dd> </dd>
310<dl class="dl-horizontal">
311<dt>pixel_view</dt>
312<dd>the pixel view. </dd>
313
314<dd> </dd>
315</dl>
316<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="GetPixelViewWidth">GetPixelViewWidth</a></h2>
317
318<p>GetPixelViewWidth() returns the pixel view width.</p>
319
320<p>The format of the GetPixelViewWidth method is:</p>
321
322<pre class="text">
323size_t GetPixelViewWidth(const PixelView *pixel_view)
324</pre>
325
326<p>A description of each parameter follows:</p>
327
328<dd>
329</dd>
330
331<dd> </dd>
332<dl class="dl-horizontal">
333<dt>pixel_view</dt>
334<dd>the pixel view. </dd>
335
336<dd> </dd>
337</dl>
338<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="GetPixelViewX">GetPixelViewX</a></h2>
339
340<p>GetPixelViewX() returns the pixel view x offset.</p>
341
342<p>The format of the GetPixelViewX method is:</p>
343
344<pre class="text">
345ssize_t GetPixelViewX(const PixelView *pixel_view)
346</pre>
347
348<p>A description of each parameter follows:</p>
349
350<dd>
351</dd>
352
353<dd> </dd>
354<dl class="dl-horizontal">
355<dt>pixel_view</dt>
356<dd>the pixel view. </dd>
357
358<dd> </dd>
359</dl>
360<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="GetPixelViewY">GetPixelViewY</a></h2>
361
362<p>GetPixelViewY() returns the pixel view y offset.</p>
363
364<p>The format of the GetPixelViewY method is:</p>
365
366<pre class="text">
367ssize_t GetPixelViewY(const PixelView *pixel_view)
368</pre>
369
370<p>A description of each parameter follows:</p>
371
372<dd>
373</dd>
374
375<dd> </dd>
376<dl class="dl-horizontal">
377<dt>pixel_view</dt>
378<dd>the pixel view. </dd>
379
380<dd> </dd>
381</dl>
382<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="IsPixelView">IsPixelView</a></h2>
383
384<p>IsPixelView() returns MagickTrue if the the parameter is verified as a pixel view container.</p>
385
386<p>The format of the IsPixelView method is:</p>
387
388<pre class="text">
389MagickBooleanType IsPixelView(const PixelView *pixel_view)
390</pre>
391
392<p>A description of each parameter follows:</p>
393
394<dd>
395</dd>
396
397<dd> </dd>
398<dl class="dl-horizontal">
399<dt>pixel_view</dt>
400<dd>the pixel view. </dd>
401
402<dd> </dd>
403</dl>
404<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickClipPathImage">MagickClipPathImage</a></h2>
405
406<p>MagickClipPathImage() clips along the named paths from the 8BIM profile, if present. Later operations take effect inside the path. Id may be a number if preceded with #, to work on a numbered path, e.g., "#1" to use the first path.</p>
407
408<p>The format of the MagickClipPathImage method is:</p>
409
410<pre class="text">
411MagickBooleanType MagickClipPathImage(MagickWand *wand,
412 const char *pathname,const MagickBooleanType inside)
413</pre>
414
415<p>A description of each parameter follows:</p>
416
417<dd>
418</dd>
419
420<dd> </dd>
421<dl class="dl-horizontal">
422<dt>wand</dt>
423<dd>the magick wand. </dd>
424
425<dd> </dd>
426<dt>pathname</dt>
427<dd>name of clipping path resource. If name is preceded by #, use clipping path numbered by name. </dd>
428
429<dd> </dd>
430<dt>inside</dt>
431<dd>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path. </dd>
432
433<dd> </dd>
434</dl>
435<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DrawGetFillAlpha">DrawGetFillAlpha</a></h2>
436
437<p>DrawGetFillAlpha() returns the alpha used when drawing using the fill color or fill texture. Fully opaque is 1.0.</p>
438
439<p>The format of the DrawGetFillAlpha method is:</p>
440
441<pre class="text">
442double DrawGetFillAlpha(const DrawingWand *wand)
443</pre>
444
445<p>A description of each parameter follows:</p>
446
447<dd>
448</dd>
449
450<dd> </dd>
451<dl class="dl-horizontal">
452<dt>wand</dt>
453<dd>the drawing wand. </dd>
454
455<dd> </dd>
456</dl>
457<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DrawGetStrokeAlpha">DrawGetStrokeAlpha</a></h2>
458
459<p>DrawGetStrokeAlpha() returns the alpha of stroked object outlines.</p>
460
461<p>The format of the DrawGetStrokeAlpha method is:</p>
462
463<pre class="text">
464double DrawGetStrokeAlpha(const DrawingWand *wand)
465</pre>
466
467<p>A description of each parameter follows:</p>
468
469<dd>
470</dd>
471
472<dd> </dd>
473<dl class="dl-horizontal">
474<dt>wand</dt>
475<dd>the drawing wand. </dd>
476</dl>
477<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DrawPeekGraphicWand">DrawPeekGraphicWand</a></h2>
478
479<p>DrawPeekGraphicWand() returns the current drawing wand.</p>
480
481<p>The format of the PeekDrawingWand method is:</p>
482
483<pre class="text">
484DrawInfo *DrawPeekGraphicWand(const DrawingWand *wand)
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>wand</dt>
495<dd>the drawing wand. </dd>
496
497<dd> </dd>
498</dl>
499<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DrawPopGraphicContext">DrawPopGraphicContext</a></h2>
500
501<p>DrawPopGraphicContext() destroys the current drawing wand and returns to the previously pushed drawing wand. Multiple drawing wands may exist. It is an error to attempt to pop more drawing wands than have been pushed, and it is proper form to pop all drawing wands which have been pushed.</p>
502
503<p>The format of the DrawPopGraphicContext method is:</p>
504
505<pre class="text">
506MagickBooleanType DrawPopGraphicContext(DrawingWand *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 drawing wand. </dd>
518
519<dd> </dd>
520</dl>
521<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DrawPushGraphicContext">DrawPushGraphicContext</a></h2>
522
523<p>DrawPushGraphicContext() clones the current drawing wand to create a new drawing wand. The original drawing wand(s) may be returned to by invoking PopDrawingWand(). The drawing wands are stored on a drawing wand stack. For every Pop there must have already been an equivalent Push.</p>
524
525<p>The format of the DrawPushGraphicContext method is:</p>
526
527<pre class="text">
528MagickBooleanType DrawPushGraphicContext(DrawingWand *wand)
529</pre>
530
531<p>A description of each parameter follows:</p>
532
533<dd>
534</dd>
535
536<dd> </dd>
537<dl class="dl-horizontal">
538<dt>wand</dt>
539<dd>the drawing wand. </dd>
540
541<dd> </dd>
542</dl>
543<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DrawSetFillAlpha">DrawSetFillAlpha</a></h2>
544
545<p>DrawSetFillAlpha() sets the alpha to use when drawing using the fill color or fill texture. Fully opaque is 1.0.</p>
546
547<p>The format of the DrawSetFillAlpha method is:</p>
548
549<pre class="text">
550void DrawSetFillAlpha(DrawingWand *wand,const double fill_alpha)
551</pre>
552
553<p>A description of each parameter follows:</p>
554
555<dd>
556</dd>
557
558<dd> </dd>
559<dl class="dl-horizontal">
560<dt>wand</dt>
561<dd>the drawing wand. </dd>
562
563<dd> </dd>
564<dt>fill_alpha</dt>
565<dd>fill alpha </dd>
566
567<dd> </dd>
568</dl>
569<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="DrawSetStrokeAlpha">DrawSetStrokeAlpha</a></h2>
570
571<p>DrawSetStrokeAlpha() specifies the alpha of stroked object outlines.</p>
572
573<p>The format of the DrawSetStrokeAlpha method is:</p>
574
575<pre class="text">
576void DrawSetStrokeAlpha(DrawingWand *wand,const double stroke_alpha)
577</pre>
578
579<p>A description of each parameter follows:</p>
580
581<dd>
582</dd>
583
584<dd> </dd>
585<dl class="dl-horizontal">
586<dt>wand</dt>
587<dd>the drawing wand. </dd>
588
589<dd> </dd>
590<dt>stroke_alpha</dt>
591<dd>stroke alpha. The value 1.0 is opaque. </dd>
592
593<dd> </dd>
594</dl>
595<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickColorFloodfillImage">MagickColorFloodfillImage</a></h2>
596
597<p>MagickColorFloodfillImage() changes the color value of any pixel that matches target and is an immediate neighbor. If the method FillToBorderMethod is specified, the color value is changed for any neighbor pixel that does not match the bordercolor member of image.</p>
598
599<p>The format of the MagickColorFloodfillImage method is:</p>
600
601<pre class="text">
602MagickBooleanType MagickColorFloodfillImage(MagickWand *wand,
603 const PixelWand *fill,const double fuzz,const PixelWand *bordercolor,
604 const ssize_t x,const ssize_t y)
605</pre>
606
607<p>A description of each parameter follows:</p>
608
609<dd>
610</dd>
611
612<dd> </dd>
613<dl class="dl-horizontal">
614<dt>wand</dt>
615<dd>the magick wand. </dd>
616
617<dd> </dd>
618<dt>fill</dt>
619<dd>the floodfill color pixel wand. </dd>
620
621<dd> </dd>
622<dt>fuzz</dt>
623<dd>By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill. </dd>
624
625<dd> </dd>
626<dt>bordercolor</dt>
627<dd>the border color pixel wand. </dd>
628
629<dd> </dd>
630<dt>x,y</dt>
631<dd>the starting location of the operation. </dd>
632
633<dd> </dd>
634</dl>
635<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickDescribeImage">MagickDescribeImage</a></h2>
636
637<p>MagickDescribeImage() identifies an image by printing its attributes to the file. Attributes include the image width, height, size, and others.</p>
638
639<p>The format of the MagickDescribeImage method is:</p>
640
641<pre class="text">
642const char *MagickDescribeImage(MagickWand *wand)
643</pre>
644
645<p>A description of each parameter follows:</p>
646
647<dd>
648</dd>
649
650<dd> </dd>
651<dl class="dl-horizontal">
652<dt>wand</dt>
653<dd>the magick wand. </dd>
654
655<dd> </dd>
656</dl>
657<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickFlattenImages">MagickFlattenImages</a></h2>
658
659<p>MagickFlattenImages() merges a sequence of images. This useful for combining Photoshop layers into a single image.</p>
660
661<p>The format of the MagickFlattenImages method is:</p>
662
663<pre class="text">
664MagickWand *MagickFlattenImages(MagickWand *wand)
665</pre>
666
667<p>A description of each parameter follows:</p>
668
669<dd>
670</dd>
671
672<dd> </dd>
673<dl class="dl-horizontal">
674<dt>wand</dt>
675<dd>the magick wand. </dd>
676
677<dd> </dd>
678</dl>
679<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickGetImageAttribute">MagickGetImageAttribute</a></h2>
680
681<p>MagickGetImageAttribute() returns a value associated with the specified property. Use MagickRelinquishMemory() to free the value when you are finished with it.</p>
682
683<p>The format of the MagickGetImageAttribute method is:</p>
684
685<pre class="text">
686char *MagickGetImageAttribute(MagickWand *wand,const char *property)
687</pre>
688
689<p>A description of each parameter follows:</p>
690
691<dd>
692</dd>
693
694<dd> </dd>
695<dl class="dl-horizontal">
696<dt>wand</dt>
697<dd>the magick wand. </dd>
698
699<dd> </dd>
700<dt>property</dt>
701<dd>the property. </dd>
702
703<dd> </dd>
704</dl>
705<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickGetImageMatte">MagickGetImageMatte</a></h2>
706
707<p>MagickGetImageMatte() returns MagickTrue if the image has a matte channel otherwise MagickFalse.</p>
708
709<p>The format of the MagickGetImageMatte method is:</p>
710
711<pre class="text">
712size_t MagickGetImageMatte(MagickWand *wand)
713</pre>
714
715<p>A description of each parameter follows:</p>
716
717<dd>
718</dd>
719
720<dd> </dd>
721<dl class="dl-horizontal">
722<dt>wand</dt>
723<dd>the magick wand. </dd>
724
725<dd> </dd>
726</dl>
727<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickGetImagePixels">MagickGetImagePixels</a></h2>
728
729<p>MagickGetImagePixels() extracts pixel data from an image and returns it to you. The method returns MagickTrue on success otherwise MagickFalse if an error is encountered. The data is returned as char, short int, int, ssize_t, float, or double in the order specified by map.</p>
730
731<p>Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:</p>
732
733<pre class="text">
734MagickGetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
735</pre>
736
737<p>The format of the MagickGetImagePixels method is:</p>
738
739<pre class="text">
740MagickBooleanType MagickGetImagePixels(MagickWand *wand,
741 const ssize_t x,const ssize_t y,const size_t columns,
742 const size_t rows,const char *map,const StorageType storage,
743 void *pixels)
744</pre>
745
746<p>A description of each parameter follows:</p>
747
748<dd>
749</dd>
750
751<dd> </dd>
752<dl class="dl-horizontal">
753<dt>wand</dt>
754<dd>the magick wand. </dd>
755
756<dd> </dd>
757<dt>x, y, columns, rows</dt>
758<dd> These values define the perimeter of a region of pixels you want to extract. </dd>
759
760<dd> </dd>
761<dt>map</dt>
762<dd> This string reflects the expected ordering of the pixel array. It can be any combination or order of R = red, G = green, B = blue, A = alpha (0 is transparent), O = opacity (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I = intensity (for grayscale), P = pad. </dd>
763
764<dd> </dd>
765<dt>storage</dt>
766<dd>Define the data type of the pixels. Float and double types are expected to be normalized [0..1] otherwise [0..QuantumRange]. Choose from these types: CharPixel, DoublePixel, FloatPixel, IntegerPixel, LongPixel, QuantumPixel, or ShortPixel. </dd>
767
768<dd> </dd>
769<dt>pixels</dt>
770<dd>This array of values contain the pixel components as defined by map and type. You must preallocate this array where the expected length varies depending on the values of width, height, map, and type. </dd>
771
772<dd> </dd>
773</dl>
774<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickGetImageSize">MagickGetImageSize</a></h2>
775
776<p>MagickGetImageSize() returns the image length in bytes.</p>
777
778<p>The format of the MagickGetImageSize method is:</p>
779
780<pre class="text">
781MagickBooleanType MagickGetImageSize(MagickWand *wand,
782 MagickSizeType *length)
783</pre>
784
785<p>A description of each parameter follows:</p>
786
787<dd>
788</dd>
789
790<dd> </dd>
791<dl class="dl-horizontal">
792<dt>wand</dt>
793<dd>the magick wand. </dd>
794
795<dd> </dd>
796<dt>length</dt>
797<dd>the image length in bytes. </dd>
798
799<dd> </dd>
800</dl>
801<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickMapImage">MagickMapImage</a></h2>
802
803<p>MagickMapImage() replaces the colors of an image with the closest color from a reference image.</p>
804
805<p>The format of the MagickMapImage method is:</p>
806
807<pre class="text">
808MagickBooleanType MagickMapImage(MagickWand *wand,
809 const MagickWand *map_wand,const MagickBooleanType dither)
810</pre>
811
812<p>A description of each parameter follows:</p>
813
814<dd>
815</dd>
816
817<dd> </dd>
818<dl class="dl-horizontal">
819<dt>wand</dt>
820<dd>the magick wand. </dd>
821
822<dd> </dd>
823<dt>map</dt>
824<dd>the map wand. </dd>
825
826<dd> </dd>
827<dt>dither</dt>
828<dd>Set this integer value to something other than zero to dither the mapped image. </dd>
829
830<dd> </dd>
831</dl>
832<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickMatteFloodfillImage">MagickMatteFloodfillImage</a></h2>
833
834<p>MagickMatteFloodfillImage() changes the transparency value of any pixel that matches target and is an immediate neighbor. If the method FillToBorderMethod is specified, the transparency value is changed for any neighbor pixel that does not match the bordercolor member of image.</p>
835
836<p>The format of the MagickMatteFloodfillImage method is:</p>
837
838<pre class="text">
839MagickBooleanType MagickMatteFloodfillImage(MagickWand *wand,
840 const double alpha,const double fuzz,const PixelWand *bordercolor,
841 const ssize_t x,const ssize_t y)
842</pre>
843
844<p>A description of each parameter follows:</p>
845
846<dd>
847</dd>
848
849<dd> </dd>
850<dl class="dl-horizontal">
851<dt>wand</dt>
852<dd>the magick wand. </dd>
853
854<dd> </dd>
855<dt>alpha</dt>
856<dd>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent. </dd>
857
858<dd> </dd>
859<dt>fuzz</dt>
860<dd>By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill. </dd>
861
862<dd> </dd>
863<dt>bordercolor</dt>
864<dd>the border color pixel wand. </dd>
865
866<dd> </dd>
867<dt>x,y</dt>
868<dd>the starting location of the operation. </dd>
869
870<dd> </dd>
871</dl>
872<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickMedianFilterImage">MagickMedianFilterImage</a></h2>
873
874<p>MagickMedianFilterImage() applies a digital filter that improves the quality of a noisy image. Each pixel is replaced by the median in a set of neighboring pixels as defined by radius.</p>
875
876<p>The format of the MagickMedianFilterImage method is:</p>
877
878<pre class="text">
879MagickBooleanType MagickMedianFilterImage(MagickWand *wand,
880 const double radius)
881</pre>
882
883<p>A description of each parameter follows:</p>
884
885<dd>
886</dd>
887
888<dd> </dd>
889<dl class="dl-horizontal">
890<dt>wand</dt>
891<dd>the magick wand. </dd>
892
893<dd> </dd>
894<dt>radius</dt>
895<dd>the radius of the pixel neighborhood. </dd>
896
897<dd> </dd>
898</dl>
899<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickMinimumImages">MagickMinimumImages</a></h2>
900
901<p>MagickMinimumImages() returns the minimum intensity of an image sequence.</p>
902
903<p>The format of the MagickMinimumImages method is:</p>
904
905<pre class="text">
906MagickWand *MagickMinimumImages(MagickWand *wand)
907</pre>
908
909<p>A description of each parameter follows:</p>
910
911<dd>
912</dd>
913
914<dd> </dd>
915<dl class="dl-horizontal">
916<dt>wand</dt>
917<dd>the magick wand. </dd>
918
919<dd> </dd>
920</dl>
921<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickModeImage">MagickModeImage</a></h2>
922
923<p>MagickModeImage() makes each pixel the 'predominant color' of the neighborhood of the specified radius.</p>
924
925<p>The format of the MagickModeImage method is:</p>
926
927<pre class="text">
928MagickBooleanType MagickModeImage(MagickWand *wand,
929 const double radius)
930</pre>
931
932<p>A description of each parameter follows:</p>
933
934<dd>
935</dd>
936
937<dd> </dd>
938<dl class="dl-horizontal">
939<dt>wand</dt>
940<dd>the magick wand. </dd>
941
942<dd> </dd>
943<dt>radius</dt>
944<dd>the radius of the pixel neighborhood. </dd>
945
946<dd> </dd>
947</dl>
948<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickMosaicImages">MagickMosaicImages</a></h2>
949
950<p>MagickMosaicImages() inlays an image sequence to form a single coherent picture. It returns a wand with each image in the sequence composited at the location defined by the page offset of the image.</p>
951
952<p>The format of the MagickMosaicImages method is:</p>
953
954<pre class="text">
955MagickWand *MagickMosaicImages(MagickWand *wand)
956</pre>
957
958<p>A description of each parameter follows:</p>
959
960<dd>
961</dd>
962
963<dd> </dd>
964<dl class="dl-horizontal">
965<dt>wand</dt>
966<dd>the magick wand. </dd>
967
968<dd> </dd>
969</dl>
970<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickOpaqueImage">MagickOpaqueImage</a></h2>
971
972<p>MagickOpaqueImage() changes any pixel that matches color with the color defined by fill.</p>
973
974<p>The format of the MagickOpaqueImage method is:</p>
975
976<pre class="text">
977MagickBooleanType MagickOpaqueImage(MagickWand *wand,
978 const PixelWand *target,const PixelWand *fill,const double fuzz)
979</pre>
980
981<p>A description of each parameter follows:</p>
982
983<dd>
984</dd>
985
986<dd> </dd>
987<dl class="dl-horizontal">
988<dt>wand</dt>
989<dd>the magick wand. </dd>
990
991<dd> </dd>
992<dt>channel</dt>
993<dd>the channel(s). </dd>
994
995<dd> </dd>
996<dt>target</dt>
997<dd>Change this target color to the fill color within the image. </dd>
998
999<dd> </dd>
1000<dt>fill</dt>
1001<dd>the fill pixel wand. </dd>
1002
1003<dd> </dd>
1004<dt>fuzz</dt>
1005<dd>By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill. </dd>
1006
1007<dd> </dd>
1008</dl>
1009<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickPaintFloodfillImage">MagickPaintFloodfillImage</a></h2>
1010
1011<p>MagickPaintFloodfillImage() changes the color value of any pixel that matches target and is an immediate neighbor. If the method FillToBorderMethod is specified, the color value is changed for any neighbor pixel that does not match the bordercolor member of image.</p>
1012
1013<p>The format of the MagickPaintFloodfillImage method is:</p>
1014
1015<pre class="text">
1016MagickBooleanType MagickPaintFloodfillImage(MagickWand *wand,
1017 const ChannelType channel,const PixelWand *fill,const double fuzz,
1018 const PixelWand *bordercolor,const ssize_t x,const ssize_t y)
1019</pre>
1020
1021<p>A description of each parameter follows:</p>
1022
1023<dd>
1024</dd>
1025
1026<dd> </dd>
1027<dl class="dl-horizontal">
1028<dt>wand</dt>
1029<dd>the magick wand. </dd>
1030
1031<dd> </dd>
1032<dt>channel</dt>
1033<dd>the channel(s). </dd>
1034
1035<dd> </dd>
1036<dt>fill</dt>
1037<dd>the floodfill color pixel wand. </dd>
1038
1039<dd> </dd>
1040<dt>fuzz</dt>
1041<dd>By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill. </dd>
1042
1043<dd> </dd>
1044<dt>bordercolor</dt>
1045<dd>the border color pixel wand. </dd>
1046
1047<dd> </dd>
1048<dt>x,y</dt>
1049<dd>the starting location of the operation. </dd>
1050
1051<dd> </dd>
1052</dl>
1053<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickPaintOpaqueImage">MagickPaintOpaqueImage</a></h2>
1054
1055<p>MagickPaintOpaqueImage() changes any pixel that matches color with the color defined by fill.</p>
1056
1057<p>The format of the MagickPaintOpaqueImage method is:</p>
1058
1059<pre class="text">
1060MagickBooleanType MagickPaintOpaqueImage(MagickWand *wand,
1061 const PixelWand *target,const PixelWand *fill,const double fuzz)
1062MagickBooleanType MagickPaintOpaqueImageChannel(MagickWand *wand,
1063 const ChannelType channel,const PixelWand *target,
1064 const PixelWand *fill,const double fuzz)
1065</pre>
1066
1067<p>A description of each parameter follows:</p>
1068
1069<dd>
1070</dd>
1071
1072<dd> </dd>
1073<dl class="dl-horizontal">
1074<dt>wand</dt>
1075<dd>the magick wand. </dd>
1076
1077<dd> </dd>
1078<dt>channel</dt>
1079<dd>the channel(s). </dd>
1080
1081<dd> </dd>
1082<dt>target</dt>
1083<dd>Change this target color to the fill color within the image. </dd>
1084
1085<dd> </dd>
1086<dt>fill</dt>
1087<dd>the fill pixel wand. </dd>
1088
1089<dd> </dd>
1090<dt>fuzz</dt>
1091<dd>By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill. </dd>
1092
1093<dd> </dd>
1094</dl>
1095<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickPaintTransparentImage">MagickPaintTransparentImage</a></h2>
1096
1097<p>MagickPaintTransparentImage() changes any pixel that matches color with the color defined by fill.</p>
1098
1099<p>The format of the MagickPaintTransparentImage method is:</p>
1100
1101<pre class="text">
1102MagickBooleanType MagickPaintTransparentImage(MagickWand *wand,
1103 const PixelWand *target,const double alpha,const double fuzz)
1104</pre>
1105
1106<p>A description of each parameter follows:</p>
1107
1108<dd>
1109</dd>
1110
1111<dd> </dd>
1112<dl class="dl-horizontal">
1113<dt>wand</dt>
1114<dd>the magick wand. </dd>
1115
1116<dd> </dd>
1117<dt>target</dt>
1118<dd>Change this target color to specified opacity value within the image. </dd>
1119
1120<dd> </dd>
1121<dt>alpha</dt>
1122<dd>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent. </dd>
1123
1124<dd> </dd>
1125<dt>fuzz</dt>
1126<dd>By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill. </dd>
1127
1128<dd> </dd>
1129</dl>
1130<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickRadialBlurImage">MagickRadialBlurImage</a></h2>
1131
1132<p>MagickRadialBlurImage() radial blurs an image.</p>
1133
1134<p>The format of the MagickRadialBlurImage method is:</p>
1135
1136<pre class="text">
1137MagickBooleanType MagickRadialBlurImage(MagickWand *wand,
1138 const double angle)
1139MagickBooleanType MagickRadialBlurImageChannel(MagickWand *wand,
1140 const ChannelType channel,const double angle)
1141</pre>
1142
1143<p>A description of each parameter follows:</p>
1144
1145<dd>
1146</dd>
1147
1148<dd> </dd>
1149<dl class="dl-horizontal">
1150<dt>wand</dt>
1151<dd>the magick wand. </dd>
1152
1153<dd> </dd>
1154<dt>channel</dt>
1155<dd>the image channel(s). </dd>
1156
1157<dd> </dd>
1158<dt>angle</dt>
1159<dd>the angle of the blur in degrees. </dd>
1160
1161<dd> </dd>
1162</dl>
1163<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickRecolorImage">MagickRecolorImage</a></h2>
1164
1165<p>MagickRecolorImage() apply color transformation to an image. The method permits saturation changes, hue rotation, luminance to alpha, and various other effects. Although variable-sized transformation matrices can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6 for CMYKA (or RGBA with offsets). The matrix is similar to those used by Adobe Flash except offsets are in column 6 rather than 5 (in support of CMYKA images) and offsets are normalized (divide Flash offset by 255).</p>
1166
1167<p>The format of the MagickRecolorImage method is:</p>
1168
1169<pre class="text">
1170MagickBooleanType MagickRecolorImage(MagickWand *wand,
1171 const size_t order,const double *color_matrix)
1172</pre>
1173
1174<p>A description of each parameter follows:</p>
1175
1176<dd>
1177</dd>
1178
1179<dd> </dd>
1180<dl class="dl-horizontal">
1181<dt>wand</dt>
1182<dd>the magick wand. </dd>
1183
1184<dd> </dd>
1185<dt>order</dt>
1186<dd>the number of columns and rows in the color matrix. </dd>
1187
1188<dd> </dd>
1189<dt>color_matrix</dt>
1190<dd>An array of doubles representing the color matrix. </dd>
1191
1192<dd> </dd>
1193</dl>
1194<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickReduceNoiseImage">MagickReduceNoiseImage</a></h2>
1195
1196<p>MagickReduceNoiseImage() smooths the contours of an image while still preserving edge information. The algorithm works by replacing each pixel with its neighbor closest in value. A neighbor is defined by radius. Use a radius of 0 and ReduceNoise() selects a suitable radius for you.</p>
1197
1198<p>The format of the MagickReduceNoiseImage method is:</p>
1199
1200<pre class="text">
1201MagickBooleanType MagickReduceNoiseImage(MagickWand *wand,
1202 const double radius)
1203</pre>
1204
1205<p>A description of each parameter follows:</p>
1206
1207<dd>
1208</dd>
1209
1210<dd> </dd>
1211<dl class="dl-horizontal">
1212<dt>wand</dt>
1213<dd>the magick wand. </dd>
1214
1215<dd> </dd>
1216<dt>radius</dt>
1217<dd>the radius of the pixel neighborhood. </dd>
1218
1219<dd> </dd>
1220</dl>
1221<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickMaximumImages">MagickMaximumImages</a></h2>
1222
1223<p>MagickMaximumImages() returns the maximum intensity of an image sequence.</p>
1224
1225<p>The format of the MagickMaximumImages method is:</p>
1226
1227<pre class="text">
1228MagickWand *MagickMaximumImages(MagickWand *wand)
1229</pre>
1230
1231<p>A description of each parameter follows:</p>
1232
1233<dd>
1234</dd>
1235
1236<dd> </dd>
1237<dl class="dl-horizontal">
1238<dt>wand</dt>
1239<dd>the magick wand. </dd>
1240
1241<dd> </dd>
1242</dl>
1243<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickSetImageAttribute">MagickSetImageAttribute</a></h2>
1244
1245<p>MagickSetImageAttribute() associates a property with an image.</p>
1246
1247<p>The format of the MagickSetImageAttribute method is:</p>
1248
1249<pre class="text">
1250MagickBooleanType MagickSetImageAttribute(MagickWand *wand,
1251 const char *property,const char *value)
1252</pre>
1253
1254<p>A description of each parameter follows:</p>
1255
1256<dd>
1257</dd>
1258
1259<dd> </dd>
1260<dl class="dl-horizontal">
1261<dt>wand</dt>
1262<dd>the magick wand. </dd>
1263
1264<dd> </dd>
1265<dt>property</dt>
1266<dd>the property. </dd>
1267
1268<dd> </dd>
1269<dt>value</dt>
1270<dd>the value. </dd>
1271
1272<dd> </dd>
1273</dl>
1274<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickSetImageIndex">MagickSetImageIndex</a></h2>
1275
1276<p>MagickSetImageIndex() set the current image to the position of the list specified with the index parameter.</p>
1277
1278<p>The format of the MagickSetImageIndex method is:</p>
1279
1280<pre class="text">
1281MagickBooleanType MagickSetImageIndex(MagickWand *wand,
1282 const ssize_t index)
1283</pre>
1284
1285<p>A description of each parameter follows:</p>
1286
1287<dd>
1288</dd>
1289
1290<dd> </dd>
1291<dl class="dl-horizontal">
1292<dt>wand</dt>
1293<dd>the magick wand. </dd>
1294
1295<dd> </dd>
1296<dt>index</dt>
1297<dd>the scene number. </dd>
1298
1299<dd> </dd>
1300</dl>
1301<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickTransparentImage">MagickTransparentImage</a></h2>
1302
1303<p>MagickTransparentImage() changes any pixel that matches color with the color defined by fill.</p>
1304
1305<p>The format of the MagickTransparentImage method is:</p>
1306
1307<pre class="text">
1308MagickBooleanType MagickTransparentImage(MagickWand *wand,
1309 const PixelWand *target,const double alpha,const double fuzz)
1310</pre>
1311
1312<p>A description of each parameter follows:</p>
1313
1314<dd>
1315</dd>
1316
1317<dd> </dd>
1318<dl class="dl-horizontal">
1319<dt>wand</dt>
1320<dd>the magick wand. </dd>
1321
1322<dd> </dd>
1323<dt>target</dt>
1324<dd>Change this target color to specified opacity value within the image. </dd>
1325
1326<dd> </dd>
1327<dt>alpha</dt>
1328<dd>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent. </dd>
1329
1330<dd> </dd>
1331<dt>fuzz</dt>
1332<dd>By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill. </dd>
1333
1334<dd> </dd>
1335</dl>
1336<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickRegionOfInterestImage">MagickRegionOfInterestImage</a></h2>
1337
1338<p>MagickRegionOfInterestImage() extracts a region of the image and returns it as a new wand.</p>
1339
1340<p>The format of the MagickRegionOfInterestImage method is:</p>
1341
1342<pre class="text">
1343MagickWand *MagickRegionOfInterestImage(MagickWand *wand,
1344 const size_t width,const size_t height,const ssize_t x,
1345 const ssize_t y)
1346</pre>
1347
1348<p>A description of each parameter follows:</p>
1349
1350<dd>
1351</dd>
1352
1353<dd> </dd>
1354<dl class="dl-horizontal">
1355<dt>wand</dt>
1356<dd>the magick wand. </dd>
1357
1358<dd> </dd>
1359<dt>width</dt>
1360<dd>the region width. </dd>
1361
1362<dd> </dd>
1363<dt>height</dt>
1364<dd>the region height. </dd>
1365
1366<dd> </dd>
1367<dt>x</dt>
1368<dd>the region x offset. </dd>
1369
1370<dd> </dd>
1371<dt>y</dt>
1372<dd>the region y offset. </dd>
1373
1374<dd> </dd>
1375</dl>
1376<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickSetImagePixels">MagickSetImagePixels</a></h2>
1377
1378<p>MagickSetImagePixels() accepts pixel datand stores it in the image at the location you specify. The method returns MagickFalse on success otherwise MagickTrue if an error is encountered. The pixel data can be either char, short int, int, ssize_t, float, or double in the order specified by map.</p>
1379
1380<p>Suppose your want to upload the first scanline of a 640x480 image from character data in red-green-blue order:</p>
1381
1382<pre class="text">
1383MagickSetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
1384</pre>
1385
1386<p>The format of the MagickSetImagePixels method is:</p>
1387
1388<pre class="text">
1389MagickBooleanType MagickSetImagePixels(MagickWand *wand,
1390 const ssize_t x,const ssize_t y,const size_t columns,
1391 const size_t rows,const char *map,const StorageType storage,
1392 const void *pixels)
1393</pre>
1394
1395<p>A description of each parameter follows:</p>
1396
1397<dd>
1398</dd>
1399
1400<dd> </dd>
1401<dl class="dl-horizontal">
1402<dt>wand</dt>
1403<dd>the magick wand. </dd>
1404
1405<dd> </dd>
1406<dt>x, y, columns, rows</dt>
1407<dd> These values define the perimeter of a region of pixels you want to define. </dd>
1408
1409<dd> </dd>
1410<dt>map</dt>
1411<dd> This string reflects the expected ordering of the pixel array. It can be any combination or order of R = red, G = green, B = blue, A = alpha (0 is transparent), O = opacity (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I = intensity (for grayscale), P = pad. </dd>
1412
1413<dd> </dd>
1414<dt>storage</dt>
1415<dd>Define the data type of the pixels. Float and double types are expected to be normalized [0..1] otherwise [0..QuantumRange]. Choose from these types: CharPixel, ShortPixel, IntegerPixel, LongPixel, FloatPixel, or DoublePixel. </dd>
1416
1417<dd> </dd>
1418<dt>pixels</dt>
1419<dd>This array of values contain the pixel components as defined by map and type. You must preallocate this array where the expected length varies depending on the values of width, height, map, and type. </dd>
1420
1421<dd> </dd>
1422</dl>
1423<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="MagickWriteImageBlob">MagickWriteImageBlob</a></h2>
1424
1425<p>MagickWriteImageBlob() implements direct to memory image formats. It returns the image as a blob and its length. Use MagickSetFormat() to set the format of the returned blob (GIF, JPEG, PNG, etc.).</p>
1426
1427<p>Use MagickRelinquishMemory() to free the blob when you are done with it.</p>
1428
1429<p>The format of the MagickWriteImageBlob method is:</p>
1430
1431<pre class="text">
1432unsigned char *MagickWriteImageBlob(MagickWand *wand,size_t *length)
1433</pre>
1434
1435<p>A description of each parameter follows:</p>
1436
1437<dd>
1438</dd>
1439
1440<dd> </dd>
1441<dl class="dl-horizontal">
1442<dt>wand</dt>
1443<dd>the magick wand. </dd>
1444
1445<dd> </dd>
1446<dt>length</dt>
1447<dd>the length of the blob. </dd>
1448
1449<dd> </dd>
1450</dl>
1451<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="NewPixelView">NewPixelView</a></h2>
1452
1453<p>NewPixelView() returns a pixel view required for all other methods in the Pixel View API.</p>
1454
1455<p>The format of the NewPixelView method is:</p>
1456
1457<pre class="text">
1458PixelView *NewPixelView(MagickWand *wand)
1459</pre>
1460
1461<p>A description of each parameter follows:</p>
1462
1463<dd>
1464</dd>
1465
1466<dd> </dd>
1467<dl class="dl-horizontal">
1468<dt>wand</dt>
1469<dd>the wand. </dd>
1470
1471<dd> </dd>
1472</dl>
1473<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="NewPixelViewRegion">NewPixelViewRegion</a></h2>
1474
1475<p>NewPixelViewRegion() returns a pixel view required for all other methods in the Pixel View API.</p>
1476
1477<p>The format of the NewPixelViewRegion method is:</p>
1478
1479<pre class="text">
1480PixelView *NewPixelViewRegion(MagickWand *wand,const ssize_t x,
1481 const ssize_t y,const size_t width,const size_t height)
1482</pre>
1483
1484<p>A description of each parameter follows:</p>
1485
1486<dd>
1487</dd>
1488
1489<dd> </dd>
1490<dl class="dl-horizontal">
1491<dt>wand</dt>
1492<dd>the magick wand. </dd>
1493
1494<dd> </dd>
1495<dt>x,y,columns,rows</dt>
1496<dd> These values define the perimeter of a region of pixel_wands view. </dd>
1497
1498<dd> </dd>
1499</dl>
1500<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="PixelGetNextRow">PixelGetNextRow</a></h2>
1501
1502<p>PixelGetNextRow() returns the next row as an array of pixel wands from the pixel iterator.</p>
1503
1504<p>The format of the PixelGetNextRow method is:</p>
1505
1506<pre class="text">
1507PixelWand **PixelGetNextRow(PixelIterator *iterator,
1508 size_t *number_wands)
1509</pre>
1510
1511<p>A description of each parameter follows:</p>
1512
1513<dd>
1514</dd>
1515
1516<dd> </dd>
1517<dl class="dl-horizontal">
1518<dt>iterator</dt>
1519<dd>the pixel iterator. </dd>
1520
1521<dd> </dd>
1522<dt>number_wands</dt>
1523<dd>the number of pixel wands. </dd>
1524
1525<dd> </dd>
1526</dl>
1527<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="PixelIteratorGetException">PixelIteratorGetException</a></h2>
1528
1529<p>PixelIteratorGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p>
1530
1531<p>The format of the PixelIteratorGetException method is:</p>
1532
1533<pre class="text">
1534char *PixelIteratorGetException(const Pixeliterator *iterator,
1535 ExceptionType *severity)
1536</pre>
1537
1538<p>A description of each parameter follows:</p>
1539
1540<dd>
1541</dd>
1542
1543<dd> </dd>
1544<dl class="dl-horizontal">
1545<dt>iterator</dt>
1546<dd>the pixel iterator. </dd>
1547
1548<dd> </dd>
1549<dt>severity</dt>
1550<dd>the severity of the error is returned here. </dd>
1551
1552<dd> </dd>
1553</dl>
1554<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="SetPixelViewIterator">SetPixelViewIterator</a></h2>
1555
1556<p>SetPixelViewIterator() iterates over the pixel view in parallel and calls your set method for each scanline of the view. The pixel region is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension. The pixels are initiallly undefined and any settings you make in the callback method are automagically synced back to your image.</p>
1557
1558<p>Use this pragma:</p>
1559
1560<pre class="text">
1561 #pragma omp critical
1562</pre>
1563
1564<p>to define a section of code in your callback set method that must be executed by a single thread at a time.</p>
1565
1566<p>The format of the SetPixelViewIterator method is:</p>
1567
1568<pre class="text">
1569MagickBooleanType SetPixelViewIterator(PixelView *destination,
1570 SetPixelViewMethod set,void *context)
1571</pre>
1572
1573<p>A description of each parameter follows:</p>
1574
1575<dd>
1576</dd>
1577
1578<dd> </dd>
1579<dl class="dl-horizontal">
1580<dt>destination</dt>
1581<dd>the pixel view. </dd>
1582
1583<dd> </dd>
1584<dt>set</dt>
1585<dd>the set callback method. </dd>
1586
1587<dd> </dd>
1588<dt>context</dt>
1589<dd>the user defined context. </dd>
1590
1591<dd> </dd>
1592</dl>
1593<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="TransferPixelViewIterator">TransferPixelViewIterator</a></h2>
1594
1595<p>TransferPixelViewIterator() iterates over two pixel views in parallel and calls your transfer method for each scanline of the view. The source pixel region 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 pixel view is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension are permitted.</p>
1596
1597<p>Use this pragma:</p>
1598
1599<pre class="text">
1600 #pragma omp critical
1601</pre>
1602
1603<p>to define a section of code in your callback transfer method that must be executed by a single thread at a time.</p>
1604
1605<p>The format of the TransferPixelViewIterator method is:</p>
1606
1607<pre class="text">
1608MagickBooleanType TransferPixelViewIterator(PixelView *source,
1609 PixelView *destination,TransferPixelViewMethod transfer,void *context)
1610</pre>
1611
1612<p>A description of each parameter follows:</p>
1613
1614<dd>
1615</dd>
1616
1617<dd> </dd>
1618<dl class="dl-horizontal">
1619<dt>source</dt>
1620<dd>the source pixel view. </dd>
1621
1622<dd> </dd>
1623<dt>destination</dt>
1624<dd>the destination pixel view. </dd>
1625
1626<dd> </dd>
1627<dt>transfer</dt>
1628<dd>the transfer callback method. </dd>
1629
1630<dd> </dd>
1631<dt>context</dt>
1632<dd>the user defined context. </dd>
1633
1634<dd> </dd>
1635</dl>
1636<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate_8c.html" id="UpdatePixelViewIterator">UpdatePixelViewIterator</a></h2>
1637
1638<p>UpdatePixelViewIterator() iterates over the pixel view in parallel and calls your update method for each scanline of the view. The pixel region 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>
1639
1640<p>Use this pragma:</p>
1641
1642<pre class="text">
1643 #pragma omp critical
1644</pre>
1645
1646<p>to define a section of code in your callback update method that must be executed by a single thread at a time.</p>
1647
1648<p>The format of the UpdatePixelViewIterator method is:</p>
1649
1650<pre class="text">
1651MagickBooleanType UpdatePixelViewIterator(PixelView *source,
1652 UpdatePixelViewMethod update,void *context)
1653</pre>
1654
1655<p>A description of each parameter follows:</p>
1656
1657<dd>
1658</dd>
1659
1660<dd> </dd>
1661<dl class="dl-horizontal">
1662<dt>source</dt>
1663<dd>the source pixel view. </dd>
1664
1665<dd> </dd>
1666<dt>update</dt>
1667<dd>the update callback method. </dd>
1668
1669<dd> </dd>
1670<dt>context</dt>
1671<dd>the user defined context. </dd>
1672
1673<dd> </dd>
1674</dl>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]1675</div>
1676 <footer class="magick-footer">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1677 <div class="magick-nav-item pull-left">
cristy38185362015-05-07 20:09:56 +0000[diff] [blame]1678 <a href="../support.html">Donate</a>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]1679 </div>
cristy38185362015-05-07 20:09:56 +0000[diff] [blame]1680 <p><a href="../sitemap.html">Sitemap</a> •
1681 <a href="../links.html">Related</a> •
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]1682 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Image Studio</a> •
cristyea2793e2015-05-31 16:52:26 +0000[diff] [blame^]1683 <a href="http://jqmagick.imagemagick.org/">JqMagick</a>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]1684</p>
1685 <p><a href="magick-deprecate.html#">Back to top</a> •
cristyea2793e2015-05-31 16:52:26 +0000[diff] [blame^]1686 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
cristyabed55c2015-05-06 17:07:00 +0000[diff] [blame]1687 <a href="http://www.imagemagick.org/script/contact.php">Contact Us</a></p>
cristya1890f02015-05-15 23:32:44 +0000[diff] [blame]1688 <p><small>© 1999-2015 ImageMagick Studio LLC</small></p>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]1689 </footer>
1690</div><!-- /.container -->
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]1691
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]1692 <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
cristy2f563d42015-05-06 23:36:51 +0000[diff] [blame]1693 <script src="../js/bootstrap.min.js"></script>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]1694 <script type="text/javascript">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1695 /* <![CDATA[ */
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]1696 (function() {
1697 var s = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0];
1698 s.type = 'text/javascript';
1699 s.async = true;
1700 s.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
1701 t.parentNode.insertBefore(s, t);
1702 })();
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]1703 /* ]]> */
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]1704 </script>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]1705</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]1706</body>
cristy5a367e42015-05-05 12:39:18 +0000[diff] [blame]1707</html>