Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 0f61e614b9d5c8a157f05f02d60009381d86f6ad / . / www / api / attribute.html
blob: b6fe5f4fbbfddc96e29857ede143522ff918a316 [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>
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: MagickCore, C API for ImageMagick: Set Text Attributes</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="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"/>
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">
cristy0f61e612009-11-10 20:03:57 +0000[diff] [blame^]126 <a href="http://www.hygi.de">Reinigungsmittel</a><!-- 201002000400+ -->
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]127</div>
128<div class="sponsor">
cristy0f61e612009-11-10 20:03:57 +0000[diff] [blame^]129 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201004010120 Buchhorn -->
130</div>
131<div class="sponsor">
132 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]133</div>
134<div class="sponsor">
135 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
136</div>
137<div class="sponsor">
138 <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
139</div>
140<div class="sponsor">
141 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
142</div>
143<div class="sponsor">
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]144 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
145</div>
146</div>
147</div>
148
149
150</div>
151
152<div class="main">
153
154<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>
155
156<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
157_8c.html" target="source" name="GetImageChannelDepth">GetImageChannelDepth</a></h2>
158<div class="doc-section">
159
160<p>GetImageChannelDepth() returns the depth of a particular image channel.</p></ol>
161
162<p>The format of the GetImageChannelDepth method is:</p>
163
164<pre class="code">
165 unsigned long GetImageDepth(const Image *image,ExceptionInfo *exception)
166 unsigned long GetImageChannelDepth(const Image *image,
167 const ChannelType channel,ExceptionInfo *exception)
168</pre>
169
170<p>A description of each parameter follows:</p></ol>
171
172<h5>image</h5>
173<ol><p>the image.</p></ol>
174
175<h5>channel</h5>
176<ol><p>the channel.</p></ol>
177
178<h5>exception</h5>
179<ol><p>return any errors or warnings in this structure.</p></ol>
180
181 </div>
182<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
183_8c.html" target="source" name="GetImageQuantumDepth">GetImageQuantumDepth</a></h2>
184<div class="doc-section">
185
186<p>GetImageQuantumDepth() returns the depth of the image rounded to a legal quantum depth: 8, 16, or 32.</p></ol>
187
188<p>The format of the GetImageQuantumDepth method is:</p>
189
190<pre class="code">
191 unsigned long GetImageQuantumDepth(const Image *image,
192 const MagickBooleanType constrain)
193</pre>
194
195<p>A description of each parameter follows:</p></ol>
196
197<h5>image</h5>
198<ol><p>the image.</p></ol>
199
200<h5>constrain</h5>
201<ol><p>A value other than MagickFalse, constrains the depth to a maximum of MAGICKCORE_QUANTUM_DEPTH.</p></ol>
202
203 </div>
204<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
205_8c.html" target="source" name="GetImageType">GetImageType</a></h2>
206<div class="doc-section">
207
208<p>GetImageType() returns the potential type of image:</p></ol>
209
210<p>Bilevel Grayscale GrayscaleMatte Palette PaletteMatte TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte</p></ol>
211
212<p>To ensure the image type matches its potential, use SetImageType():</p>
213
214<pre class="text">
215 (void) SetImageType(image,GetImageType(image));
216</pre>
217
218<p>The format of the GetImageType method is:</p>
219
220<pre class="code">
221 ImageType GetImageType(const Image *image,ExceptionInfo *exception)
222</pre>
223
224<p>A description of each parameter follows:</p></ol>
225
226<h5>image</h5>
227<ol><p>the image.</p></ol>
228
229<h5>exception</h5>
230<ol><p>return any errors or warnings in this structure.</p></ol>
231
232 </div>
233<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
234_8c.html" target="source" name="IsGrayImage">IsGrayImage</a></h2>
235<div class="doc-section">
236
237<p>IsGrayImage() returns MagickTrue if all the pixels in the image have the same red, green, and blue intensities.</p></ol>
238
239<p>The format of the IsGrayImage method is:</p>
240
241<pre class="code">
242 MagickBooleanType IsGrayImage(const Image *image,
243 ExceptionInfo *exception)
244</pre>
245
246<p>A description of each parameter follows:</p></ol>
247
248<h5>image</h5>
249<ol><p>the image.</p></ol>
250
251<h5>exception</h5>
252<ol><p>return any errors or warnings in this structure.</p></ol>
253
254 </div>
255<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
256_8c.html" target="source" name="IsMonochromeImage">IsMonochromeImage</a></h2>
257<div class="doc-section">
258
259<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>
260
261<p>The format of the IsMonochromeImage method is:</p>
262
263<pre class="code">
264 MagickBooleanType IsMonochromeImage(const Image *image,
265 ExceptionInfo *exception)
266</pre>
267
268<p>A description of each parameter follows:</p></ol>
269
270<h5>image</h5>
271<ol><p>the image.</p></ol>
272
273<h5>exception</h5>
274<ol><p>return any errors or warnings in this structure.</p></ol>
275
276 </div>
277<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
278_8c.html" target="source" name="IsOpaqueImage">IsOpaqueImage</a></h2>
279<div class="doc-section">
280
281<p>IsOpaqueImage() returns MagickTrue if none of the pixels in the image have an opacity value other than opaque (0).</p></ol>
282
283<p>The format of the IsOpaqueImage method is:</p>
284
285<pre class="code">
286 MagickBooleanType IsOpaqueImage(const Image *image,
287 ExceptionInfo *exception)
288</pre>
289
290<p>A description of each parameter follows:</p></ol>
291
292<h5>image</h5>
293<ol><p>the image.</p></ol>
294
295<h5>exception</h5>
296<ol><p>return any errors or warnings in this structure.</p></ol>
297
298 </div>
299<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
300_8c.html" target="source" name="SetImageChannelDepth">SetImageChannelDepth</a></h2>
301<div class="doc-section">
302
303<p>SetImageChannelDepth() sets the depth of the image.</p></ol>
304
305<p>The format of the SetImageChannelDepth method is:</p>
306
307<pre class="code">
308 MagickBooleanType SetImageDepth(Image *image,const unsigned long depth)
309 MagickBooleanType SetImageChannelDepth(Image *image,
310 const ChannelType channel,const unsigned long depth)
311</pre>
312
313<p>A description of each parameter follows:</p></ol>
314
315<h5>image</h5>
316<ol><p>the image.</p></ol>
317
318<h5>channel</h5>
319<ol><p>the channel.</p></ol>
320
321<h5>depth</h5>
322<ol><p>the image depth.</p></ol>
323
324 </div>
325
326</div>
327
328<div id="linkbar">
329 <!-- <span id="linkbar-west">&nbsp;</span> -->
330 <span id="linkbar-center">
331 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
332 <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
cristy2744bd92009-11-08 22:57:52 +0000[diff] [blame]333 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]334 </span>
335 <span id="linkbar-east">&nbsp;</span>
336 </div>
337 <div class="footer">
338 <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
339 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
340 </div>
341 <div style="clear: both; margin: 0; width: 100%; "></div>
342</body>
343</html>