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