Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 18f8ee4f880cde0219ebdef3f2afd83043a7907e / . / www / api / magick-property.html
blob: cc6250f9e8d0fb41d32f8603f814a3592ea82501 [file] [log] [blame]
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<head>
5 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
6 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
7 <style type="text/css" media="screen,projection"><!--
8 @import url("../../www/magick.css");
9 --></style>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]10 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
11 <title>ImageMagick: MagickWand, C API for ImageMagick: Property Methods</title>
12 <meta http-equiv="Content-Language" content="en-US"/>
13 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
14 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
15 <meta name="Generator" content="PHP"/>
16 <meta name="Keywords" content="magickwc, api, for, imagemagick:, property, methods, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
17 <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves. ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems. The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
18 <meta name="Rating" content="GENERAL"/>
19 <meta name="Robots" content="INDEX, FOLLOW"/>
20 <meta name="Generator" content="ImageMagick Studio LLC"/>
21 <meta name="Author" content="ImageMagick Studio LLC"/>
22 <meta name="Revisit-after" content="2 DAYS"/>
23 <meta name="Resource-type" content="document"/>
24 <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
25 <meta name="Distribution" content="Global"/>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]26</head>
27
28<body id="www-imagemagick-org">
29<div class="titlebar">
30<a href="../../index.html">
31 <img src="../../images/script.png" alt="[ImageMagick]"
32 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
33<a href="http://www.networkredux.com">
34 <img src="../../images/networkredux.png" alt="[sponsor]"
35 style="margin: 45px auto; border: 0px; float: left;" /></a>
36<a href="http://www.imagemagick.org/discourse-server/">
37 <img src="../../images/logo.jpg" alt=""
38 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
39<a href="../../index.html">
40 <img src="../../images/sprite.jpg" alt=""
41 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
42</div>
43
44<div class="eastbar">
45
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]46<div class="menu">
47 <a href="../../index.html">About ImageMagick</a>
48</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]49<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]50<div class="menu">
51 <a href="../../www/command-line-tools.html">Command-line Tools</a>
52</div>
53<div class="sub">
54 <a href="../../www/command-line-processing.html">Processing</a>
55</div>
56<div class="sub">
57 <a href="../../www/command-line-options.html">Options</a>
58</div>
59<div class="sub">
60 <a href="http://www.imagemagick.org/Usage/">Usage</a>
61</div>
62<div class="menu">
63 <a href="../../www/api.html">Program Interfaces</a>
64</div>
65<div class="sub">
66 <a href="../../www/magick-wand.html">MagickWand</a>
67</div>
68<div class="sub">
69 <a href="../../www/magick-core.html">MagickCore</a>
70</div>
71<div class="sub">
72 <a href="../../www/perl-magick.html">PerlMagick</a>
73</div>
74<div class="sub">
75 <a href="../../Magick++/">Magick++</a>
76</div>
77<div class="menu">
78 <a href="../../www/architecture.html">Architecture</a>
79</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]80<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81<div class="menu">
82 <a href="../../www/install-source.html">Install from Source</a>
83</div>
84<div class="sub">
85 <a href="../../www/install-source.html#unix">Unix</a>
86</div>
87<div class="sub">
88 <a href="../../www/install-source.html#windows">Windows</a>
89 </div>
90<div class="menu">
91 <a href="../../www/binary-releases.html">Binary Releases</a>
92</div>
93<div class="sub">
94 <a href="../../www/binary-releases.html#unix">Unix</a>
95</div>
96<div class="sub">
97 <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
98</div>
99<div class="sub">
100 <a href="../../www/binary-releases.html#windows">Windows</a>
101</div>
102<div class="menu">
103 <a href="../../www/resources.html">Resources</a>
104</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]105<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106<div class="menu">
107 <a href="../../www/download.html">Download</a>
108</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]109<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]110<div class="menu">
111 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
112</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]113<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114<div class="menu">
115 <a href="../../www/sitemap.html">Site Map</a>
116</div>
117<div class="sub">
118 <a href="../../www/links.html">Links</a>
119</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]120<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]121<div class="menu">
122 <a href="../../www/sponsors.html">Sponsors:</a>
123
124<div class="sponsbox">
125<div class="sponsor">
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]126 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristyc49f7992009-09-22 22:48:40 +0000[diff] [blame]127</div>
128<div class="sponsor">
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]129 <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
130</div>
131<div class="sponsor">
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]132 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
133</div>
134<div class="sponsor">
135 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
136</div>
137<div class="sponsor">
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]138 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
139</div>
140<div class="sponsor">
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]141 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201002010120 Buchhorn -->
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]142</div>
143</div>
144</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]145
146
147</div>
148
149<div class="main">
150
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]151<p class="navigation-index">[<a href="#MagickDeleteImageProperty">MagickDeleteImageProperty</a> &bull; <a href="#MagickDeleteOption">MagickDeleteOption</a> &bull; <a href="#MagickGetAntialias">MagickGetAntialias</a> &bull; <a href="#MagickGetBackgroundColor">MagickGetBackgroundColor</a> &bull; <a href="#MagickGetColorspace">MagickGetColorspace</a> &bull; <a href="#MagickGetCompression">MagickGetCompression</a> &bull; <a href="#MagickGetCompressionQuality">MagickGetCompressionQuality</a> &bull; <a href="#MagickGetCopyright">MagickGetCopyright</a> &bull; <a href="#MagickGetFilename">MagickGetFilename</a> &bull; <a href="#MagickGetFont">MagickGetFont</a> &bull; <a href="#MagickGetFormat">MagickGetFormat</a> &bull; <a href="#MagickGetGravity">MagickGetGravity</a> &bull; <a href="#MagickGetHomeURL">MagickGetHomeURL</a> &bull; <a href="#MagickGetImageProfile">MagickGetImageProfile</a> &bull; <a href="#MagickGetImageProfiles">MagickGetImageProfiles</a> &bull; <a href="#MagickGetImageProperty">MagickGetImageProperty</a> &bull; <a href="#MagickGetImageProperties">MagickGetImageProperties</a> &bull; <a href="#MagickGetInterlaceScheme">MagickGetInterlaceScheme</a> &bull; <a href="#MagickGetInterpolateMethod">MagickGetInterpolateMethod</a> &bull; <a href="#MagickGetOption">MagickGetOption</a> &bull; <a href="#MagickGetOptions">MagickGetOptions</a> &bull; <a href="#MagickGetOrientation">MagickGetOrientation</a> &bull; <a href="#MagickGetPackageName">MagickGetPackageName</a> &bull; <a href="#MagickGetPage">MagickGetPage</a> &bull; <a href="#MagickGetPointsize">MagickGetPointsize</a> &bull; <a href="#MagickGetQuantumDepth">MagickGetQuantumDepth</a> &bull; <a href="#MagickGetQuantumRange">MagickGetQuantumRange</a> &bull; <a href="#MagickGetReleaseDate">MagickGetReleaseDate</a> &bull; <a href="#MagickGetResource">MagickGetResource</a> &bull; <a href="#MagickGetResourceLimit">MagickGetResourceLimit</a> &bull; <a href="#MagickGetSamplingFactors">MagickGetSamplingFactors</a> &bull; <a href="#MagickGetSize">MagickGetSize</a> &bull; <a href="#MagickGetSizeOffset">MagickGetSizeOffset</a> &bull; <a href="#MagickGetType">MagickGetType</a> &bull; <a href="#MagickGetVersion">MagickGetVersion</a> &bull; <a href="#MagickProfileImage">MagickProfileImage</a> &bull; <a href="#MagickRemoveImageProfile">MagickRemoveImageProfile</a> &bull; <a href="#MagickSetAntialias">MagickSetAntialias</a> &bull; <a href="#MagickSetBackgroundColor">MagickSetBackgroundColor</a> &bull; <a href="#MagickSetColorspace">MagickSetColorspace</a> &bull; <a href="#MagickSetCompression">MagickSetCompression</a> &bull; <a href="#MagickSetCompressionQuality">MagickSetCompressionQuality</a> &bull; <a href="#MagickSetDepth">MagickSetDepth</a> &bull; <a href="#MagickSetFilename">MagickSetFilename</a> &bull; <a href="#MagickSetFont">MagickSetFont</a> &bull; <a href="#MagickSetFormat">MagickSetFormat</a> &bull; <a href="#MagickSetGravity">MagickSetGravity</a> &bull; <a href="#MagickSetImageProfile">MagickSetImageProfile</a> &bull; <a href="#MagickSetImageProperty">MagickSetImageProperty</a> &bull; <a href="#MagickSetInterlaceScheme">MagickSetInterlaceScheme</a> &bull; <a href="#MagickSetInterpolateMethod">MagickSetInterpolateMethod</a> &bull; <a href="#MagickSetOption">MagickSetOption</a> &bull; <a href="#MagickSetOrientation">MagickSetOrientation</a> &bull; <a href="#MagickSetPage">MagickSetPage</a> &bull; <a href="#MagickSetPassphrase">MagickSetPassphrase</a> &bull; <a href="#MagickSetPointsize">MagickSetPointsize</a> &bull; <a href="#MagickSetProgressMonitor">MagickSetProgressMonitor</a> &bull; <a href="#MagickSetResourceLimit">MagickSetResourceLimit</a> &bull; <a href="#MagickSetResolution">MagickSetResolution</a> &bull; <a href="#MagickSetSamplingFactors">MagickSetSamplingFactors</a> &bull; <a href="#MagickSetSize">MagickSetSize</a> &bull; <a href="#MagickSetSizeOffset">MagickSetSizeOffset</a> &bull; <a href="#MagickSetType">MagickSetType</a>]</p>
152
153<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
154_8c.html" target="source" name="MagickDeleteImageProperty">MagickDeleteImageProperty</a></h2>
155<div class="doc-section">
156
157<p>MagickDeleteImageProperty() deletes a wand property.</p></ol>
158
159<p>The format of the MagickDeleteImageProperty method is:</p>
160
161<pre class="code">
162 MagickBooleanType MagickDeleteImageProperty(MagickWand *wand,
163 const char *property)
164</pre>
165
166<p>A description of each parameter follows:</p></ol>
167
168<h5>image</h5>
169<ol><p>the image.</p></ol>
170
171<h5>property</h5>
172<ol><p>the image property.</p></ol>
173
174 </div>
175<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
176_8c.html" target="source" name="MagickDeleteOption">MagickDeleteOption</a></h2>
177<div class="doc-section">
178
179<p>MagickDeleteOption() deletes a wand option.</p></ol>
180
181<p>The format of the MagickDeleteOption method is:</p>
182
183<pre class="code">
184 MagickBooleanType MagickDeleteOption(MagickWand *wand,
185 const char *option)
186</pre>
187
188<p>A description of each parameter follows:</p></ol>
189
190<h5>image</h5>
191<ol><p>the image.</p></ol>
192
193<h5>option</h5>
194<ol><p>the image option.</p></ol>
195
196 </div>
197<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
198_8c.html" target="source" name="MagickGetAntialias">MagickGetAntialias</a></h2>
199<div class="doc-section">
200
201<p>MagickGetAntialias() returns the antialias property associated with the wand.</p></ol>
202
203<p>The format of the MagickGetAntialias method is:</p>
204
205<pre class="code">
206 MagickBooleanType MagickGetAntialias(const MagickWand *wand)
207</pre>
208
209<p>A description of each parameter follows:</p></ol>
210
211<h5>wand</h5>
212<ol><p>the magick wand.</p></ol>
213
214 </div>
215<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
216_8c.html" target="source" name="MagickGetBackgroundColor">MagickGetBackgroundColor</a></h2>
217<div class="doc-section">
218
219<p>MagickGetBackgroundColor() returns the wand background color.</p></ol>
220
221<p>The format of the MagickGetBackgroundColor method is:</p>
222
223<pre class="code">
224 PixelWand *MagickGetBackgroundColor(MagickWand *wand)
225</pre>
226
227<p>A description of each parameter follows:</p></ol>
228
229<h5>wand</h5>
230<ol><p>the magick wand.</p></ol>
231
232 </div>
233<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
234_8c.html" target="source" name="MagickGetColorspace">MagickGetColorspace</a></h2>
235<div class="doc-section">
236
237<p>MagickGetColorspace() gets the wand colorspace type.</p></ol>
238
239<p>The format of the MagickGetColorspace method is:</p>
240
241<pre class="code">
242 ColorspaceType MagickGetColorspace(MagickWand *wand)
243</pre>
244
245<p>A description of each parameter follows:</p></ol>
246
247<h5>wand</h5>
248<ol><p>the magick wand.</p></ol>
249
250 </div>
251<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
252_8c.html" target="source" name="MagickGetCompression">MagickGetCompression</a></h2>
253<div class="doc-section">
254
255<p>MagickGetCompression() gets the wand compression type.</p></ol>
256
257<p>The format of the MagickGetCompression method is:</p>
258
259<pre class="code">
260 CompressionType MagickGetCompression(MagickWand *wand)
261</pre>
262
263<p>A description of each parameter follows:</p></ol>
264
265<h5>wand</h5>
266<ol><p>the magick wand.</p></ol>
267
268 </div>
269<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
270_8c.html" target="source" name="MagickGetCompressionQuality">MagickGetCompressionQuality</a></h2>
271<div class="doc-section">
272
273<p>MagickGetCompressionQuality() gets the wand compression quality.</p></ol>
274
275<p>The format of the MagickGetCompressionQuality method is:</p>
276
277<pre class="code">
278 unsigned long MagickGetCompressionQuality(MagickWand *wand)
279</pre>
280
281<p>A description of each parameter follows:</p></ol>
282
283<h5>wand</h5>
284<ol><p>the magick wand.</p></ol>
285
286 </div>
287<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
288_8c.html" target="source" name="MagickGetCopyright">MagickGetCopyright</a></h2>
289<div class="doc-section">
290
291<p>MagickGetCopyright() returns the ImageMagick API copyright as a string constant.</p></ol>
292
293<p>The format of the MagickGetCopyright method is:</p>
294
295<pre class="code">
296 const char *MagickGetCopyright(void)
297</pre>
298
299 </div>
300<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
301_8c.html" target="source" name="MagickGetFilename">MagickGetFilename</a></h2>
302<div class="doc-section">
303
304<p>MagickGetFilename() returns the filename associated with an image sequence.</p></ol>
305
306<p>The format of the MagickGetFilename method is:</p>
307
308<pre class="code">
309 const char *MagickGetFilename(const MagickWand *wand)
310</pre>
311
312<p>A description of each parameter follows:</p></ol>
313
314<h5>wand</h5>
315<ol><p>the magick wand.</p></ol>
316
317 </div>
318<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
319_8c.html" target="source" name="MagickGetFont">MagickGetFont</a></h2>
320<div class="doc-section">
321
322<p>MagickGetFont() returns the font associated with the MagickWand.</p></ol>
323
324<p>The format of the MagickGetFont method is:</p>
325
326<pre class="code">
327 char *MagickGetFont(MagickWand *wand)
328</pre>
329
330<p>A description of each parameter follows:</p></ol>
331
332<h5>wand</h5>
333<ol><p>the magick wand.</p></ol>
334
335 </div>
336<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
337_8c.html" target="source" name="MagickGetFormat">MagickGetFormat</a></h2>
338<div class="doc-section">
339
340<p>MagickGetFormat() returns the format of the magick wand.</p></ol>
341
342<p>The format of the MagickGetFormat method is:</p>
343
344<pre class="code">
345 const char MagickGetFormat(MagickWand *wand)
346</pre>
347
348<p>A description of each parameter follows:</p></ol>
349
350<h5>wand</h5>
351<ol><p>the magick wand.</p></ol>
352
353 </div>
354<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
355_8c.html" target="source" name="MagickGetGravity">MagickGetGravity</a></h2>
356<div class="doc-section">
357
358<p>MagickGetGravity() gets the wand gravity.</p></ol>
359
360<p>The format of the MagickGetGravity method is:</p>
361
362<pre class="code">
363 GravityType MagickGetGravity(MagickWand *wand)
364</pre>
365
366<p>A description of each parameter follows:</p></ol>
367
368<h5>wand</h5>
369<ol><p>the magick wand.</p></ol>
370
371 </div>
372<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
373_8c.html" target="source" name="MagickGetHomeURL">MagickGetHomeURL</a></h2>
374<div class="doc-section">
375
376<p>MagickGetHomeURL() returns the ImageMagick home URL.</p></ol>
377
378<p>The format of the MagickGetHomeURL method is:</p>
379
380<pre class="code">
381 char *MagickGetHomeURL(void)
382</pre>
383
384 </div>
385<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
386_8c.html" target="source" name="MagickGetImageProfile">MagickGetImageProfile</a></h2>
387<div class="doc-section">
388
389<p>MagickGetImageProfile() returns the named image profile.</p></ol>
390
391<p>The format of the MagickGetImageProfile method is:</p>
392
393<pre class="code">
394 unsigned char *MagickGetImageProfile(MagickWand *wand,const char *name,
395 size_t *length)
396</pre>
397
398<p>A description of each parameter follows:</p></ol>
399
400<h5>wand</h5>
401<ol><p>the magick wand.</p></ol>
402
403<h5>name</h5>
404<ol><p>Name of profile to return: ICC, IPTC, or generic profile.</p></ol>
405
406<h5>length</h5>
407<ol><p>the length of the profile.</p></ol>
408
409 </div>
410<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
411_8c.html" target="source" name="MagickGetImageProfiles">MagickGetImageProfiles</a></h2>
412<div class="doc-section">
413
414<p>MagickGetImageProfiles() returns all the profile names that match the specified pattern associated with a wand. Use MagickGetImageProfile() to return the value of a particular property. Use MagickRelinquishMemory() to free the value when you are finished with it.</p></ol>
415
416<p>The format of the MagickGetImageProfiles method is:</p>
417
418<pre class="code">
419 char *MagickGetImageProfiles(MagickWand *wand,
420 unsigned long *number_profiles)
421</pre>
422
423<p>A description of each parameter follows:</p></ol>
424
425<h5>wand</h5>
426<ol><p>the magick wand.</p></ol>
427
428<h5>pattern</h5>
429<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
430
431<h5>number_profiles</h5>
432<ol><p>the number profiles associated with this wand.</p></ol>
433
434 </div>
435<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
436_8c.html" target="source" name="MagickGetImageProperty">MagickGetImageProperty</a></h2>
437<div class="doc-section">
438
439<p>MagickGetImageProperty() returns a value associated with the specified property. Use MagickRelinquishMemory() to free the value when you are finished with it.</p></ol>
440
441<p>The format of the MagickGetImageProperty method is:</p>
442
443<pre class="code">
444 char *MagickGetImageProperty(MagickWand *wand,const char *property)
445</pre>
446
447<p>A description of each parameter follows:</p></ol>
448
449<h5>wand</h5>
450<ol><p>the magick wand.</p></ol>
451
452<h5>property</h5>
453<ol><p>the property.</p></ol>
454
455 </div>
456<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
457_8c.html" target="source" name="MagickGetImageProperties">MagickGetImageProperties</a></h2>
458<div class="doc-section">
459
460<p>MagickGetImageProperties() returns all the property names that match the specified pattern associated with a wand. Use MagickGetImageProperty() to return the value of a particular property. Use MagickRelinquishMemory() to free the value when you are finished with it.</p></ol>
461
462<p>The format of the MagickGetImageProperties method is:</p>
463
464<pre class="code">
465 char *MagickGetImageProperties(MagickWand *wand,
466 const char *pattern,unsigned long *number_properties)
467</pre>
468
469<p>A description of each parameter follows:</p></ol>
470
471<h5>wand</h5>
472<ol><p>the magick wand.</p></ol>
473
474<h5>pattern</h5>
475<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
476
477<h5>number_properties</h5>
478<ol><p>the number properties associated with this wand.</p></ol>
479
480 </div>
481<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
482_8c.html" target="source" name="MagickGetInterlaceScheme">MagickGetInterlaceScheme</a></h2>
483<div class="doc-section">
484
485<p>MagickGetInterlaceScheme() gets the wand interlace scheme.</p></ol>
486
487<p>The format of the MagickGetInterlaceScheme method is:</p>
488
489<pre class="code">
490 InterlaceType MagickGetInterlaceScheme(MagickWand *wand)
491</pre>
492
493<p>A description of each parameter follows:</p></ol>
494
495<h5>wand</h5>
496<ol><p>the magick wand.</p></ol>
497
498 </div>
499<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
500_8c.html" target="source" name="MagickGetInterpolateMethod">MagickGetInterpolateMethod</a></h2>
501<div class="doc-section">
502
503<p>MagickGetInterpolateMethod() gets the wand compression.</p></ol>
504
505<p>The format of the MagickGetInterpolateMethod method is:</p>
506
507<pre class="code">
508 InterpolatePixelMethod MagickGetInterpolateMethod(MagickWand *wand)
509</pre>
510
511<p>A description of each parameter follows:</p></ol>
512
513<h5>wand</h5>
514<ol><p>the magick wand.</p></ol>
515
516 </div>
517<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
518_8c.html" target="source" name="MagickGetOption">MagickGetOption</a></h2>
519<div class="doc-section">
520
521<p>MagickGetOption() returns a value associated with a wand and the specified key. Use MagickRelinquishMemory() to free the value when you are finished with it.</p></ol>
522
523<p>The format of the MagickGetOption method is:</p>
524
525<pre class="code">
526 char *MagickGetOption(MagickWand *wand,const char *key)
527</pre>
528
529<p>A description of each parameter follows:</p></ol>
530
531<h5>wand</h5>
532<ol><p>the magick wand.</p></ol>
533
534<h5>key</h5>
535<ol><p>the key.</p></ol>
536
537 </div>
538<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
539_8c.html" target="source" name="MagickGetOptions">MagickGetOptions</a></h2>
540<div class="doc-section">
541
542<p>MagickGetOptions() returns all the option names that match the specified pattern associated with a wand. Use MagickGetOption() to return the value of a particular option. Use MagickRelinquishMemory() to free the value when you are finished with it.</p></ol>
543
544<p>The format of the MagickGetOptions method is:</p>
545
546<pre class="code">
547 char *MagickGetOptions(MagickWand *wand,unsigned long *number_options)
548</pre>
549
550<p>A description of each parameter follows:</p></ol>
551
552<h5>wand</h5>
553<ol><p>the magick wand.</p></ol>
554
555<h5>pattern</h5>
556<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
557
558<h5>number_options</h5>
559<ol><p>the number options associated with this wand.</p></ol>
560
561 </div>
562<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
563_8c.html" target="source" name="MagickGetOrientation">MagickGetOrientation</a></h2>
564<div class="doc-section">
565
566<p>MagickGetOrientation() gets the wand orientation type.</p></ol>
567
568<p>The format of the MagickGetOrientation method is:</p>
569
570<pre class="code">
571 OrientationType MagickGetOrientation(MagickWand *wand)
572</pre>
573
574<p>A description of each parameter follows:</p></ol>
575
576<h5>wand</h5>
577<ol><p>the magick wand.</p></ol>
578
579 </div>
580<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
581_8c.html" target="source" name="MagickGetPackageName">MagickGetPackageName</a></h2>
582<div class="doc-section">
583
584<p>MagickGetPackageName() returns the ImageMagick package name as a string constant.</p></ol>
585
586<p>The format of the MagickGetPackageName method is:</p>
587
588<pre class="code">
589 const char *MagickGetPackageName(void)
590</pre>
591
592
593 </div>
594<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
595_8c.html" target="source" name="MagickGetPage">MagickGetPage</a></h2>
596<div class="doc-section">
597
598<p>MagickGetPage() returns the page geometry associated with the magick wand.</p></ol>
599
600<p>The format of the MagickGetPage method is:</p>
601
602<pre class="code">
603 MagickBooleanType MagickGetPage(const MagickWand *wand,
604 unsigned long *width,unsigned long *height,long *x,long *y)
605</pre>
606
607<p>A description of each parameter follows:</p></ol>
608
609<h5>wand</h5>
610<ol><p>the magick wand.</p></ol>
611
612<h5>width</h5>
613<ol><p>the page width.</p></ol>
614
615<h5>height</h5>
616<ol><p>page height.</p></ol>
617
618<h5>x</h5>
619<ol><p>the page x-offset.</p></ol>
620
621<h5>y</h5>
622<ol><p>the page y-offset.</p></ol>
623
624 </div>
625<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
626_8c.html" target="source" name="MagickGetPointsize">MagickGetPointsize</a></h2>
627<div class="doc-section">
628
629<p>MagickGetPointsize() returns the font pointsize associated with the MagickWand.</p></ol>
630
631<p>The format of the MagickGetPointsize method is:</p>
632
633<pre class="code">
634 double MagickGetPointsize(MagickWand *wand)
635</pre>
636
637<p>A description of each parameter follows:</p></ol>
638
639<h5>wand</h5>
640<ol><p>the magick wand.</p></ol>
641
642 </div>
643<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
644_8c.html" target="source" name="MagickGetQuantumDepth">MagickGetQuantumDepth</a></h2>
645<div class="doc-section">
646
647<p>MagickGetQuantumDepth() returns the ImageMagick quantum depth as a string constant.</p></ol>
648
649<p>The format of the MagickGetQuantumDepth method is:</p>
650
651<pre class="code">
652 const char *MagickGetQuantumDepth(unsigned long *depth)
653</pre>
654
655<p>A description of each parameter follows:</p></ol>
656
657<h5>depth</h5>
658<ol><p>the quantum depth is returned as a number.</p></ol>
659
660 </div>
661<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
662_8c.html" target="source" name="MagickGetQuantumRange">MagickGetQuantumRange</a></h2>
663<div class="doc-section">
664
665<p>MagickGetQuantumRange() returns the ImageMagick quantum range as a string constant.</p></ol>
666
667<p>The format of the MagickGetQuantumRange method is:</p>
668
669<pre class="code">
670 const char *MagickGetQuantumRange(unsigned long *range)
671</pre>
672
673<p>A description of each parameter follows:</p></ol>
674
675<h5>range</h5>
676<ol><p>the quantum range is returned as a number.</p></ol>
677
678 </div>
679<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
680_8c.html" target="source" name="MagickGetReleaseDate">MagickGetReleaseDate</a></h2>
681<div class="doc-section">
682
683<p>MagickGetReleaseDate() returns the ImageMagick release date as a string constant.</p></ol>
684
685<p>The format of the MagickGetReleaseDate method is:</p>
686
687<pre class="code">
688 const char *MagickGetReleaseDate(void)
689</pre>
690
691 </div>
692<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
693_8c.html" target="source" name="MagickGetResource">MagickGetResource</a></h2>
694<div class="doc-section">
695
696<p>MagickGetResource() returns the specified resource in megabytes.</p></ol>
697
698<p>The format of the MagickGetResource method is:</p>
699
700<pre class="code">
701 MagickSizeType MagickGetResource(const ResourceType type)
702</pre>
703
704<p>A description of each parameter follows:</p></ol>
705
706<h5>wand</h5>
707<ol><p>the magick wand.</p></ol>
708
709 </div>
710<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
711_8c.html" target="source" name="MagickGetResourceLimit">MagickGetResourceLimit</a></h2>
712<div class="doc-section">
713
714<p>MagickGetResourceLimit() returns the specified resource limit in megabytes.</p></ol>
715
716<p>The format of the MagickGetResourceLimit method is:</p>
717
718<pre class="code">
719 MagickSizeType MagickGetResourceLimit(const ResourceType type)
720</pre>
721
722<p>A description of each parameter follows:</p></ol>
723
724<h5>wand</h5>
725<ol><p>the magick wand.</p></ol>
726
727 </div>
728<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
729_8c.html" target="source" name="MagickGetSamplingFactors">MagickGetSamplingFactors</a></h2>
730<div class="doc-section">
731
732<p>MagickGetSamplingFactors() gets the horizontal and vertical sampling factor.</p></ol>
733
734<p>The format of the MagickGetSamplingFactors method is:</p>
735
736<pre class="code">
737 double *MagickGetSamplingFactor(MagickWand *wand,
738 unsigned long *number_factors)
739</pre>
740
741<p>A description of each parameter follows:</p></ol>
742
743<h5>wand</h5>
744<ol><p>the magick wand.</p></ol>
745
746<h5>number_factors</h5>
747<ol><p>the number of factors in the returned array.</p></ol>
748
749 </div>
750<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
751_8c.html" target="source" name="MagickGetSize">MagickGetSize</a></h2>
752<div class="doc-section">
753
754<p>MagickGetSize() returns the size associated with the magick wand.</p></ol>
755
756<p>The format of the MagickGetSize method is:</p>
757
758<pre class="code">
759 MagickBooleanType MagickGetSize(const MagickWand *wand,
760 unsigned long *columns,unsigned long *rows)
761</pre>
762
763<p>A description of each parameter follows:</p></ol>
764
765<h5>wand</h5>
766<ol><p>the magick wand.</p></ol>
767
768<h5>columns</h5>
769<ol><p>the width in pixels.</p></ol>
770
771<h5>height</h5>
772<ol><p>the height in pixels.</p></ol>
773
774 </div>
775<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
776_8c.html" target="source" name="MagickGetSizeOffset">MagickGetSizeOffset</a></h2>
777<div class="doc-section">
778
779<p>MagickGetSizeOffset() returns the size offset associated with the magick wand.</p></ol>
780
781<p>The format of the MagickGetSizeOffset method is:</p>
782
783<pre class="code">
784 MagickBooleanType MagickGetSizeOffset(const MagickWand *wand,
785 long *offset)
786</pre>
787
788<p>A description of each parameter follows:</p></ol>
789
790<h5>wand</h5>
791<ol><p>the magick wand.</p></ol>
792
793<h5>offset</h5>
794<ol><p>the image offset.</p></ol>
795
796 </div>
797<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
798_8c.html" target="source" name="MagickGetType">MagickGetType</a></h2>
799<div class="doc-section">
800
801<p>MagickGetType() returns the wand type.</p></ol>
802
803<p>The format of the MagickGetType method is:</p>
804
805<pre class="code">
806 ImageType MagickGetType(MagickWand *wand)
807</pre>
808
809<p>A description of each parameter follows:</p></ol>
810
811<h5>wand</h5>
812<ol><p>the magick wand.</p></ol>
813
814 </div>
815<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
816_8c.html" target="source" name="MagickGetVersion">MagickGetVersion</a></h2>
817<div class="doc-section">
818
819<p>MagickGetVersion() returns the ImageMagick API version as a string constant and as a number.</p></ol>
820
821<p>The format of the MagickGetVersion method is:</p>
822
823<pre class="code">
824 const char *MagickGetVersion(unsigned long *version)
825</pre>
826
827<p>A description of each parameter follows:</p></ol>
828
829<h5>version</h5>
830<ol><p>the ImageMagick version is returned as a number.</p></ol>
831
832 </div>
833<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
834_8c.html" target="source" name="MagickProfileImage">MagickProfileImage</a></h2>
835<div class="doc-section">
836
837<p>MagickProfileImage() adds or removes a ICC, IPTC, or generic profile from an image. If the profile is NULL, it is removed from the image otherwise added. Use a name of '*' and a profile of NULL to remove all profiles from the image.</p></ol>
838
839<p>The format of the MagickProfileImage method is:</p>
840
841<pre class="code">
842 MagickBooleanType MagickProfileImage(MagickWand *wand,const char *name,
843 const void *profile,const size_t length)
844</pre>
845
846<p>A description of each parameter follows:</p></ol>
847
848<h5>wand</h5>
849<ol><p>the magick wand.</p></ol>
850
851<h5>name</h5>
852<ol><p>Name of profile to add or remove: ICC, IPTC, or generic profile.</p></ol>
853
854<h5>profile</h5>
855<ol><p>the profile.</p></ol>
856
857<h5>length</h5>
858<ol><p>the length of the profile.</p></ol>
859
860 </div>
861<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
862_8c.html" target="source" name="MagickRemoveImageProfile">MagickRemoveImageProfile</a></h2>
863<div class="doc-section">
864
865<p>MagickRemoveImageProfile() removes the named image profile and returns it.</p></ol>
866
867<p>The format of the MagickRemoveImageProfile method is:</p>
868
869<pre class="code">
870 unsigned char *MagickRemoveImageProfile(MagickWand *wand,
871 const char *name,size_t *length)
872</pre>
873
874<p>A description of each parameter follows:</p></ol>
875
876<h5>wand</h5>
877<ol><p>the magick wand.</p></ol>
878
879<h5>name</h5>
880<ol><p>Name of profile to return: ICC, IPTC, or generic profile.</p></ol>
881
882<h5>length</h5>
883<ol><p>the length of the profile.</p></ol>
884
885 </div>
886<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
887_8c.html" target="source" name="MagickSetAntialias">MagickSetAntialias</a></h2>
888<div class="doc-section">
889
890<p>MagickSetAntialias() sets the antialias propery of the wand.</p></ol>
891
892<p>The format of the MagickSetAntialias method is:</p>
893
894<pre class="code">
895 MagickBooleanType MagickSetAntialias(MagickWand *wand,
896 const MagickBooleanType antialias)
897</pre>
898
899<p>A description of each parameter follows:</p></ol>
900
901<h5>wand</h5>
902<ol><p>the magick wand.</p></ol>
903
904<h5>antialias</h5>
905<ol><p>the antialias property.</p></ol>
906
907 </div>
908<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
909_8c.html" target="source" name="MagickSetBackgroundColor">MagickSetBackgroundColor</a></h2>
910<div class="doc-section">
911
912<p>MagickSetBackgroundColor() sets the wand background color.</p></ol>
913
914<p>The format of the MagickSetBackgroundColor method is:</p>
915
916<pre class="code">
917 MagickBooleanType MagickSetBackgroundColor(MagickWand *wand,
918 const PixelWand *background)
919</pre>
920
921<p>A description of each parameter follows:</p></ol>
922
923<h5>wand</h5>
924<ol><p>the magick wand.</p></ol>
925
926<h5>background</h5>
927<ol><p>the background pixel wand.</p></ol>
928
929 </div>
930<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
931_8c.html" target="source" name="MagickSetColorspace">MagickSetColorspace</a></h2>
932<div class="doc-section">
933
934<p>MagickSetColorspace() sets the wand colorspace type.</p></ol>
935
936<p>The format of the MagickSetColorspace method is:</p>
937
938<pre class="code">
939 MagickBooleanType MagickSetColorspace(MagickWand *wand,
940 const ColorspaceType colorspace)
941</pre>
942
943<p>A description of each parameter follows:</p></ol>
944
945<h5>wand</h5>
946<ol><p>the magick wand.</p></ol>
947
948<h5>colorspace</h5>
949<ol><p>the wand colorspace.</p></ol>
950
951 </div>
952<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
953_8c.html" target="source" name="MagickSetCompression">MagickSetCompression</a></h2>
954<div class="doc-section">
955
956<p>MagickSetCompression() sets the wand compression type.</p></ol>
957
958<p>The format of the MagickSetCompression method is:</p>
959
960<pre class="code">
961 MagickBooleanType MagickSetCompression(MagickWand *wand,
962 const CompressionType compression)
963</pre>
964
965<p>A description of each parameter follows:</p></ol>
966
967<h5>wand</h5>
968<ol><p>the magick wand.</p></ol>
969
970<h5>compression</h5>
971<ol><p>the wand compression.</p></ol>
972
973 </div>
974<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
975_8c.html" target="source" name="MagickSetCompressionQuality">MagickSetCompressionQuality</a></h2>
976<div class="doc-section">
977
978<p>MagickSetCompressionQuality() sets the wand compression quality.</p></ol>
979
980<p>The format of the MagickSetCompressionQuality method is:</p>
981
982<pre class="code">
983 MagickBooleanType MagickSetCompressionQuality(MagickWand *wand,
984 const unsigned long quality)
985</pre>
986
987<p>A description of each parameter follows:</p></ol>
988
989<h5>wand</h5>
990<ol><p>the magick wand.</p></ol>
991
992<h5>quality</h5>
993<ol><p>the wand compression quality.</p></ol>
994
995 </div>
996<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
997_8c.html" target="source" name="MagickSetDepth">MagickSetDepth</a></h2>
998<div class="doc-section">
999
1000<p>MagickSetDepth() sets the wand pixel depth.</p></ol>
1001
1002<p>The format of the MagickSetDepth method is:</p>
1003
1004<pre class="code">
1005 MagickBooleanType MagickSetDepth(MagickWand *wand,
1006 const unsigned long depth)
1007</pre>
1008
1009<p>A description of each parameter follows:</p></ol>
1010
1011<h5>wand</h5>
1012<ol><p>the magick wand.</p></ol>
1013
1014<h5>depth</h5>
1015<ol><p>the wand pixel depth.</p></ol>
1016
1017 </div>
1018<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1019_8c.html" target="source" name="MagickSetFilename">MagickSetFilename</a></h2>
1020<div class="doc-section">
1021
1022<p>MagickSetFilename() sets the filename before you read or write an image file.</p></ol>
1023
1024<p>The format of the MagickSetFilename method is:</p>
1025
1026<pre class="code">
1027 MagickBooleanType MagickSetFilename(MagickWand *wand,
1028 const char *filename)
1029</pre>
1030
1031<p>A description of each parameter follows:</p></ol>
1032
1033<h5>wand</h5>
1034<ol><p>the magick wand.</p></ol>
1035
1036<h5>filename</h5>
1037<ol><p>the image filename.</p></ol>
1038
1039 </div>
1040<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1041_8c.html" target="source" name="MagickSetFont">MagickSetFont</a></h2>
1042<div class="doc-section">
1043
1044<p>MagickSetFont() sets the font associated with the MagickWand.</p></ol>
1045
1046<p>The format of the MagickSetFont method is:</p>
1047
1048<pre class="code">
1049 MagickBooleanType MagickSetFont(MagickWand *wand, const char *font)
1050</pre>
1051
1052<p>A description of each parameter follows:</p></ol>
1053
1054<h5>wand</h5>
1055<ol><p>the magick wand.</p></ol>
1056
1057<h5>font</h5>
1058<ol><p>the font</p></ol>
1059
1060 </div>
1061<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1062_8c.html" target="source" name="MagickSetFormat">MagickSetFormat</a></h2>
1063<div class="doc-section">
1064
1065<p>MagickSetFormat() sets the format of the magick wand.</p></ol>
1066
1067<p>The format of the MagickSetFormat method is:</p>
1068
1069<pre class="code">
1070 MagickBooleanType MagickSetFormat(MagickWand *wand,const char *format)
1071</pre>
1072
1073<p>A description of each parameter follows:</p></ol>
1074
1075<h5>wand</h5>
1076<ol><p>the magick wand.</p></ol>
1077
1078<h5>format</h5>
1079<ol><p>the image format.</p></ol>
1080
1081 </div>
1082<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1083_8c.html" target="source" name="MagickSetGravity">MagickSetGravity</a></h2>
1084<div class="doc-section">
1085
1086<p>MagickSetGravity() sets the gravity type.</p></ol>
1087
1088<p>The format of the MagickSetGravity type is:</p>
1089
1090<pre class="text">
1091 MagickBooleanType MagickSetGravity(MagickWand *wand,
1092 const GravityType type)
1093</pre>
1094
1095<p>A description of each parameter follows:</p></ol>
1096
1097<h5>wand</h5>
1098<ol><p>the magick wand.</p></ol>
1099
1100<h5>type</h5>
1101<ol><p>the gravity type.</p></ol>
1102
1103 </div>
1104<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1105_8c.html" target="source" name="MagickSetImageProfile">MagickSetImageProfile</a></h2>
1106<div class="doc-section">
1107
1108<p>MagickSetImageProfile() adds a named profile to the magick wand. If a profile with the same name already exists, it is replaced. This method differs from the MagickProfileImage() method in that it does not apply any CMS color profiles.</p></ol>
1109
1110<p>The format of the MagickSetImageProfile method is:</p>
1111
1112<pre class="code">
1113 MagickBooleanType MagickSetImageProfile(MagickWand *wand,
1114 const char *name,const void *profile,const size_t length)
1115</pre>
1116
1117<p>A description of each parameter follows:</p></ol>
1118
1119<h5>wand</h5>
1120<ol><p>the magick wand.</p></ol>
1121
1122<h5>name</h5>
1123<ol><p>Name of profile to add or remove: ICC, IPTC, or generic profile.</p></ol>
1124
1125<h5>profile</h5>
1126<ol><p>the profile.</p></ol>
1127
1128<h5>length</h5>
1129<ol><p>the length of the profile.</p></ol>
1130
1131 </div>
1132<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1133_8c.html" target="source" name="MagickSetImageProperty">MagickSetImageProperty</a></h2>
1134<div class="doc-section">
1135
1136<p>MagickSetImageProperty() associates a property with an image.</p></ol>
1137
1138<p>The format of the MagickSetImageProperty method is:</p>
1139
1140<pre class="code">
1141 MagickBooleanType MagickSetImageProperty(MagickWand *wand,
1142 const char *property,const char *value)
1143</pre>
1144
1145<p>A description of each parameter follows:</p></ol>
1146
1147<h5>wand</h5>
1148<ol><p>the magick wand.</p></ol>
1149
1150<h5>property</h5>
1151<ol><p>the property.</p></ol>
1152
1153<h5>value</h5>
1154<ol><p>the value.</p></ol>
1155
1156 </div>
1157<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1158_8c.html" target="source" name="MagickSetInterlaceScheme">MagickSetInterlaceScheme</a></h2>
1159<div class="doc-section">
1160
1161<p>MagickSetInterlaceScheme() sets the image compression.</p></ol>
1162
1163<p>The format of the MagickSetInterlaceScheme method is:</p>
1164
1165<pre class="code">
1166 MagickBooleanType MagickSetInterlaceScheme(MagickWand *wand,
1167 const InterlaceType interlace_scheme)
1168</pre>
1169
1170<p>A description of each parameter follows:</p></ol>
1171
1172<h5>wand</h5>
1173<ol><p>the magick wand.</p></ol>
1174
1175<h5>interlace_scheme</h5>
1176<ol><p>the image interlace scheme: NoInterlace, LineInterlace, PlaneInterlace, PartitionInterlace.</p></ol>
1177
1178 </div>
1179<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1180_8c.html" target="source" name="MagickSetInterpolateMethod">MagickSetInterpolateMethod</a></h2>
1181<div class="doc-section">
1182
1183<p>MagickSetInterpolateMethod() sets the interpolate pixel method.</p></ol>
1184
1185<p>The format of the MagickSetInterpolateMethod method is:</p>
1186
1187<pre class="code">
1188 MagickBooleanType MagickSetInterpolateMethod(MagickWand *wand,
1189 const InterpolateMethodPixel method)
1190</pre>
1191
1192<p>A description of each parameter follows:</p></ol>
1193
1194<h5>wand</h5>
1195<ol><p>the magick wand.</p></ol>
1196
1197<h5>method</h5>
1198<ol><p>the interpolate pixel method.</p></ol>
1199
1200 </div>
1201<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1202_8c.html" target="source" name="MagickSetOption">MagickSetOption</a></h2>
1203<div class="doc-section">
1204
1205<p>MagickSetOption() associates one or options with the wand (.e.g MagickSetOption(wand,"jpeg:perserve","yes")).</p></ol>
1206
1207<p>The format of the MagickSetOption method is:</p>
1208
1209<pre class="code">
1210 MagickBooleanType MagickSetOption(MagickWand *wand,const char *key,
1211 const char *value)
1212</pre>
1213
1214<p>A description of each parameter follows:</p></ol>
1215
1216<h5>wand</h5>
1217<ol><p>the magick wand.</p></ol>
1218
1219<h5>key</h5>
1220<ol><p>The key.</p></ol>
1221
1222<h5>value</h5>
1223<ol><p>The value.</p></ol>
1224
1225 </div>
1226<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1227_8c.html" target="source" name="MagickSetOrientation">MagickSetOrientation</a></h2>
1228<div class="doc-section">
1229
1230<p>MagickSetOrientation() sets the wand orientation type.</p></ol>
1231
1232<p>The format of the MagickSetOrientation method is:</p>
1233
1234<pre class="code">
1235 MagickBooleanType MagickSetOrientation(MagickWand *wand,
1236 const OrientationType orientation)
1237</pre>
1238
1239<p>A description of each parameter follows:</p></ol>
1240
1241<h5>wand</h5>
1242<ol><p>the magick wand.</p></ol>
1243
1244<h5>orientation</h5>
1245<ol><p>the wand orientation.</p></ol>
1246
1247 </div>
1248<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1249_8c.html" target="source" name="MagickSetPage">MagickSetPage</a></h2>
1250<div class="doc-section">
1251
1252<p>MagickSetPage() sets the page geometry of the magick wand.</p></ol>
1253
1254<p>The format of the MagickSetPage method is:</p>
1255
1256<pre class="code">
1257 MagickBooleanType MagickSetPage(MagickWand *wand,
1258 const unsigned long width,const unsigned long height,const long x,
1259 const long y)
1260</pre>
1261
1262<p>A description of each parameter follows:</p></ol>
1263
1264<h5>wand</h5>
1265<ol><p>the magick wand.</p></ol>
1266
1267<h5>width</h5>
1268<ol><p>the page width.</p></ol>
1269
1270<h5>height</h5>
1271<ol><p>the page height.</p></ol>
1272
1273<h5>x</h5>
1274<ol><p>the page x-offset.</p></ol>
1275
1276<h5>y</h5>
1277<ol><p>the page y-offset.</p></ol>
1278
1279 </div>
1280<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1281_8c.html" target="source" name="MagickSetPassphrase">MagickSetPassphrase</a></h2>
1282<div class="doc-section">
1283
1284<p>MagickSetPassphrase() sets the passphrase.</p></ol>
1285
1286<p>The format of the MagickSetPassphrase method is:</p>
1287
1288<pre class="code">
1289 MagickBooleanType MagickSetPassphrase(MagickWand *wand,
1290 const char *passphrase)
1291</pre>
1292
1293<p>A description of each parameter follows:</p></ol>
1294
1295<h5>wand</h5>
1296<ol><p>the magick wand.</p></ol>
1297
1298<h5>passphrase</h5>
1299<ol><p>the passphrase.</p></ol>
1300
1301 </div>
1302<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1303_8c.html" target="source" name="MagickSetPointsize">MagickSetPointsize</a></h2>
1304<div class="doc-section">
1305
1306<p>MagickSetPointsize() sets the font pointsize associated with the MagickWand.</p></ol>
1307
1308<p>The format of the MagickSetPointsize method is:</p>
1309
1310<pre class="code">
1311 MagickBooleanType MagickSetPointsize(MagickWand *wand,
1312 const double pointsize)
1313</pre>
1314
1315<p>A description of each parameter follows:</p></ol>
1316
1317<h5>wand</h5>
1318<ol><p>the magick wand.</p></ol>
1319
1320<h5>pointsize</h5>
1321<ol><p>the size of the font</p></ol>
1322
1323 </div>
1324<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1325_8c.html" target="source" name="MagickSetProgressMonitor">MagickSetProgressMonitor</a></h2>
1326<div class="doc-section">
1327
1328<p>MagickSetProgressMonitor() sets the wand progress monitor to the specified method and returns the previous progress monitor if any. The progress monitor method looks like this:</p>
1329
1330<pre class="text">
1331 MagickBooleanType MagickProgressMonitor(const char *text,
1332 const MagickOffsetType offset,const MagickSizeType span,
1333 void *client_data)
1334</pre>
1335
1336<p>If the progress monitor returns MagickFalse, the current operation is interrupted.</p></ol>
1337
1338<p>The format of the MagickSetProgressMonitor method is:</p>
1339
1340<pre class="code">
1341 MagickProgressMonitor MagickSetProgressMonitor(MagickWand *wand
1342 const MagickProgressMonitor progress_monitor,void *client_data)
1343</pre>
1344
1345<p>A description of each parameter follows:</p></ol>
1346
1347<h5>wand</h5>
1348<ol><p>the magick wand.</p></ol>
1349
1350<h5>progress_monitor</h5>
1351<ol><p>Specifies a pointer to a method to monitor progress of an image operation.</p></ol>
1352
1353<h5>client_data</h5>
1354<ol><p>Specifies a pointer to any client data.</p></ol>
1355
1356 </div>
1357<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1358_8c.html" target="source" name="MagickSetResourceLimit">MagickSetResourceLimit</a></h2>
1359<div class="doc-section">
1360
1361<p>MagickSetResourceLimit() sets the limit for a particular resource in megabytes.</p></ol>
1362
1363<p>The format of the MagickSetResourceLimit method is:</p>
1364
1365<pre class="code">
1366 MagickBooleanType MagickSetResourceLimit(const ResourceType type,
1367 const MagickSizeType limit)
1368</pre>
1369
1370<p>A description of each parameter follows:</p></ol>
1371
1372<h5>type</h5>
1373<ol><p>the type of resource: AreaResource, MemoryResource, MapResource, DiskResource, FileResource.</p></ol>
1374
1375<p>o The maximum limit for the resource.</p></ol>
1376
1377 </div>
1378<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1379_8c.html" target="source" name="MagickSetResolution">MagickSetResolution</a></h2>
1380<div class="doc-section">
1381
1382<p>MagickSetResolution() sets the image resolution.</p></ol>
1383
1384<p>The format of the MagickSetResolution method is:</p>
1385
1386<pre class="code">
1387 MagickBooleanType MagickSetResolution(MagickWand *wand,
1388 const double x_resolution,const doubtl y_resolution)
1389</pre>
1390
1391<p>A description of each parameter follows:</p></ol>
1392
1393<h5>wand</h5>
1394<ol><p>the magick wand.</p></ol>
1395
1396<h5>x_resolution</h5>
1397<ol><p>the image x resolution.</p></ol>
1398
1399<h5>y_resolution</h5>
1400<ol><p>the image y resolution.</p></ol>
1401
1402 </div>
1403<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1404_8c.html" target="source" name="MagickSetSamplingFactors">MagickSetSamplingFactors</a></h2>
1405<div class="doc-section">
1406
1407<p>MagickSetSamplingFactors() sets the image sampling factors.</p></ol>
1408
1409<p>The format of the MagickSetSamplingFactors method is:</p>
1410
1411<pre class="code">
1412 MagickBooleanType MagickSetSamplingFactors(MagickWand *wand,
1413 const unsigned long number_factors,const double *sampling_factors)
1414</pre>
1415
1416<p>A description of each parameter follows:</p></ol>
1417
1418<h5>wand</h5>
1419<ol><p>the magick wand.</p></ol>
1420
1421<h5>number_factoes</h5>
1422<ol><p>the number of factors.</p></ol>
1423
1424<h5>sampling_factors</h5>
1425<ol><p>An array of doubles representing the sampling factor for each color component (in RGB order).</p></ol>
1426
1427 </div>
1428<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1429_8c.html" target="source" name="MagickSetSize">MagickSetSize</a></h2>
1430<div class="doc-section">
1431
1432<p>MagickSetSize() sets the size of the magick wand. Set it before you read a raw image format such as RGB, GRAY, or CMYK.</p></ol>
1433
1434<p>The format of the MagickSetSize method is:</p>
1435
1436<pre class="code">
1437 MagickBooleanType MagickSetSize(MagickWand *wand,
1438 const unsigned long columns,const unsigned long rows)
1439</pre>
1440
1441<p>A description of each parameter follows:</p></ol>
1442
1443<h5>wand</h5>
1444<ol><p>the magick wand.</p></ol>
1445
1446<h5>columns</h5>
1447<ol><p>the width in pixels.</p></ol>
1448
1449<h5>rows</h5>
1450<ol><p>the rows in pixels.</p></ol>
1451
1452 </div>
1453<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1454_8c.html" target="source" name="MagickSetSizeOffset">MagickSetSizeOffset</a></h2>
1455<div class="doc-section">
1456
1457<p>MagickSetSizeOffset() sets the size and offset of the magick wand. Set it before you read a raw image format such as RGB, GRAY, or CMYK.</p></ol>
1458
1459<p>The format of the MagickSetSizeOffset method is:</p>
1460
1461<pre class="code">
1462 MagickBooleanType MagickSetSizeOffset(MagickWand *wand,
1463 const unsigned long columns,const unsigned long rows,
1464 const long offset)
1465</pre>
1466
1467<p>A description of each parameter follows:</p></ol>
1468
1469<h5>wand</h5>
1470<ol><p>the magick wand.</p></ol>
1471
1472<h5>columns</h5>
1473<ol><p>the image width in pixels.</p></ol>
1474
1475<h5>rows</h5>
1476<ol><p>the image rows in pixels.</p></ol>
1477
1478<h5>offset</h5>
1479<ol><p>the image offset.</p></ol>
1480
1481 </div>
1482<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1483_8c.html" target="source" name="MagickSetType">MagickSetType</a></h2>
1484<div class="doc-section">
1485
1486<p>MagickSetType() sets the image type attribute.</p></ol>
1487
1488<p>The format of the MagickSetType method is:</p>
1489
1490<pre class="code">
1491 MagickBooleanType MagickSetType(MagickWand *wand,
1492 const ImageType image_type)
1493</pre>
1494
1495<p>A description of each parameter follows:</p></ol>
1496
1497<h5>wand</h5>
1498<ol><p>the magick wand.</p></ol>
1499
1500<h5>image_type</h5>
1501<ol><p>the image type: UndefinedType, BilevelType, GrayscaleType, GrayscaleMatteType, PaletteType, PaletteMatteType, TrueColorType, TrueColorMatteType, ColorSeparationType, ColorSeparationMatteType, or OptimizeType.</p></ol>
1502
1503 </div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]1504
1505</div>
1506
1507<div id="linkbar">
1508 <!-- <span id="linkbar-west">&nbsp;</span> -->
1509 <span id="linkbar-center">
1510 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
1511 <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]1512 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]1513 </span>
1514 <span id="linkbar-east">&nbsp;</span>
1515 </div>
1516 <div class="footer">
1517 <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
1518 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
1519 </div>
1520 <div style="clear: both; margin: 0; width: 100%; "></div>
1521</body>
1522</html>