blob: 76b3191fa9c5d469c5f484da2f3f0ed68a286bd3 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +00001<!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 +00003<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +00004<head>
cristy3de29cc2010-04-15 02:34:44 +00005 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +00006 <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 +00008 <style type="text/css" media="all">
cristy3eaa0ef2010-03-06 20:35:26 +00009 @import url("../../www/magick.css");
cristy3de29cc2010-04-15 02:34:44 +000010 </style>
cristy83543962009-10-16 19:04:28 +000011 <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 +000025 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy83543962009-10-16 19:04:28 +000026 <meta name="Distribution" content="Global"/>
cristy3eaa0ef2010-03-06 20:35:26 +000027</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 +000045<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000046
cristy83543962009-10-16 19:04:28 +000047<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000048 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy83543962009-10-16 19:04:28 +000049</div>
cristy3eaa0ef2010-03-06 20:35:26 +000050<div class="sep"></div>
cristy83543962009-10-16 19:04:28 +000051<div class="menu">
cristybb503372010-05-27 20:51:26 +000052 <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 +000065 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy83543962009-10-16 19:04:28 +000066</div>
67<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000068 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy83543962009-10-16 19:04:28 +000069</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000071 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy83543962009-10-16 19:04:28 +000072</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000074 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy83543962009-10-16 19:04:28 +000075</div>
76<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000077 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy83543962009-10-16 19:04:28 +000078</div>
79<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000080 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy83543962009-10-16 19:04:28 +000081</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000083 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy83543962009-10-16 19:04:28 +000084</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000086 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy83543962009-10-16 19:04:28 +000087</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000089 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy83543962009-10-16 19:04:28 +000090</div>
cristy3eaa0ef2010-03-06 20:35:26 +000091<div class="sep"></div>
cristy83543962009-10-16 19:04:28 +000092<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000093 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy83543962009-10-16 19:04:28 +000094</div>
95<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000096 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy83543962009-10-16 19:04:28 +000097</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000099 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy83543962009-10-16 19:04:28 +0000100 </div>
101<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000102 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy83543962009-10-16 19:04:28 +0000103</div>
cristybb503372010-05-27 20:51:26 +0000104<div class="menu">
105 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
106</div>
cristy83543962009-10-16 19:04:28 +0000107<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000108 <a title="Download" href="../../www/download.html">Download</a>
cristy83543962009-10-16 19:04:28 +0000109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000110<div class="sep"></div>
cristy83543962009-10-16 19:04:28 +0000111<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000112 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy83543962009-10-16 19:04:28 +0000113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000114<div class="sep"></div>
cristy83543962009-10-16 19:04:28 +0000115<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000116 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
cristy83543962009-10-16 19:04:28 +0000117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000119 <a title="Site Map: Links"href="../../www/links.html">Links</a>
cristy83543962009-10-16 19:04:28 +0000120</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000121<div class="sep"></div>
cristy83543962009-10-16 19:04:28 +0000122<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000123 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy83543962009-10-16 19:04:28 +0000124
125<div class="sponsbox">
126<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000127 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy7d34ef22010-03-25 01:11:22 +0000128</div>
129<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000130 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy13538962010-02-26 17:53:04 +0000131</div>
132<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000133 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
cristy5f2356f2009-11-16 00:40:46 +0000134</div>
135<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000136 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristy83543962009-10-16 19:04:28 +0000137</div>
138<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000139 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristy83543962009-10-16 19:04:28 +0000140</div>
cristyd6dfc0d2010-06-27 19:30:49 +0000141<div class="sponsor">
cristya8902942010-07-30 00:49:52 +0000142 <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
cristyd6dfc0d2010-06-27 19:30:49 +0000143</div>
cristy83543962009-10-16 19:04:28 +0000144</div>
145</div>
cristyce69bb02010-07-27 19:49:46 +0000146</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000147
cristyce69bb02010-07-27 19:49:46 +0000148<div class="eastbar">
149 <script type="text/javascript">
150 <!--
151 google_ad_client = "pub-3129977114552745";
152 /* 160x600, created 7/27/10 */
153 google_ad_slot = "0574824969";
154 google_ad_width = 160;
155 google_ad_height = 600;
156 //-->
157 </script>
158 <script type="text/javascript"
159 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
160 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000161</div>
162
163<div class="main">
164
cristy83543962009-10-16 19:04:28 +0000165<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>
166
167<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
168_8c.html" target="source" name="GetImageChannelDepth">GetImageChannelDepth</a></h2>
169<div class="doc-section">
170
171<p>GetImageChannelDepth() returns the depth of a particular image channel.</p></ol>
172
173<p>The format of the GetImageChannelDepth method is:</p>
174
175<pre class="code">
cristybb503372010-05-27 20:51:26 +0000176 size_t GetImageDepth(const Image *image,ExceptionInfo *exception)
177 size_t GetImageChannelDepth(const Image *image,
cristy83543962009-10-16 19:04:28 +0000178 const ChannelType channel,ExceptionInfo *exception)
179</pre>
180
181<p>A description of each parameter follows:</p></ol>
182
183<h5>image</h5>
184<ol><p>the image.</p></ol>
185
186<h5>channel</h5>
187<ol><p>the channel.</p></ol>
188
189<h5>exception</h5>
190<ol><p>return any errors or warnings in this structure.</p></ol>
191
192 </div>
193<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
194_8c.html" target="source" name="GetImageQuantumDepth">GetImageQuantumDepth</a></h2>
195<div class="doc-section">
196
197<p>GetImageQuantumDepth() returns the depth of the image rounded to a legal quantum depth: 8, 16, or 32.</p></ol>
198
199<p>The format of the GetImageQuantumDepth method is:</p>
200
201<pre class="code">
cristybb503372010-05-27 20:51:26 +0000202 size_t GetImageQuantumDepth(const Image *image,
cristy83543962009-10-16 19:04:28 +0000203 const MagickBooleanType constrain)
204</pre>
205
206<p>A description of each parameter follows:</p></ol>
207
208<h5>image</h5>
209<ol><p>the image.</p></ol>
210
211<h5>constrain</h5>
212<ol><p>A value other than MagickFalse, constrains the depth to a maximum of MAGICKCORE_QUANTUM_DEPTH.</p></ol>
213
214 </div>
215<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
216_8c.html" target="source" name="GetImageType">GetImageType</a></h2>
217<div class="doc-section">
218
219<p>GetImageType() returns the potential type of image:</p></ol>
220
221<p>Bilevel Grayscale GrayscaleMatte Palette PaletteMatte TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte</p></ol>
222
223<p>To ensure the image type matches its potential, use SetImageType():</p>
224
225<pre class="text">
226 (void) SetImageType(image,GetImageType(image));
227</pre>
228
229<p>The format of the GetImageType method is:</p>
230
231<pre class="code">
232 ImageType GetImageType(const Image *image,ExceptionInfo *exception)
233</pre>
234
235<p>A description of each parameter follows:</p></ol>
236
237<h5>image</h5>
238<ol><p>the image.</p></ol>
239
240<h5>exception</h5>
241<ol><p>return any errors or warnings in this structure.</p></ol>
242
243 </div>
244<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
245_8c.html" target="source" name="IsGrayImage">IsGrayImage</a></h2>
246<div class="doc-section">
247
248<p>IsGrayImage() returns MagickTrue if all the pixels in the image have the same red, green, and blue intensities.</p></ol>
249
250<p>The format of the IsGrayImage method is:</p>
251
252<pre class="code">
253 MagickBooleanType IsGrayImage(const Image *image,
254 ExceptionInfo *exception)
255</pre>
256
257<p>A description of each parameter follows:</p></ol>
258
259<h5>image</h5>
260<ol><p>the image.</p></ol>
261
262<h5>exception</h5>
263<ol><p>return any errors or warnings in this structure.</p></ol>
264
265 </div>
266<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
267_8c.html" target="source" name="IsMonochromeImage">IsMonochromeImage</a></h2>
268<div class="doc-section">
269
270<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>
271
272<p>The format of the IsMonochromeImage method is:</p>
273
274<pre class="code">
275 MagickBooleanType IsMonochromeImage(const Image *image,
276 ExceptionInfo *exception)
277</pre>
278
279<p>A description of each parameter follows:</p></ol>
280
281<h5>image</h5>
282<ol><p>the image.</p></ol>
283
284<h5>exception</h5>
285<ol><p>return any errors or warnings in this structure.</p></ol>
286
287 </div>
288<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
289_8c.html" target="source" name="IsOpaqueImage">IsOpaqueImage</a></h2>
290<div class="doc-section">
291
292<p>IsOpaqueImage() returns MagickTrue if none of the pixels in the image have an opacity value other than opaque (0).</p></ol>
293
294<p>The format of the IsOpaqueImage method is:</p>
295
296<pre class="code">
297 MagickBooleanType IsOpaqueImage(const Image *image,
298 ExceptionInfo *exception)
299</pre>
300
301<p>A description of each parameter follows:</p></ol>
302
303<h5>image</h5>
304<ol><p>the image.</p></ol>
305
306<h5>exception</h5>
307<ol><p>return any errors or warnings in this structure.</p></ol>
308
309 </div>
310<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
311_8c.html" target="source" name="SetImageChannelDepth">SetImageChannelDepth</a></h2>
312<div class="doc-section">
313
314<p>SetImageChannelDepth() sets the depth of the image.</p></ol>
315
316<p>The format of the SetImageChannelDepth method is:</p>
317
318<pre class="code">
cristybb503372010-05-27 20:51:26 +0000319 MagickBooleanType SetImageDepth(Image *image,const size_t depth)
cristy83543962009-10-16 19:04:28 +0000320 MagickBooleanType SetImageChannelDepth(Image *image,
cristybb503372010-05-27 20:51:26 +0000321 const ChannelType channel,const size_t depth)
cristy83543962009-10-16 19:04:28 +0000322</pre>
323
324<p>A description of each parameter follows:</p></ol>
325
326<h5>image</h5>
327<ol><p>the image.</p></ol>
328
329<h5>channel</h5>
330<ol><p>the channel.</p></ol>
331
332<h5>depth</h5>
333<ol><p>the image depth.</p></ol>
334
335 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000336
337</div>
338
339<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000340 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000341 <span id="linkbar-center">
342 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000343 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000344 </span>
345 <span id="linkbar-east">&nbsp;</span>
346 </div>
347 <div class="footer">
348 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
349 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
350 </div>
351 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000352 <script type="text/javascript">
353 var _gaq = _gaq || [];
354 _gaq.push(['_setAccount', 'UA-17690367-1']);
355 _gaq.push(['_trackPageview']);
356
357 (function() {
358 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
359 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
360 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
361 })();
362 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000363</body>
364</html>