Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 66322f00f70ddaad6e57b8cf9c87e40a8e7d9f7c / . / www / api / attribute.html
blob: 61f8ed0d7d1c03ec11bb19454a158c94822e383c [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +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">
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame]3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]5 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +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" />
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]8 <style type="text/css" media="all">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]9 @import url("../../www/magick.css");
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]10 </style>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]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"/>
cristy16af1cb2009-12-11 21:38:29 +0000[diff] [blame]25 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]26 <meta name="Distribution" content="Global"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]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
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]47<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]48 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]49</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]50<div class="sep"></div>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]51<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]52 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]53</div>
54<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]55 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]56</div>
57<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]58 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]59</div>
60<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]61 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]62</div>
63<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]64 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]65</div>
66<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]67 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]68</div>
69<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]70 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]71</div>
72<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]73 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]74</div>
75<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]76 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]77</div>
78<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]79 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]80</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]81<div class="sep"></div>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]82<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]83 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]84</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]86 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]87</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]89 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]90 </div>
91<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]92 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]93</div>
94<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]95 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]96</div>
97<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]98 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]99</div>
100<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]101 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]102</div>
103<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]104 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]105</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]106<div class="sep"></div>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]107<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]108 <a title="Download" href="../../www/download.html">Download</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]110<div class="sep"></div>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]111<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]112 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]114<div class="sep"></div>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]115<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Site Map: Links"href="../../www/links.html">Links</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]120</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]121<div class="sep"></div>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]122<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]123 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]124
125<div class="sponsbox">
126<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]127 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy7d34ef22010-03-25 01:11:22 +0000[diff] [blame]128</div>
129<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]130 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy13538962010-02-26 17:53:04 +0000[diff] [blame]131</div>
132<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]133 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
cristy5f2356f2009-11-16 00:40:46 +0000[diff] [blame]134</div>
135<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]136 <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
cristy0f61e612009-11-10 20:03:57 +0000[diff] [blame]137</div>
138<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]139 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]142 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]143</div>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]144</div>
145</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]146
147
148</div>
149
150<div class="main">
151
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]152<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>
153
154<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
155_8c.html" target="source" name="GetImageChannelDepth">GetImageChannelDepth</a></h2>
156<div class="doc-section">
157
158<p>GetImageChannelDepth() returns the depth of a particular image channel.</p></ol>
159
160<p>The format of the GetImageChannelDepth method is:</p>
161
162<pre class="code">
163 unsigned long GetImageDepth(const Image *image,ExceptionInfo *exception)
164 unsigned long GetImageChannelDepth(const Image *image,
165 const ChannelType channel,ExceptionInfo *exception)
166</pre>
167
168<p>A description of each parameter follows:</p></ol>
169
170<h5>image</h5>
171<ol><p>the image.</p></ol>
172
173<h5>channel</h5>
174<ol><p>the channel.</p></ol>
175
176<h5>exception</h5>
177<ol><p>return any errors or warnings in this structure.</p></ol>
178
179 </div>
180<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
181_8c.html" target="source" name="GetImageQuantumDepth">GetImageQuantumDepth</a></h2>
182<div class="doc-section">
183
184<p>GetImageQuantumDepth() returns the depth of the image rounded to a legal quantum depth: 8, 16, or 32.</p></ol>
185
186<p>The format of the GetImageQuantumDepth method is:</p>
187
188<pre class="code">
189 unsigned long GetImageQuantumDepth(const Image *image,
190 const MagickBooleanType constrain)
191</pre>
192
193<p>A description of each parameter follows:</p></ol>
194
195<h5>image</h5>
196<ol><p>the image.</p></ol>
197
198<h5>constrain</h5>
199<ol><p>A value other than MagickFalse, constrains the depth to a maximum of MAGICKCORE_QUANTUM_DEPTH.</p></ol>
200
201 </div>
202<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
203_8c.html" target="source" name="GetImageType">GetImageType</a></h2>
204<div class="doc-section">
205
206<p>GetImageType() returns the potential type of image:</p></ol>
207
208<p>Bilevel Grayscale GrayscaleMatte Palette PaletteMatte TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte</p></ol>
209
210<p>To ensure the image type matches its potential, use SetImageType():</p>
211
212<pre class="text">
213 (void) SetImageType(image,GetImageType(image));
214</pre>
215
216<p>The format of the GetImageType method is:</p>
217
218<pre class="code">
219 ImageType GetImageType(const Image *image,ExceptionInfo *exception)
220</pre>
221
222<p>A description of each parameter follows:</p></ol>
223
224<h5>image</h5>
225<ol><p>the image.</p></ol>
226
227<h5>exception</h5>
228<ol><p>return any errors or warnings in this structure.</p></ol>
229
230 </div>
231<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
232_8c.html" target="source" name="IsGrayImage">IsGrayImage</a></h2>
233<div class="doc-section">
234
235<p>IsGrayImage() returns MagickTrue if all the pixels in the image have the same red, green, and blue intensities.</p></ol>
236
237<p>The format of the IsGrayImage method is:</p>
238
239<pre class="code">
240 MagickBooleanType IsGrayImage(const Image *image,
241 ExceptionInfo *exception)
242</pre>
243
244<p>A description of each parameter follows:</p></ol>
245
246<h5>image</h5>
247<ol><p>the image.</p></ol>
248
249<h5>exception</h5>
250<ol><p>return any errors or warnings in this structure.</p></ol>
251
252 </div>
253<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
254_8c.html" target="source" name="IsMonochromeImage">IsMonochromeImage</a></h2>
255<div class="doc-section">
256
257<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>
258
259<p>The format of the IsMonochromeImage method is:</p>
260
261<pre class="code">
262 MagickBooleanType IsMonochromeImage(const Image *image,
263 ExceptionInfo *exception)
264</pre>
265
266<p>A description of each parameter follows:</p></ol>
267
268<h5>image</h5>
269<ol><p>the image.</p></ol>
270
271<h5>exception</h5>
272<ol><p>return any errors or warnings in this structure.</p></ol>
273
274 </div>
275<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
276_8c.html" target="source" name="IsOpaqueImage">IsOpaqueImage</a></h2>
277<div class="doc-section">
278
279<p>IsOpaqueImage() returns MagickTrue if none of the pixels in the image have an opacity value other than opaque (0).</p></ol>
280
281<p>The format of the IsOpaqueImage method is:</p>
282
283<pre class="code">
284 MagickBooleanType IsOpaqueImage(const Image *image,
285 ExceptionInfo *exception)
286</pre>
287
288<p>A description of each parameter follows:</p></ol>
289
290<h5>image</h5>
291<ol><p>the image.</p></ol>
292
293<h5>exception</h5>
294<ol><p>return any errors or warnings in this structure.</p></ol>
295
296 </div>
297<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
298_8c.html" target="source" name="SetImageChannelDepth">SetImageChannelDepth</a></h2>
299<div class="doc-section">
300
301<p>SetImageChannelDepth() sets the depth of the image.</p></ol>
302
303<p>The format of the SetImageChannelDepth method is:</p>
304
305<pre class="code">
306 MagickBooleanType SetImageDepth(Image *image,const unsigned long depth)
307 MagickBooleanType SetImageChannelDepth(Image *image,
308 const ChannelType channel,const unsigned long depth)
309</pre>
310
311<p>A description of each parameter follows:</p></ol>
312
313<h5>image</h5>
314<ol><p>the image.</p></ol>
315
316<h5>channel</h5>
317<ol><p>the channel.</p></ol>
318
319<h5>depth</h5>
320<ol><p>the image depth.</p></ol>
321
322 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]323
324</div>
325
326<div id="linkbar">
327 <!-- <span id="linkbar-west">&nbsp;</span> -->
328 <span id="linkbar-center">
329 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristyce737472010-05-09 13:19:34 +0000[diff] [blame]330 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]331 </span>
332 <span id="linkbar-east">&nbsp;</span>
333 </div>
334 <div class="footer">
335 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
336 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
337 </div>
338 <div style="clear: both; margin: 0; width: 100%; "></div>
339</body>
340</html>