Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 1f9e1edef88f3d6b9f37af9289c7eeeb8165feb1 / . / www / api / attribute.html
blob: bb15a5831a012a6a7399c2188f168b07b86c443d [file] [log] [blame]
cristy83543962009-10-16 19:04:28 +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>
cristy1f9e1ed2009-11-18 04:09:38 +0000[diff] [blame^]5 <meta http-equiv="Content-Type" value="application/xhtml+xml" />
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
7 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
8 <style type="text/css" media="screen,projection"><!--
9 @import url("../../www/magick.css");
10 --></style>
11 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
12 <title>ImageMagick: MagickCore, C API for ImageMagick: Set Text Attributes</title>
13 <meta http-equiv="Content-Language" content="en-US"/>
14 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
15 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
16 <meta name="Generator" content="PHP"/>
17 <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, set, text, attributes, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
18 <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."/>
19 <meta name="Rating" content="GENERAL"/>
20 <meta name="Robots" content="INDEX, FOLLOW"/>
21 <meta name="Generator" content="ImageMagick Studio LLC"/>
22 <meta name="Author" content="ImageMagick Studio LLC"/>
23 <meta name="Revisit-after" content="2 DAYS"/>
24 <meta name="Resource-type" content="document"/>
25 <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
26 <meta name="Distribution" content="Global"/>
27</head>
28
29<body id="www-imagemagick-org">
30<div class="titlebar">
31<a href="../../index.html">
32 <img src="../../images/script.png" alt="[ImageMagick]"
33 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
34<a href="http://www.networkredux.com">
35 <img src="../../images/networkredux.png" alt="[sponsor]"
36 style="margin: 45px auto; border: 0px; float: left;" /></a>
37<a href="http://www.imagemagick.org/discourse-server/">
38 <img src="../../images/logo.jpg" alt=""
39 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
40<a href="../../index.html">
41 <img src="../../images/sprite.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43</div>
44
45<div class="eastbar">
46
47<div class="menu">
48 <a href="../../index.html">About ImageMagick</a>
49</div>
50<div class="sep"></div>
51<div class="menu">
52 <a href="../../www/command-line-tools.html">Command-line Tools</a>
53</div>
54<div class="sub">
55 <a href="../../www/command-line-processing.html">Processing</a>
56</div>
57<div class="sub">
58 <a href="../../www/command-line-options.html">Options</a>
59</div>
60<div class="sub">
61 <a href="http://www.imagemagick.org/Usage/">Usage</a>
62</div>
63<div class="menu">
64 <a href="../../www/api.html">Program Interfaces</a>
65</div>
66<div class="sub">
67 <a href="../../www/magick-wand.html">MagickWand</a>
68</div>
69<div class="sub">
70 <a href="../../www/magick-core.html">MagickCore</a>
71</div>
72<div class="sub">
73 <a href="../../www/perl-magick.html">PerlMagick</a>
74</div>
75<div class="sub">
76 <a href="../../Magick++/">Magick++</a>
77</div>
78<div class="menu">
79 <a href="../../www/architecture.html">Architecture</a>
80</div>
81<div class="sep"></div>
82<div class="menu">
83 <a href="../../www/install-source.html">Install from Source</a>
84</div>
85<div class="sub">
86 <a href="../../www/install-source.html#unix">Unix</a>
87</div>
88<div class="sub">
89 <a href="../../www/install-source.html#windows">Windows</a>
90 </div>
91<div class="menu">
92 <a href="../../www/binary-releases.html">Binary Releases</a>
93</div>
94<div class="sub">
95 <a href="../../www/binary-releases.html#unix">Unix</a>
96</div>
97<div class="sub">
98 <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
99</div>
100<div class="sub">
101 <a href="../../www/binary-releases.html#windows">Windows</a>
102</div>
103<div class="menu">
104 <a href="../../www/resources.html">Resources</a>
105</div>
106<div class="sep"></div>
107<div class="menu">
108 <a href="../../www/download.html">Download</a>
109</div>
110<div class="sep"></div>
111<div class="menu">
112 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
113</div>
114<div class="sep"></div>
115<div class="menu">
116 <a href="../../www/sitemap.html">Site Map</a>
117</div>
118<div class="sub">
119 <a href="../../www/links.html">Links</a>
120</div>
121<div class="sep"></div>
122<div class="menu">
123 <a href="../../www/sponsors.html">Sponsors:</a>
124
125<div class="sponsbox">
126<div class="sponsor">
cristy1f9e1ed2009-11-18 04:09:38 +0000[diff] [blame^]127 <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20101101000200 -->
128</div>
129<div class="sponsor">
130 <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
cristy5f2356f2009-11-16 00:40:46 +0000[diff] [blame]131</div>
132<div class="sponsor">
cristy0f61e612009-11-10 20:03:57 +0000[diff] [blame]133 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201004010120 Buchhorn -->
134</div>
135<div class="sponsor">
136 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]137</div>
138<div class="sponsor">
139 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
140</div>
141<div class="sponsor">
142 <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
143</div>
144<div class="sponsor">
145 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
146</div>
147<div class="sponsor">
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]148 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
149</div>
150</div>
151</div>
152
153
154</div>
155
156<div class="main">
157
158<p class="navigation-index">[<a href="#GetImageChannelDepth">GetImageChannelDepth</a> &bull; <a href="#GetImageQuantumDepth">GetImageQuantumDepth</a> &bull; <a href="#GetImageType">GetImageType</a> &bull; <a href="#IsGrayImage">IsGrayImage</a> &bull; <a href="#IsMonochromeImage">IsMonochromeImage</a> &bull; <a href="#IsOpaqueImage">IsOpaqueImage</a> &bull; <a href="#SetImageChannelDepth">SetImageChannelDepth</a>]</p>
159
160<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
161_8c.html" target="source" name="GetImageChannelDepth">GetImageChannelDepth</a></h2>
162<div class="doc-section">
163
164<p>GetImageChannelDepth() returns the depth of a particular image channel.</p></ol>
165
166<p>The format of the GetImageChannelDepth method is:</p>
167
168<pre class="code">
169 unsigned long GetImageDepth(const Image *image,ExceptionInfo *exception)
170 unsigned long GetImageChannelDepth(const Image *image,
171 const ChannelType channel,ExceptionInfo *exception)
172</pre>
173
174<p>A description of each parameter follows:</p></ol>
175
176<h5>image</h5>
177<ol><p>the image.</p></ol>
178
179<h5>channel</h5>
180<ol><p>the channel.</p></ol>
181
182<h5>exception</h5>
183<ol><p>return any errors or warnings in this structure.</p></ol>
184
185 </div>
186<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
187_8c.html" target="source" name="GetImageQuantumDepth">GetImageQuantumDepth</a></h2>
188<div class="doc-section">
189
190<p>GetImageQuantumDepth() returns the depth of the image rounded to a legal quantum depth: 8, 16, or 32.</p></ol>
191
192<p>The format of the GetImageQuantumDepth method is:</p>
193
194<pre class="code">
195 unsigned long GetImageQuantumDepth(const Image *image,
196 const MagickBooleanType constrain)
197</pre>
198
199<p>A description of each parameter follows:</p></ol>
200
201<h5>image</h5>
202<ol><p>the image.</p></ol>
203
204<h5>constrain</h5>
205<ol><p>A value other than MagickFalse, constrains the depth to a maximum of MAGICKCORE_QUANTUM_DEPTH.</p></ol>
206
207 </div>
208<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
209_8c.html" target="source" name="GetImageType">GetImageType</a></h2>
210<div class="doc-section">
211
212<p>GetImageType() returns the potential type of image:</p></ol>
213
214<p>Bilevel Grayscale GrayscaleMatte Palette PaletteMatte TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte</p></ol>
215
216<p>To ensure the image type matches its potential, use SetImageType():</p>
217
218<pre class="text">
219 (void) SetImageType(image,GetImageType(image));
220</pre>
221
222<p>The format of the GetImageType method is:</p>
223
224<pre class="code">
225 ImageType GetImageType(const Image *image,ExceptionInfo *exception)
226</pre>
227
228<p>A description of each parameter follows:</p></ol>
229
230<h5>image</h5>
231<ol><p>the image.</p></ol>
232
233<h5>exception</h5>
234<ol><p>return any errors or warnings in this structure.</p></ol>
235
236 </div>
237<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
238_8c.html" target="source" name="IsGrayImage">IsGrayImage</a></h2>
239<div class="doc-section">
240
241<p>IsGrayImage() returns MagickTrue if all the pixels in the image have the same red, green, and blue intensities.</p></ol>
242
243<p>The format of the IsGrayImage method is:</p>
244
245<pre class="code">
246 MagickBooleanType IsGrayImage(const Image *image,
247 ExceptionInfo *exception)
248</pre>
249
250<p>A description of each parameter follows:</p></ol>
251
252<h5>image</h5>
253<ol><p>the image.</p></ol>
254
255<h5>exception</h5>
256<ol><p>return any errors or warnings in this structure.</p></ol>
257
258 </div>
259<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
260_8c.html" target="source" name="IsMonochromeImage">IsMonochromeImage</a></h2>
261<div class="doc-section">
262
263<p>IsMonochromeImage() returns MagickTrue if all the pixels in the image have the same red, green, and blue intensities and the intensity is either 0 or QuantumRange.</p></ol>
264
265<p>The format of the IsMonochromeImage method is:</p>
266
267<pre class="code">
268 MagickBooleanType IsMonochromeImage(const Image *image,
269 ExceptionInfo *exception)
270</pre>
271
272<p>A description of each parameter follows:</p></ol>
273
274<h5>image</h5>
275<ol><p>the image.</p></ol>
276
277<h5>exception</h5>
278<ol><p>return any errors or warnings in this structure.</p></ol>
279
280 </div>
281<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
282_8c.html" target="source" name="IsOpaqueImage">IsOpaqueImage</a></h2>
283<div class="doc-section">
284
285<p>IsOpaqueImage() returns MagickTrue if none of the pixels in the image have an opacity value other than opaque (0).</p></ol>
286
287<p>The format of the IsOpaqueImage method is:</p>
288
289<pre class="code">
290 MagickBooleanType IsOpaqueImage(const Image *image,
291 ExceptionInfo *exception)
292</pre>
293
294<p>A description of each parameter follows:</p></ol>
295
296<h5>image</h5>
297<ol><p>the image.</p></ol>
298
299<h5>exception</h5>
300<ol><p>return any errors or warnings in this structure.</p></ol>
301
302 </div>
303<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
304_8c.html" target="source" name="SetImageChannelDepth">SetImageChannelDepth</a></h2>
305<div class="doc-section">
306
307<p>SetImageChannelDepth() sets the depth of the image.</p></ol>
308
309<p>The format of the SetImageChannelDepth method is:</p>
310
311<pre class="code">
312 MagickBooleanType SetImageDepth(Image *image,const unsigned long depth)
313 MagickBooleanType SetImageChannelDepth(Image *image,
314 const ChannelType channel,const unsigned long depth)
315</pre>
316
317<p>A description of each parameter follows:</p></ol>
318
319<h5>image</h5>
320<ol><p>the image.</p></ol>
321
322<h5>channel</h5>
323<ol><p>the channel.</p></ol>
324
325<h5>depth</h5>
326<ol><p>the image depth.</p></ol>
327
328 </div>
329
330</div>
331
332<div id="linkbar">
333 <!-- <span id="linkbar-west">&nbsp;</span> -->
334 <span id="linkbar-center">
335 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
336 <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
cristy1f9e1ed2009-11-18 04:09:38 +0000[diff] [blame^]337 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]338 </span>
339 <span id="linkbar-east">&nbsp;</span>
340 </div>
341 <div class="footer">
342 <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
343 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
344 </div>
345 <div style="clear: both; margin: 0; width: 100%; "></div>
346</body>
347</html>