Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 851dbceb0a51cbcd3ed512f074e9f2d797b7cbc1 / . / www / api / attribute.html
blob: 3c2df695f8b8234c3c9d975b8488e9b5ab35651c [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
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]45<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]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">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]52 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
53</div>
54<div class="sub">
55 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
56</div>
57<div class="sub">
58 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
59</div>
60<div class="sub">
61 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
62</div>
63<div class="sep"></div>
64<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]65 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]66</div>
67<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]68 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]69</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]71 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]72</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]74 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]75</div>
76<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]77 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]78</div>
79<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]80 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]81</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]83 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</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="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</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="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]90</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]91<div class="sep"></div>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]92<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]93 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]94</div>
95<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]96 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]97</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]99 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]100 </div>
101<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]103</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]104<div class="menu">
105 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
106</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">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame^]127 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
128</div>
129<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]130 <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]131</div>
132<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]133 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy13538962010-02-26 17:53:04 +0000[diff] [blame]134</div>
135<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]136 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
cristy5f2356f2009-11-16 00:40:46 +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>
cristyd6dfc0d2010-06-27 19:30:49 +0000[diff] [blame]144<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame^]145 <a title="Sponsor: Online-Magazin" href="http://www.unkostenbeitrag.de/">Online-Magazin</a><!-- 20101101000200 -->
cristyd6dfc0d2010-06-27 19:30:49 +0000[diff] [blame]146</div>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]147</div>
148</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]149</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]150
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]151<div class="eastbar">
152 <script type="text/javascript">
153 <!--
154 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]155 google_ad_slot = "0574824969";
156 google_ad_width = 160;
157 google_ad_height = 600;
158 //-->
159 </script>
160 <script type="text/javascript"
161 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
162 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]163</div>
164
165<div class="main">
166
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]167<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>
168
169<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
170_8c.html" target="source" name="GetImageChannelDepth">GetImageChannelDepth</a></h2>
171<div class="doc-section">
172
173<p>GetImageChannelDepth() returns the depth of a particular image channel.</p></ol>
174
175<p>The format of the GetImageChannelDepth method is:</p>
176
177<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]178 size_t GetImageDepth(const Image *image,ExceptionInfo *exception)
179 size_t GetImageChannelDepth(const Image *image,
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]180 const ChannelType channel,ExceptionInfo *exception)
181</pre>
182
183<p>A description of each parameter follows:</p></ol>
184
185<h5>image</h5>
186<ol><p>the image.</p></ol>
187
188<h5>channel</h5>
189<ol><p>the channel.</p></ol>
190
191<h5>exception</h5>
192<ol><p>return any errors or warnings in this structure.</p></ol>
193
194 </div>
195<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
196_8c.html" target="source" name="GetImageQuantumDepth">GetImageQuantumDepth</a></h2>
197<div class="doc-section">
198
199<p>GetImageQuantumDepth() returns the depth of the image rounded to a legal quantum depth: 8, 16, or 32.</p></ol>
200
201<p>The format of the GetImageQuantumDepth method is:</p>
202
203<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]204 size_t GetImageQuantumDepth(const Image *image,
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]205 const MagickBooleanType constrain)
206</pre>
207
208<p>A description of each parameter follows:</p></ol>
209
210<h5>image</h5>
211<ol><p>the image.</p></ol>
212
213<h5>constrain</h5>
214<ol><p>A value other than MagickFalse, constrains the depth to a maximum of MAGICKCORE_QUANTUM_DEPTH.</p></ol>
215
216 </div>
217<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
218_8c.html" target="source" name="GetImageType">GetImageType</a></h2>
219<div class="doc-section">
220
221<p>GetImageType() returns the potential type of image:</p></ol>
222
223<p>Bilevel Grayscale GrayscaleMatte Palette PaletteMatte TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte</p></ol>
224
225<p>To ensure the image type matches its potential, use SetImageType():</p>
226
227<pre class="text">
228 (void) SetImageType(image,GetImageType(image));
229</pre>
230
231<p>The format of the GetImageType method is:</p>
232
233<pre class="code">
234 ImageType GetImageType(const Image *image,ExceptionInfo *exception)
235</pre>
236
237<p>A description of each parameter follows:</p></ol>
238
239<h5>image</h5>
240<ol><p>the image.</p></ol>
241
242<h5>exception</h5>
243<ol><p>return any errors or warnings in this structure.</p></ol>
244
245 </div>
246<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
247_8c.html" target="source" name="IsGrayImage">IsGrayImage</a></h2>
248<div class="doc-section">
249
250<p>IsGrayImage() returns MagickTrue if all the pixels in the image have the same red, green, and blue intensities.</p></ol>
251
252<p>The format of the IsGrayImage method is:</p>
253
254<pre class="code">
255 MagickBooleanType IsGrayImage(const Image *image,
256 ExceptionInfo *exception)
257</pre>
258
259<p>A description of each parameter follows:</p></ol>
260
261<h5>image</h5>
262<ol><p>the image.</p></ol>
263
264<h5>exception</h5>
265<ol><p>return any errors or warnings in this structure.</p></ol>
266
267 </div>
268<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
269_8c.html" target="source" name="IsMonochromeImage">IsMonochromeImage</a></h2>
270<div class="doc-section">
271
272<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>
273
274<p>The format of the IsMonochromeImage method is:</p>
275
276<pre class="code">
277 MagickBooleanType IsMonochromeImage(const Image *image,
278 ExceptionInfo *exception)
279</pre>
280
281<p>A description of each parameter follows:</p></ol>
282
283<h5>image</h5>
284<ol><p>the image.</p></ol>
285
286<h5>exception</h5>
287<ol><p>return any errors or warnings in this structure.</p></ol>
288
289 </div>
290<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
291_8c.html" target="source" name="IsOpaqueImage">IsOpaqueImage</a></h2>
292<div class="doc-section">
293
294<p>IsOpaqueImage() returns MagickTrue if none of the pixels in the image have an opacity value other than opaque (0).</p></ol>
295
296<p>The format of the IsOpaqueImage method is:</p>
297
298<pre class="code">
299 MagickBooleanType IsOpaqueImage(const Image *image,
300 ExceptionInfo *exception)
301</pre>
302
303<p>A description of each parameter follows:</p></ol>
304
305<h5>image</h5>
306<ol><p>the image.</p></ol>
307
308<h5>exception</h5>
309<ol><p>return any errors or warnings in this structure.</p></ol>
310
311 </div>
312<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
313_8c.html" target="source" name="SetImageChannelDepth">SetImageChannelDepth</a></h2>
314<div class="doc-section">
315
316<p>SetImageChannelDepth() sets the depth of the image.</p></ol>
317
318<p>The format of the SetImageChannelDepth method is:</p>
319
320<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]321 MagickBooleanType SetImageDepth(Image *image,const size_t depth)
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]322 MagickBooleanType SetImageChannelDepth(Image *image,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]323 const ChannelType channel,const size_t depth)
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]324</pre>
325
326<p>A description of each parameter follows:</p></ol>
327
328<h5>image</h5>
329<ol><p>the image.</p></ol>
330
331<h5>channel</h5>
332<ol><p>the channel.</p></ol>
333
334<h5>depth</h5>
335<ol><p>the image depth.</p></ol>
336
337 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]338
339</div>
340
341<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]342 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]343 <span id="linkbar-center">
344 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]345 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]346 </span>
347 <span id="linkbar-east">&nbsp;</span>
348 </div>
349 <div class="footer">
350 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
351 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
352 </div>
353 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]354 <script type="text/javascript">
355 var _gaq = _gaq || [];
356 _gaq.push(['_setAccount', 'UA-17690367-1']);
357 _gaq.push(['_trackPageview']);
358
359 (function() {
360 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
361 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
362 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
363 })();
364 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]365</body>
366</html>