Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 2744bd91de384c5ef276f9afb4dec138f76bfd0b / . / www / api / magick-property.html
blob: b0f9ef24f6f9c08381e752f62e6a33d24f5c3c3e [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">
cristy2744bd92009-11-08 22:57:52 +0000[diff] [blame^]126 <a href="http://www.hygi.de">Reinigungsmittel</a><!-- 201002000400+ -->
127</div>
128<div class="sponsor">
129 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
cristyc1c61662009-09-30 14:04:37 +0000[diff] [blame]130</div>
131<div class="sponsor">
cristy916e1922009-10-01 12:52:47 +0000[diff] [blame]132 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201003010120 Buchhorn -->
133</div>
134<div class="sponsor">
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]135 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristyc49f7992009-09-22 22:48:40 +0000[diff] [blame]136</div>
137<div class="sponsor">
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]138 <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
139</div>
140<div class="sponsor">
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]141 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
142</div>
143<div class="sponsor">
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]144 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
145</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]146</div>
147</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]148
149
150</div>
151
152<div class="main">
153
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]154<p class="navigation-index">[<a href="#MagickDeleteImageArtifact">MagickDeleteImageArtifact</a> &bull; <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="#MagickGetImageArtifact">MagickGetImageArtifact</a> &bull; <a href="#MagickGetImageArtifacts">MagickGetImageArtifacts</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="#MagickSetExtract">MagickSetExtract</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="#MagickSetImageArtifact">MagickSetImageArtifact</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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]155
156<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]157_8c.html" target="source" name="MagickDeleteImageArtifact">MagickDeleteImageArtifact</a></h2>
158<div class="doc-section">
159
160<p>MagickDeleteImageArtifact() deletes a wand artifact.</p></ol>
161
162<p>The format of the MagickDeleteImageArtifact method is:</p>
163
164<pre class="code">
165 MagickBooleanType MagickDeleteImageArtifact(MagickWand *wand,
166 const char *artifact)
167</pre>
168
169<p>A description of each parameter follows:</p></ol>
170
171<h5>image</h5>
172<ol><p>the image.</p></ol>
173
174<h5>artifact</h5>
175<ol><p>the image artifact.</p></ol>
176
177 </div>
178<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]179_8c.html" target="source" name="MagickDeleteImageProperty">MagickDeleteImageProperty</a></h2>
180<div class="doc-section">
181
182<p>MagickDeleteImageProperty() deletes a wand property.</p></ol>
183
184<p>The format of the MagickDeleteImageProperty method is:</p>
185
186<pre class="code">
187 MagickBooleanType MagickDeleteImageProperty(MagickWand *wand,
188 const char *property)
189</pre>
190
191<p>A description of each parameter follows:</p></ol>
192
193<h5>image</h5>
194<ol><p>the image.</p></ol>
195
196<h5>property</h5>
197<ol><p>the image property.</p></ol>
198
199 </div>
200<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
201_8c.html" target="source" name="MagickDeleteOption">MagickDeleteOption</a></h2>
202<div class="doc-section">
203
204<p>MagickDeleteOption() deletes a wand option.</p></ol>
205
206<p>The format of the MagickDeleteOption method is:</p>
207
208<pre class="code">
209 MagickBooleanType MagickDeleteOption(MagickWand *wand,
210 const char *option)
211</pre>
212
213<p>A description of each parameter follows:</p></ol>
214
215<h5>image</h5>
216<ol><p>the image.</p></ol>
217
218<h5>option</h5>
219<ol><p>the image option.</p></ol>
220
221 </div>
222<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
223_8c.html" target="source" name="MagickGetAntialias">MagickGetAntialias</a></h2>
224<div class="doc-section">
225
226<p>MagickGetAntialias() returns the antialias property associated with the wand.</p></ol>
227
228<p>The format of the MagickGetAntialias method is:</p>
229
230<pre class="code">
231 MagickBooleanType MagickGetAntialias(const MagickWand *wand)
232</pre>
233
234<p>A description of each parameter follows:</p></ol>
235
236<h5>wand</h5>
237<ol><p>the magick wand.</p></ol>
238
239 </div>
240<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
241_8c.html" target="source" name="MagickGetBackgroundColor">MagickGetBackgroundColor</a></h2>
242<div class="doc-section">
243
244<p>MagickGetBackgroundColor() returns the wand background color.</p></ol>
245
246<p>The format of the MagickGetBackgroundColor method is:</p>
247
248<pre class="code">
249 PixelWand *MagickGetBackgroundColor(MagickWand *wand)
250</pre>
251
252<p>A description of each parameter follows:</p></ol>
253
254<h5>wand</h5>
255<ol><p>the magick wand.</p></ol>
256
257 </div>
258<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
259_8c.html" target="source" name="MagickGetColorspace">MagickGetColorspace</a></h2>
260<div class="doc-section">
261
262<p>MagickGetColorspace() gets the wand colorspace type.</p></ol>
263
264<p>The format of the MagickGetColorspace method is:</p>
265
266<pre class="code">
267 ColorspaceType MagickGetColorspace(MagickWand *wand)
268</pre>
269
270<p>A description of each parameter follows:</p></ol>
271
272<h5>wand</h5>
273<ol><p>the magick wand.</p></ol>
274
275 </div>
276<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
277_8c.html" target="source" name="MagickGetCompression">MagickGetCompression</a></h2>
278<div class="doc-section">
279
280<p>MagickGetCompression() gets the wand compression type.</p></ol>
281
282<p>The format of the MagickGetCompression method is:</p>
283
284<pre class="code">
285 CompressionType MagickGetCompression(MagickWand *wand)
286</pre>
287
288<p>A description of each parameter follows:</p></ol>
289
290<h5>wand</h5>
291<ol><p>the magick wand.</p></ol>
292
293 </div>
294<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
295_8c.html" target="source" name="MagickGetCompressionQuality">MagickGetCompressionQuality</a></h2>
296<div class="doc-section">
297
298<p>MagickGetCompressionQuality() gets the wand compression quality.</p></ol>
299
300<p>The format of the MagickGetCompressionQuality method is:</p>
301
302<pre class="code">
303 unsigned long MagickGetCompressionQuality(MagickWand *wand)
304</pre>
305
306<p>A description of each parameter follows:</p></ol>
307
308<h5>wand</h5>
309<ol><p>the magick wand.</p></ol>
310
311 </div>
312<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
313_8c.html" target="source" name="MagickGetCopyright">MagickGetCopyright</a></h2>
314<div class="doc-section">
315
316<p>MagickGetCopyright() returns the ImageMagick API copyright as a string constant.</p></ol>
317
318<p>The format of the MagickGetCopyright method is:</p>
319
320<pre class="code">
321 const char *MagickGetCopyright(void)
322</pre>
323
324 </div>
325<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
326_8c.html" target="source" name="MagickGetFilename">MagickGetFilename</a></h2>
327<div class="doc-section">
328
329<p>MagickGetFilename() returns the filename associated with an image sequence.</p></ol>
330
331<p>The format of the MagickGetFilename method is:</p>
332
333<pre class="code">
334 const char *MagickGetFilename(const MagickWand *wand)
335</pre>
336
337<p>A description of each parameter follows:</p></ol>
338
339<h5>wand</h5>
340<ol><p>the magick wand.</p></ol>
341
342 </div>
343<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
344_8c.html" target="source" name="MagickGetFont">MagickGetFont</a></h2>
345<div class="doc-section">
346
347<p>MagickGetFont() returns the font associated with the MagickWand.</p></ol>
348
349<p>The format of the MagickGetFont method is:</p>
350
351<pre class="code">
352 char *MagickGetFont(MagickWand *wand)
353</pre>
354
355<p>A description of each parameter follows:</p></ol>
356
357<h5>wand</h5>
358<ol><p>the magick wand.</p></ol>
359
360 </div>
361<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
362_8c.html" target="source" name="MagickGetFormat">MagickGetFormat</a></h2>
363<div class="doc-section">
364
365<p>MagickGetFormat() returns the format of the magick wand.</p></ol>
366
367<p>The format of the MagickGetFormat method is:</p>
368
369<pre class="code">
370 const char MagickGetFormat(MagickWand *wand)
371</pre>
372
373<p>A description of each parameter follows:</p></ol>
374
375<h5>wand</h5>
376<ol><p>the magick wand.</p></ol>
377
378 </div>
379<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
380_8c.html" target="source" name="MagickGetGravity">MagickGetGravity</a></h2>
381<div class="doc-section">
382
383<p>MagickGetGravity() gets the wand gravity.</p></ol>
384
385<p>The format of the MagickGetGravity method is:</p>
386
387<pre class="code">
388 GravityType MagickGetGravity(MagickWand *wand)
389</pre>
390
391<p>A description of each parameter follows:</p></ol>
392
393<h5>wand</h5>
394<ol><p>the magick wand.</p></ol>
395
396 </div>
397<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
398_8c.html" target="source" name="MagickGetHomeURL">MagickGetHomeURL</a></h2>
399<div class="doc-section">
400
401<p>MagickGetHomeURL() returns the ImageMagick home URL.</p></ol>
402
403<p>The format of the MagickGetHomeURL method is:</p>
404
405<pre class="code">
406 char *MagickGetHomeURL(void)
407</pre>
408
409 </div>
410<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]411_8c.html" target="source" name="MagickGetImageArtifact">MagickGetImageArtifact</a></h2>
412<div class="doc-section">
413
414<p>MagickGetImageArtifact() returns a value associated with the specified artifact. Use MagickRelinquishMemory() to free the value when you are finished with it.</p></ol>
415
416<p>The format of the MagickGetImageArtifact method is:</p>
417
418<pre class="code">
419 char *MagickGetImageArtifact(MagickWand *wand,const char *artifact)
420</pre>
421
422<p>A description of each parameter follows:</p></ol>
423
424<h5>wand</h5>
425<ol><p>the magick wand.</p></ol>
426
427<h5>artifact</h5>
428<ol><p>the artifact.</p></ol>
429
430 </div>
431<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
432_8c.html" target="source" name="MagickGetImageArtifacts">MagickGetImageArtifacts</a></h2>
433<div class="doc-section">
434
435<p>MagickGetImageArtifacts() returns all the artifact names that match the specified pattern associated with a wand. Use MagickGetImageProperty() to return the value of a particular artifact. Use MagickRelinquishMemory() to free the value when you are finished with it.</p></ol>
436
437<p>The format of the MagickGetImageArtifacts method is:</p>
438
439<pre class="code">
440 char *MagickGetImageArtifacts(MagickWand *wand,
441 const char *pattern,unsigned long *number_artifacts)
442</pre>
443
444<p>A description of each parameter follows:</p></ol>
445
446<h5>wand</h5>
447<ol><p>the magick wand.</p></ol>
448
449<h5>pattern</h5>
450<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
451
452<h5>number_artifacts</h5>
453<ol><p>the number artifacts associated with this wand.</p></ol>
454
455 </div>
456<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]457_8c.html" target="source" name="MagickGetImageProfile">MagickGetImageProfile</a></h2>
458<div class="doc-section">
459
460<p>MagickGetImageProfile() returns the named image profile.</p></ol>
461
462<p>The format of the MagickGetImageProfile method is:</p>
463
464<pre class="code">
465 unsigned char *MagickGetImageProfile(MagickWand *wand,const char *name,
466 size_t *length)
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>name</h5>
475<ol><p>Name of profile to return: ICC, IPTC, or generic profile.</p></ol>
476
477<h5>length</h5>
478<ol><p>the length of the profile.</p></ol>
479
480 </div>
481<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
482_8c.html" target="source" name="MagickGetImageProfiles">MagickGetImageProfiles</a></h2>
483<div class="doc-section">
484
485<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>
486
487<p>The format of the MagickGetImageProfiles method is:</p>
488
489<pre class="code">
490 char *MagickGetImageProfiles(MagickWand *wand,
491 unsigned long *number_profiles)
492</pre>
493
494<p>A description of each parameter follows:</p></ol>
495
496<h5>wand</h5>
497<ol><p>the magick wand.</p></ol>
498
499<h5>pattern</h5>
500<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
501
502<h5>number_profiles</h5>
503<ol><p>the number profiles associated with this wand.</p></ol>
504
505 </div>
506<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
507_8c.html" target="source" name="MagickGetImageProperty">MagickGetImageProperty</a></h2>
508<div class="doc-section">
509
510<p>MagickGetImageProperty() returns a value associated with the specified property. Use MagickRelinquishMemory() to free the value when you are finished with it.</p></ol>
511
512<p>The format of the MagickGetImageProperty method is:</p>
513
514<pre class="code">
515 char *MagickGetImageProperty(MagickWand *wand,const char *property)
516</pre>
517
518<p>A description of each parameter follows:</p></ol>
519
520<h5>wand</h5>
521<ol><p>the magick wand.</p></ol>
522
523<h5>property</h5>
524<ol><p>the property.</p></ol>
525
526 </div>
527<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
528_8c.html" target="source" name="MagickGetImageProperties">MagickGetImageProperties</a></h2>
529<div class="doc-section">
530
531<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>
532
533<p>The format of the MagickGetImageProperties method is:</p>
534
535<pre class="code">
536 char *MagickGetImageProperties(MagickWand *wand,
537 const char *pattern,unsigned long *number_properties)
538</pre>
539
540<p>A description of each parameter follows:</p></ol>
541
542<h5>wand</h5>
543<ol><p>the magick wand.</p></ol>
544
545<h5>pattern</h5>
546<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
547
548<h5>number_properties</h5>
549<ol><p>the number properties associated with this wand.</p></ol>
550
551 </div>
552<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
553_8c.html" target="source" name="MagickGetInterlaceScheme">MagickGetInterlaceScheme</a></h2>
554<div class="doc-section">
555
556<p>MagickGetInterlaceScheme() gets the wand interlace scheme.</p></ol>
557
558<p>The format of the MagickGetInterlaceScheme method is:</p>
559
560<pre class="code">
561 InterlaceType MagickGetInterlaceScheme(MagickWand *wand)
562</pre>
563
564<p>A description of each parameter follows:</p></ol>
565
566<h5>wand</h5>
567<ol><p>the magick wand.</p></ol>
568
569 </div>
570<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
571_8c.html" target="source" name="MagickGetInterpolateMethod">MagickGetInterpolateMethod</a></h2>
572<div class="doc-section">
573
574<p>MagickGetInterpolateMethod() gets the wand compression.</p></ol>
575
576<p>The format of the MagickGetInterpolateMethod method is:</p>
577
578<pre class="code">
579 InterpolatePixelMethod MagickGetInterpolateMethod(MagickWand *wand)
580</pre>
581
582<p>A description of each parameter follows:</p></ol>
583
584<h5>wand</h5>
585<ol><p>the magick wand.</p></ol>
586
587 </div>
588<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
589_8c.html" target="source" name="MagickGetOption">MagickGetOption</a></h2>
590<div class="doc-section">
591
592<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>
593
594<p>The format of the MagickGetOption method is:</p>
595
596<pre class="code">
597 char *MagickGetOption(MagickWand *wand,const char *key)
598</pre>
599
600<p>A description of each parameter follows:</p></ol>
601
602<h5>wand</h5>
603<ol><p>the magick wand.</p></ol>
604
605<h5>key</h5>
606<ol><p>the key.</p></ol>
607
608 </div>
609<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
610_8c.html" target="source" name="MagickGetOptions">MagickGetOptions</a></h2>
611<div class="doc-section">
612
613<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>
614
615<p>The format of the MagickGetOptions method is:</p>
616
617<pre class="code">
618 char *MagickGetOptions(MagickWand *wand,unsigned long *number_options)
619</pre>
620
621<p>A description of each parameter follows:</p></ol>
622
623<h5>wand</h5>
624<ol><p>the magick wand.</p></ol>
625
626<h5>pattern</h5>
627<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
628
629<h5>number_options</h5>
630<ol><p>the number options associated with this wand.</p></ol>
631
632 </div>
633<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
634_8c.html" target="source" name="MagickGetOrientation">MagickGetOrientation</a></h2>
635<div class="doc-section">
636
637<p>MagickGetOrientation() gets the wand orientation type.</p></ol>
638
639<p>The format of the MagickGetOrientation method is:</p>
640
641<pre class="code">
642 OrientationType MagickGetOrientation(MagickWand *wand)
643</pre>
644
645<p>A description of each parameter follows:</p></ol>
646
647<h5>wand</h5>
648<ol><p>the magick wand.</p></ol>
649
650 </div>
651<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
652_8c.html" target="source" name="MagickGetPackageName">MagickGetPackageName</a></h2>
653<div class="doc-section">
654
655<p>MagickGetPackageName() returns the ImageMagick package name as a string constant.</p></ol>
656
657<p>The format of the MagickGetPackageName method is:</p>
658
659<pre class="code">
660 const char *MagickGetPackageName(void)
661</pre>
662
663
664 </div>
665<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
666_8c.html" target="source" name="MagickGetPage">MagickGetPage</a></h2>
667<div class="doc-section">
668
669<p>MagickGetPage() returns the page geometry associated with the magick wand.</p></ol>
670
671<p>The format of the MagickGetPage method is:</p>
672
673<pre class="code">
674 MagickBooleanType MagickGetPage(const MagickWand *wand,
675 unsigned long *width,unsigned long *height,long *x,long *y)
676</pre>
677
678<p>A description of each parameter follows:</p></ol>
679
680<h5>wand</h5>
681<ol><p>the magick wand.</p></ol>
682
683<h5>width</h5>
684<ol><p>the page width.</p></ol>
685
686<h5>height</h5>
687<ol><p>page height.</p></ol>
688
689<h5>x</h5>
690<ol><p>the page x-offset.</p></ol>
691
692<h5>y</h5>
693<ol><p>the page y-offset.</p></ol>
694
695 </div>
696<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
697_8c.html" target="source" name="MagickGetPointsize">MagickGetPointsize</a></h2>
698<div class="doc-section">
699
700<p>MagickGetPointsize() returns the font pointsize associated with the MagickWand.</p></ol>
701
702<p>The format of the MagickGetPointsize method is:</p>
703
704<pre class="code">
705 double MagickGetPointsize(MagickWand *wand)
706</pre>
707
708<p>A description of each parameter follows:</p></ol>
709
710<h5>wand</h5>
711<ol><p>the magick wand.</p></ol>
712
713 </div>
714<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
715_8c.html" target="source" name="MagickGetQuantumDepth">MagickGetQuantumDepth</a></h2>
716<div class="doc-section">
717
718<p>MagickGetQuantumDepth() returns the ImageMagick quantum depth as a string constant.</p></ol>
719
720<p>The format of the MagickGetQuantumDepth method is:</p>
721
722<pre class="code">
723 const char *MagickGetQuantumDepth(unsigned long *depth)
724</pre>
725
726<p>A description of each parameter follows:</p></ol>
727
728<h5>depth</h5>
729<ol><p>the quantum depth is returned as a number.</p></ol>
730
731 </div>
732<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
733_8c.html" target="source" name="MagickGetQuantumRange">MagickGetQuantumRange</a></h2>
734<div class="doc-section">
735
736<p>MagickGetQuantumRange() returns the ImageMagick quantum range as a string constant.</p></ol>
737
738<p>The format of the MagickGetQuantumRange method is:</p>
739
740<pre class="code">
741 const char *MagickGetQuantumRange(unsigned long *range)
742</pre>
743
744<p>A description of each parameter follows:</p></ol>
745
746<h5>range</h5>
747<ol><p>the quantum range is returned as a number.</p></ol>
748
749 </div>
750<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
751_8c.html" target="source" name="MagickGetReleaseDate">MagickGetReleaseDate</a></h2>
752<div class="doc-section">
753
754<p>MagickGetReleaseDate() returns the ImageMagick release date as a string constant.</p></ol>
755
756<p>The format of the MagickGetReleaseDate method is:</p>
757
758<pre class="code">
759 const char *MagickGetReleaseDate(void)
760</pre>
761
762 </div>
763<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
764_8c.html" target="source" name="MagickGetResource">MagickGetResource</a></h2>
765<div class="doc-section">
766
767<p>MagickGetResource() returns the specified resource in megabytes.</p></ol>
768
769<p>The format of the MagickGetResource method is:</p>
770
771<pre class="code">
772 MagickSizeType MagickGetResource(const ResourceType type)
773</pre>
774
775<p>A description of each parameter follows:</p></ol>
776
777<h5>wand</h5>
778<ol><p>the magick wand.</p></ol>
779
780 </div>
781<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
782_8c.html" target="source" name="MagickGetResourceLimit">MagickGetResourceLimit</a></h2>
783<div class="doc-section">
784
785<p>MagickGetResourceLimit() returns the specified resource limit in megabytes.</p></ol>
786
787<p>The format of the MagickGetResourceLimit method is:</p>
788
789<pre class="code">
790 MagickSizeType MagickGetResourceLimit(const ResourceType type)
791</pre>
792
793<p>A description of each parameter follows:</p></ol>
794
795<h5>wand</h5>
796<ol><p>the magick wand.</p></ol>
797
798 </div>
799<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
800_8c.html" target="source" name="MagickGetSamplingFactors">MagickGetSamplingFactors</a></h2>
801<div class="doc-section">
802
803<p>MagickGetSamplingFactors() gets the horizontal and vertical sampling factor.</p></ol>
804
805<p>The format of the MagickGetSamplingFactors method is:</p>
806
807<pre class="code">
808 double *MagickGetSamplingFactor(MagickWand *wand,
809 unsigned long *number_factors)
810</pre>
811
812<p>A description of each parameter follows:</p></ol>
813
814<h5>wand</h5>
815<ol><p>the magick wand.</p></ol>
816
817<h5>number_factors</h5>
818<ol><p>the number of factors in the returned array.</p></ol>
819
820 </div>
821<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
822_8c.html" target="source" name="MagickGetSize">MagickGetSize</a></h2>
823<div class="doc-section">
824
825<p>MagickGetSize() returns the size associated with the magick wand.</p></ol>
826
827<p>The format of the MagickGetSize method is:</p>
828
829<pre class="code">
830 MagickBooleanType MagickGetSize(const MagickWand *wand,
831 unsigned long *columns,unsigned long *rows)
832</pre>
833
834<p>A description of each parameter follows:</p></ol>
835
836<h5>wand</h5>
837<ol><p>the magick wand.</p></ol>
838
839<h5>columns</h5>
840<ol><p>the width in pixels.</p></ol>
841
842<h5>height</h5>
843<ol><p>the height in pixels.</p></ol>
844
845 </div>
846<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
847_8c.html" target="source" name="MagickGetSizeOffset">MagickGetSizeOffset</a></h2>
848<div class="doc-section">
849
850<p>MagickGetSizeOffset() returns the size offset associated with the magick wand.</p></ol>
851
852<p>The format of the MagickGetSizeOffset method is:</p>
853
854<pre class="code">
855 MagickBooleanType MagickGetSizeOffset(const MagickWand *wand,
856 long *offset)
857</pre>
858
859<p>A description of each parameter follows:</p></ol>
860
861<h5>wand</h5>
862<ol><p>the magick wand.</p></ol>
863
864<h5>offset</h5>
865<ol><p>the image offset.</p></ol>
866
867 </div>
868<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
869_8c.html" target="source" name="MagickGetType">MagickGetType</a></h2>
870<div class="doc-section">
871
872<p>MagickGetType() returns the wand type.</p></ol>
873
874<p>The format of the MagickGetType method is:</p>
875
876<pre class="code">
877 ImageType MagickGetType(MagickWand *wand)
878</pre>
879
880<p>A description of each parameter follows:</p></ol>
881
882<h5>wand</h5>
883<ol><p>the magick wand.</p></ol>
884
885 </div>
886<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
887_8c.html" target="source" name="MagickGetVersion">MagickGetVersion</a></h2>
888<div class="doc-section">
889
890<p>MagickGetVersion() returns the ImageMagick API version as a string constant and as a number.</p></ol>
891
892<p>The format of the MagickGetVersion method is:</p>
893
894<pre class="code">
895 const char *MagickGetVersion(unsigned long *version)
896</pre>
897
898<p>A description of each parameter follows:</p></ol>
899
900<h5>version</h5>
901<ol><p>the ImageMagick version is returned as a number.</p></ol>
902
903 </div>
904<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
905_8c.html" target="source" name="MagickProfileImage">MagickProfileImage</a></h2>
906<div class="doc-section">
907
908<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>
909
910<p>The format of the MagickProfileImage method is:</p>
911
912<pre class="code">
913 MagickBooleanType MagickProfileImage(MagickWand *wand,const char *name,
914 const void *profile,const size_t length)
915</pre>
916
917<p>A description of each parameter follows:</p></ol>
918
919<h5>wand</h5>
920<ol><p>the magick wand.</p></ol>
921
922<h5>name</h5>
923<ol><p>Name of profile to add or remove: ICC, IPTC, or generic profile.</p></ol>
924
925<h5>profile</h5>
926<ol><p>the profile.</p></ol>
927
928<h5>length</h5>
929<ol><p>the length of the profile.</p></ol>
930
931 </div>
932<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
933_8c.html" target="source" name="MagickRemoveImageProfile">MagickRemoveImageProfile</a></h2>
934<div class="doc-section">
935
936<p>MagickRemoveImageProfile() removes the named image profile and returns it.</p></ol>
937
938<p>The format of the MagickRemoveImageProfile method is:</p>
939
940<pre class="code">
941 unsigned char *MagickRemoveImageProfile(MagickWand *wand,
942 const char *name,size_t *length)
943</pre>
944
945<p>A description of each parameter follows:</p></ol>
946
947<h5>wand</h5>
948<ol><p>the magick wand.</p></ol>
949
950<h5>name</h5>
951<ol><p>Name of profile to return: ICC, IPTC, or generic profile.</p></ol>
952
953<h5>length</h5>
954<ol><p>the length of the profile.</p></ol>
955
956 </div>
957<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
958_8c.html" target="source" name="MagickSetAntialias">MagickSetAntialias</a></h2>
959<div class="doc-section">
960
961<p>MagickSetAntialias() sets the antialias propery of the wand.</p></ol>
962
963<p>The format of the MagickSetAntialias method is:</p>
964
965<pre class="code">
966 MagickBooleanType MagickSetAntialias(MagickWand *wand,
967 const MagickBooleanType antialias)
968</pre>
969
970<p>A description of each parameter follows:</p></ol>
971
972<h5>wand</h5>
973<ol><p>the magick wand.</p></ol>
974
975<h5>antialias</h5>
976<ol><p>the antialias property.</p></ol>
977
978 </div>
979<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
980_8c.html" target="source" name="MagickSetBackgroundColor">MagickSetBackgroundColor</a></h2>
981<div class="doc-section">
982
983<p>MagickSetBackgroundColor() sets the wand background color.</p></ol>
984
985<p>The format of the MagickSetBackgroundColor method is:</p>
986
987<pre class="code">
988 MagickBooleanType MagickSetBackgroundColor(MagickWand *wand,
989 const PixelWand *background)
990</pre>
991
992<p>A description of each parameter follows:</p></ol>
993
994<h5>wand</h5>
995<ol><p>the magick wand.</p></ol>
996
997<h5>background</h5>
998<ol><p>the background pixel wand.</p></ol>
999
1000 </div>
1001<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1002_8c.html" target="source" name="MagickSetColorspace">MagickSetColorspace</a></h2>
1003<div class="doc-section">
1004
1005<p>MagickSetColorspace() sets the wand colorspace type.</p></ol>
1006
1007<p>The format of the MagickSetColorspace method is:</p>
1008
1009<pre class="code">
1010 MagickBooleanType MagickSetColorspace(MagickWand *wand,
1011 const ColorspaceType colorspace)
1012</pre>
1013
1014<p>A description of each parameter follows:</p></ol>
1015
1016<h5>wand</h5>
1017<ol><p>the magick wand.</p></ol>
1018
1019<h5>colorspace</h5>
1020<ol><p>the wand colorspace.</p></ol>
1021
1022 </div>
1023<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1024_8c.html" target="source" name="MagickSetCompression">MagickSetCompression</a></h2>
1025<div class="doc-section">
1026
1027<p>MagickSetCompression() sets the wand compression type.</p></ol>
1028
1029<p>The format of the MagickSetCompression method is:</p>
1030
1031<pre class="code">
1032 MagickBooleanType MagickSetCompression(MagickWand *wand,
1033 const CompressionType compression)
1034</pre>
1035
1036<p>A description of each parameter follows:</p></ol>
1037
1038<h5>wand</h5>
1039<ol><p>the magick wand.</p></ol>
1040
1041<h5>compression</h5>
1042<ol><p>the wand compression.</p></ol>
1043
1044 </div>
1045<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1046_8c.html" target="source" name="MagickSetCompressionQuality">MagickSetCompressionQuality</a></h2>
1047<div class="doc-section">
1048
1049<p>MagickSetCompressionQuality() sets the wand compression quality.</p></ol>
1050
1051<p>The format of the MagickSetCompressionQuality method is:</p>
1052
1053<pre class="code">
1054 MagickBooleanType MagickSetCompressionQuality(MagickWand *wand,
1055 const unsigned long quality)
1056</pre>
1057
1058<p>A description of each parameter follows:</p></ol>
1059
1060<h5>wand</h5>
1061<ol><p>the magick wand.</p></ol>
1062
1063<h5>quality</h5>
1064<ol><p>the wand compression quality.</p></ol>
1065
1066 </div>
1067<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1068_8c.html" target="source" name="MagickSetDepth">MagickSetDepth</a></h2>
1069<div class="doc-section">
1070
1071<p>MagickSetDepth() sets the wand pixel depth.</p></ol>
1072
1073<p>The format of the MagickSetDepth method is:</p>
1074
1075<pre class="code">
1076 MagickBooleanType MagickSetDepth(MagickWand *wand,
1077 const unsigned long depth)
1078</pre>
1079
1080<p>A description of each parameter follows:</p></ol>
1081
1082<h5>wand</h5>
1083<ol><p>the magick wand.</p></ol>
1084
1085<h5>depth</h5>
1086<ol><p>the wand pixel depth.</p></ol>
1087
1088 </div>
1089<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
cristyd934d102009-10-10 12:55:13 +0000[diff] [blame]1090_8c.html" target="source" name="MagickSetExtract">MagickSetExtract</a></h2>
1091<div class="doc-section">
1092
1093<p>MagickSetExtract() sets the extract geometry before you read or write an image file. Use it for inline cropping (e.g. 200x200+0+0) or resizing (e.g.200x200).</p></ol>
1094
1095<p>The format of the MagickSetExtract method is:</p>
1096
1097<pre class="code">
1098 MagickBooleanType MagickSetExtract(MagickWand *wand,
1099 const char *geometry)
1100</pre>
1101
1102<p>A description of each parameter follows:</p></ol>
1103
1104<h5>wand</h5>
1105<ol><p>the magick wand.</p></ol>
1106
1107<h5>geometry</h5>
1108<ol><p>the extract geometry.</p></ol>
1109
1110 </div>
1111<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1112_8c.html" target="source" name="MagickSetFilename">MagickSetFilename</a></h2>
1113<div class="doc-section">
1114
1115<p>MagickSetFilename() sets the filename before you read or write an image file.</p></ol>
1116
1117<p>The format of the MagickSetFilename method is:</p>
1118
1119<pre class="code">
1120 MagickBooleanType MagickSetFilename(MagickWand *wand,
1121 const char *filename)
1122</pre>
1123
1124<p>A description of each parameter follows:</p></ol>
1125
1126<h5>wand</h5>
1127<ol><p>the magick wand.</p></ol>
1128
1129<h5>filename</h5>
1130<ol><p>the image filename.</p></ol>
1131
1132 </div>
1133<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1134_8c.html" target="source" name="MagickSetFont">MagickSetFont</a></h2>
1135<div class="doc-section">
1136
1137<p>MagickSetFont() sets the font associated with the MagickWand.</p></ol>
1138
1139<p>The format of the MagickSetFont method is:</p>
1140
1141<pre class="code">
1142 MagickBooleanType MagickSetFont(MagickWand *wand, const char *font)
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>font</h5>
1151<ol><p>the font</p></ol>
1152
1153 </div>
1154<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1155_8c.html" target="source" name="MagickSetFormat">MagickSetFormat</a></h2>
1156<div class="doc-section">
1157
1158<p>MagickSetFormat() sets the format of the magick wand.</p></ol>
1159
1160<p>The format of the MagickSetFormat method is:</p>
1161
1162<pre class="code">
1163 MagickBooleanType MagickSetFormat(MagickWand *wand,const char *format)
1164</pre>
1165
1166<p>A description of each parameter follows:</p></ol>
1167
1168<h5>wand</h5>
1169<ol><p>the magick wand.</p></ol>
1170
1171<h5>format</h5>
1172<ol><p>the image format.</p></ol>
1173
1174 </div>
1175<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1176_8c.html" target="source" name="MagickSetGravity">MagickSetGravity</a></h2>
1177<div class="doc-section">
1178
1179<p>MagickSetGravity() sets the gravity type.</p></ol>
1180
1181<p>The format of the MagickSetGravity type is:</p>
1182
1183<pre class="text">
1184 MagickBooleanType MagickSetGravity(MagickWand *wand,
1185 const GravityType type)
1186</pre>
1187
1188<p>A description of each parameter follows:</p></ol>
1189
1190<h5>wand</h5>
1191<ol><p>the magick wand.</p></ol>
1192
1193<h5>type</h5>
1194<ol><p>the gravity type.</p></ol>
1195
1196 </div>
1197<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]1198_8c.html" target="source" name="MagickSetImageArtifact">MagickSetImageArtifact</a></h2>
1199<div class="doc-section">
1200
1201<p>MagickSetImageArtifact() associates a artifact with an image.</p></ol>
1202
1203<p>The format of the MagickSetImageArtifact method is:</p>
1204
1205<pre class="code">
1206 MagickBooleanType MagickSetImageArtifact(MagickWand *wand,
1207 const char *artifact,const char *value)
1208</pre>
1209
1210<p>A description of each parameter follows:</p></ol>
1211
1212<h5>wand</h5>
1213<ol><p>the magick wand.</p></ol>
1214
1215<h5>artifact</h5>
1216<ol><p>the artifact.</p></ol>
1217
1218<h5>value</h5>
1219<ol><p>the value.</p></ol>
1220
1221 </div>
1222<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]1223_8c.html" target="source" name="MagickSetImageProfile">MagickSetImageProfile</a></h2>
1224<div class="doc-section">
1225
1226<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>
1227
1228<p>The format of the MagickSetImageProfile method is:</p>
1229
1230<pre class="code">
1231 MagickBooleanType MagickSetImageProfile(MagickWand *wand,
1232 const char *name,const void *profile,const size_t length)
1233</pre>
1234
1235<p>A description of each parameter follows:</p></ol>
1236
1237<h5>wand</h5>
1238<ol><p>the magick wand.</p></ol>
1239
1240<h5>name</h5>
1241<ol><p>Name of profile to add or remove: ICC, IPTC, or generic profile.</p></ol>
1242
1243<h5>profile</h5>
1244<ol><p>the profile.</p></ol>
1245
1246<h5>length</h5>
1247<ol><p>the length of the profile.</p></ol>
1248
1249 </div>
1250<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1251_8c.html" target="source" name="MagickSetImageProperty">MagickSetImageProperty</a></h2>
1252<div class="doc-section">
1253
1254<p>MagickSetImageProperty() associates a property with an image.</p></ol>
1255
1256<p>The format of the MagickSetImageProperty method is:</p>
1257
1258<pre class="code">
1259 MagickBooleanType MagickSetImageProperty(MagickWand *wand,
1260 const char *property,const char *value)
1261</pre>
1262
1263<p>A description of each parameter follows:</p></ol>
1264
1265<h5>wand</h5>
1266<ol><p>the magick wand.</p></ol>
1267
1268<h5>property</h5>
1269<ol><p>the property.</p></ol>
1270
1271<h5>value</h5>
1272<ol><p>the value.</p></ol>
1273
1274 </div>
1275<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1276_8c.html" target="source" name="MagickSetInterlaceScheme">MagickSetInterlaceScheme</a></h2>
1277<div class="doc-section">
1278
1279<p>MagickSetInterlaceScheme() sets the image compression.</p></ol>
1280
1281<p>The format of the MagickSetInterlaceScheme method is:</p>
1282
1283<pre class="code">
1284 MagickBooleanType MagickSetInterlaceScheme(MagickWand *wand,
1285 const InterlaceType interlace_scheme)
1286</pre>
1287
1288<p>A description of each parameter follows:</p></ol>
1289
1290<h5>wand</h5>
1291<ol><p>the magick wand.</p></ol>
1292
1293<h5>interlace_scheme</h5>
1294<ol><p>the image interlace scheme: NoInterlace, LineInterlace, PlaneInterlace, PartitionInterlace.</p></ol>
1295
1296 </div>
1297<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1298_8c.html" target="source" name="MagickSetInterpolateMethod">MagickSetInterpolateMethod</a></h2>
1299<div class="doc-section">
1300
1301<p>MagickSetInterpolateMethod() sets the interpolate pixel method.</p></ol>
1302
1303<p>The format of the MagickSetInterpolateMethod method is:</p>
1304
1305<pre class="code">
1306 MagickBooleanType MagickSetInterpolateMethod(MagickWand *wand,
1307 const InterpolateMethodPixel method)
1308</pre>
1309
1310<p>A description of each parameter follows:</p></ol>
1311
1312<h5>wand</h5>
1313<ol><p>the magick wand.</p></ol>
1314
1315<h5>method</h5>
1316<ol><p>the interpolate pixel method.</p></ol>
1317
1318 </div>
1319<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1320_8c.html" target="source" name="MagickSetOption">MagickSetOption</a></h2>
1321<div class="doc-section">
1322
1323<p>MagickSetOption() associates one or options with the wand (.e.g MagickSetOption(wand,"jpeg:perserve","yes")).</p></ol>
1324
1325<p>The format of the MagickSetOption method is:</p>
1326
1327<pre class="code">
1328 MagickBooleanType MagickSetOption(MagickWand *wand,const char *key,
1329 const char *value)
1330</pre>
1331
1332<p>A description of each parameter follows:</p></ol>
1333
1334<h5>wand</h5>
1335<ol><p>the magick wand.</p></ol>
1336
1337<h5>key</h5>
1338<ol><p>The key.</p></ol>
1339
1340<h5>value</h5>
1341<ol><p>The value.</p></ol>
1342
1343 </div>
1344<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1345_8c.html" target="source" name="MagickSetOrientation">MagickSetOrientation</a></h2>
1346<div class="doc-section">
1347
1348<p>MagickSetOrientation() sets the wand orientation type.</p></ol>
1349
1350<p>The format of the MagickSetOrientation method is:</p>
1351
1352<pre class="code">
1353 MagickBooleanType MagickSetOrientation(MagickWand *wand,
1354 const OrientationType orientation)
1355</pre>
1356
1357<p>A description of each parameter follows:</p></ol>
1358
1359<h5>wand</h5>
1360<ol><p>the magick wand.</p></ol>
1361
1362<h5>orientation</h5>
1363<ol><p>the wand orientation.</p></ol>
1364
1365 </div>
1366<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1367_8c.html" target="source" name="MagickSetPage">MagickSetPage</a></h2>
1368<div class="doc-section">
1369
1370<p>MagickSetPage() sets the page geometry of the magick wand.</p></ol>
1371
1372<p>The format of the MagickSetPage method is:</p>
1373
1374<pre class="code">
1375 MagickBooleanType MagickSetPage(MagickWand *wand,
1376 const unsigned long width,const unsigned long height,const long x,
1377 const long y)
1378</pre>
1379
1380<p>A description of each parameter follows:</p></ol>
1381
1382<h5>wand</h5>
1383<ol><p>the magick wand.</p></ol>
1384
1385<h5>width</h5>
1386<ol><p>the page width.</p></ol>
1387
1388<h5>height</h5>
1389<ol><p>the page height.</p></ol>
1390
1391<h5>x</h5>
1392<ol><p>the page x-offset.</p></ol>
1393
1394<h5>y</h5>
1395<ol><p>the page y-offset.</p></ol>
1396
1397 </div>
1398<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1399_8c.html" target="source" name="MagickSetPassphrase">MagickSetPassphrase</a></h2>
1400<div class="doc-section">
1401
1402<p>MagickSetPassphrase() sets the passphrase.</p></ol>
1403
1404<p>The format of the MagickSetPassphrase method is:</p>
1405
1406<pre class="code">
1407 MagickBooleanType MagickSetPassphrase(MagickWand *wand,
1408 const char *passphrase)
1409</pre>
1410
1411<p>A description of each parameter follows:</p></ol>
1412
1413<h5>wand</h5>
1414<ol><p>the magick wand.</p></ol>
1415
1416<h5>passphrase</h5>
1417<ol><p>the passphrase.</p></ol>
1418
1419 </div>
1420<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1421_8c.html" target="source" name="MagickSetPointsize">MagickSetPointsize</a></h2>
1422<div class="doc-section">
1423
1424<p>MagickSetPointsize() sets the font pointsize associated with the MagickWand.</p></ol>
1425
1426<p>The format of the MagickSetPointsize method is:</p>
1427
1428<pre class="code">
1429 MagickBooleanType MagickSetPointsize(MagickWand *wand,
1430 const double pointsize)
1431</pre>
1432
1433<p>A description of each parameter follows:</p></ol>
1434
1435<h5>wand</h5>
1436<ol><p>the magick wand.</p></ol>
1437
1438<h5>pointsize</h5>
1439<ol><p>the size of the font</p></ol>
1440
1441 </div>
1442<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1443_8c.html" target="source" name="MagickSetProgressMonitor">MagickSetProgressMonitor</a></h2>
1444<div class="doc-section">
1445
1446<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>
1447
1448<pre class="text">
1449 MagickBooleanType MagickProgressMonitor(const char *text,
1450 const MagickOffsetType offset,const MagickSizeType span,
1451 void *client_data)
1452</pre>
1453
1454<p>If the progress monitor returns MagickFalse, the current operation is interrupted.</p></ol>
1455
1456<p>The format of the MagickSetProgressMonitor method is:</p>
1457
1458<pre class="code">
1459 MagickProgressMonitor MagickSetProgressMonitor(MagickWand *wand
1460 const MagickProgressMonitor progress_monitor,void *client_data)
1461</pre>
1462
1463<p>A description of each parameter follows:</p></ol>
1464
1465<h5>wand</h5>
1466<ol><p>the magick wand.</p></ol>
1467
1468<h5>progress_monitor</h5>
1469<ol><p>Specifies a pointer to a method to monitor progress of an image operation.</p></ol>
1470
1471<h5>client_data</h5>
1472<ol><p>Specifies a pointer to any client data.</p></ol>
1473
1474 </div>
1475<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1476_8c.html" target="source" name="MagickSetResourceLimit">MagickSetResourceLimit</a></h2>
1477<div class="doc-section">
1478
1479<p>MagickSetResourceLimit() sets the limit for a particular resource in megabytes.</p></ol>
1480
1481<p>The format of the MagickSetResourceLimit method is:</p>
1482
1483<pre class="code">
1484 MagickBooleanType MagickSetResourceLimit(const ResourceType type,
1485 const MagickSizeType limit)
1486</pre>
1487
1488<p>A description of each parameter follows:</p></ol>
1489
1490<h5>type</h5>
1491<ol><p>the type of resource: AreaResource, MemoryResource, MapResource, DiskResource, FileResource.</p></ol>
1492
1493<p>o The maximum limit for the resource.</p></ol>
1494
1495 </div>
1496<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1497_8c.html" target="source" name="MagickSetResolution">MagickSetResolution</a></h2>
1498<div class="doc-section">
1499
1500<p>MagickSetResolution() sets the image resolution.</p></ol>
1501
1502<p>The format of the MagickSetResolution method is:</p>
1503
1504<pre class="code">
1505 MagickBooleanType MagickSetResolution(MagickWand *wand,
1506 const double x_resolution,const doubtl y_resolution)
1507</pre>
1508
1509<p>A description of each parameter follows:</p></ol>
1510
1511<h5>wand</h5>
1512<ol><p>the magick wand.</p></ol>
1513
1514<h5>x_resolution</h5>
1515<ol><p>the image x resolution.</p></ol>
1516
1517<h5>y_resolution</h5>
1518<ol><p>the image y resolution.</p></ol>
1519
1520 </div>
1521<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1522_8c.html" target="source" name="MagickSetSamplingFactors">MagickSetSamplingFactors</a></h2>
1523<div class="doc-section">
1524
1525<p>MagickSetSamplingFactors() sets the image sampling factors.</p></ol>
1526
1527<p>The format of the MagickSetSamplingFactors method is:</p>
1528
1529<pre class="code">
1530 MagickBooleanType MagickSetSamplingFactors(MagickWand *wand,
1531 const unsigned long number_factors,const double *sampling_factors)
1532</pre>
1533
1534<p>A description of each parameter follows:</p></ol>
1535
1536<h5>wand</h5>
1537<ol><p>the magick wand.</p></ol>
1538
1539<h5>number_factoes</h5>
1540<ol><p>the number of factors.</p></ol>
1541
1542<h5>sampling_factors</h5>
1543<ol><p>An array of doubles representing the sampling factor for each color component (in RGB order).</p></ol>
1544
1545 </div>
1546<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1547_8c.html" target="source" name="MagickSetSize">MagickSetSize</a></h2>
1548<div class="doc-section">
1549
1550<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>
1551
1552<p>The format of the MagickSetSize method is:</p>
1553
1554<pre class="code">
1555 MagickBooleanType MagickSetSize(MagickWand *wand,
1556 const unsigned long columns,const unsigned long rows)
1557</pre>
1558
1559<p>A description of each parameter follows:</p></ol>
1560
1561<h5>wand</h5>
1562<ol><p>the magick wand.</p></ol>
1563
1564<h5>columns</h5>
1565<ol><p>the width in pixels.</p></ol>
1566
1567<h5>rows</h5>
1568<ol><p>the rows in pixels.</p></ol>
1569
1570 </div>
1571<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1572_8c.html" target="source" name="MagickSetSizeOffset">MagickSetSizeOffset</a></h2>
1573<div class="doc-section">
1574
1575<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>
1576
1577<p>The format of the MagickSetSizeOffset method is:</p>
1578
1579<pre class="code">
1580 MagickBooleanType MagickSetSizeOffset(MagickWand *wand,
1581 const unsigned long columns,const unsigned long rows,
1582 const long offset)
1583</pre>
1584
1585<p>A description of each parameter follows:</p></ol>
1586
1587<h5>wand</h5>
1588<ol><p>the magick wand.</p></ol>
1589
1590<h5>columns</h5>
1591<ol><p>the image width in pixels.</p></ol>
1592
1593<h5>rows</h5>
1594<ol><p>the image rows in pixels.</p></ol>
1595
1596<h5>offset</h5>
1597<ol><p>the image offset.</p></ol>
1598
1599 </div>
1600<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-property
1601_8c.html" target="source" name="MagickSetType">MagickSetType</a></h2>
1602<div class="doc-section">
1603
1604<p>MagickSetType() sets the image type attribute.</p></ol>
1605
1606<p>The format of the MagickSetType method is:</p>
1607
1608<pre class="code">
1609 MagickBooleanType MagickSetType(MagickWand *wand,
1610 const ImageType image_type)
1611</pre>
1612
1613<p>A description of each parameter follows:</p></ol>
1614
1615<h5>wand</h5>
1616<ol><p>the magick wand.</p></ol>
1617
1618<h5>image_type</h5>
1619<ol><p>the image type: UndefinedType, BilevelType, GrayscaleType, GrayscaleMatteType, PaletteType, PaletteMatteType, TrueColorType, TrueColorMatteType, ColorSeparationType, ColorSeparationMatteType, or OptimizeType.</p></ol>
1620
1621 </div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]1622
1623</div>
1624
1625<div id="linkbar">
1626 <!-- <span id="linkbar-west">&nbsp;</span> -->
1627 <span id="linkbar-center">
1628 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
1629 <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
cristy2744bd92009-11-08 22:57:52 +0000[diff] [blame^]1630 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]1631 </span>
1632 <span id="linkbar-east">&nbsp;</span>
1633 </div>
1634 <div class="footer">
1635 <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
1636 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
1637 </div>
1638 <div style="clear: both; margin: 0; width: 100%; "></div>
1639</body>
1640</html>