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