Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 307ba18d4753632f19e873143d01e0b6ba2dbaad / . / www / api / attribute.html
blob: 2c2ed6f6bbaa03acbe1aa64ba55d247e06ea676a [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>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]7 <title>ImageMagick: MagickCore, C API for ImageMagick: Set Text Attributes</title>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]8 <meta http-equiv="Content-Language" content="en-US"/>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
10 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]11 <meta name="Application-name" content="ImageMagick"/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]12 <meta name="Description" content="ImageMagick is a software suite to create, edit, or compose bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]13 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]14 <meta name="Generator" content="PHP"/>
15 <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"/>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]16 <meta name="Rating" content="GENERAL"/>
17 <meta name="Robots" content="INDEX, FOLLOW"/>
18 <meta name="Generator" content="ImageMagick Studio LLC"/>
19 <meta name="Author" content="ImageMagick Studio LLC"/>
20 <meta name="Revisit-after" content="2 DAYS"/>
21 <meta name="Resource-type" content="document"/>
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]22 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]23 <meta name="Distribution" content="Global"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]24 <link rel="icon" href="../../images/wand.png" sizes="32x32"/>
25 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
27 <style type="text/css" media="all">
28 @import url("../../www/magick.css");
29 </style>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]30</head>
31
32<body id="www-imagemagick-org">
33<div class="titlebar">
34<a href="../../index.html">
35 <img src="../../images/script.png" alt="[ImageMagick]"
36 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
37<a href="http://www.networkredux.com">
38 <img src="../../images/networkredux.png" alt="[sponsor]"
39 style="margin: 45px auto; border: 0px; float: left;" /></a>
40<a href="http://www.imagemagick.org/discourse-server/">
41 <img src="../../images/logo.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43<a href="../../index.html">
44 <img src="../../images/sprite.jpg" alt=""
45 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
46</div>
47
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]48<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]49
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]50<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]51 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]52</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]53<div class="sep"></div>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]54<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]55 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
56</div>
57<div class="sub">
58 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
59</div>
60<div class="sub">
61 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
62</div>
63<div class="sub">
64 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
65</div>
66<div class="sep"></div>
67<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]68 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</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: Processing" href="../../www/command-line-processing.html">Processing</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: Options" href="../../www/command-line-options.html">Options</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]75</div>
76<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]77 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]78</div>
79<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]80 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</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: MagickWand" href="../../www/magick-wand.html">MagickWand</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: MagickCore" href="../../www/magick-core.html">MagickCore</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: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]90</div>
91<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]92 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]93</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]94<div class="sep"></div>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]95<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]96 <a title="Install from Source" href="../../www/install-source.html">Install from Source</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: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]103 </div>
104<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]105 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]106</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]107<div class="menu">
108 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
109</div>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]110<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]111 <a title="Download" href="../../www/download.html">Download</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]112</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]113<div class="sep"></div>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]114<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]115 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]116</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]117<div class="sep"></div>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]118<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]119 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]120</div>
121<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]122 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]123</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]124<div class="sep"></div>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]125<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]126 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]127
128<div class="sponsbox">
129<div class="sponsor">
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame^]130 <a title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011040100025 atlas.multimedia-->
cristy73fd1cd2010-09-12 19:14:25 +0000[diff] [blame]131</div>
132<div class="sponsor">
cristy7d52cd62010-10-01 17:26:59 +0000[diff] [blame]133 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
134</div>
135<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]136 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
137</div>
138<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]139 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]142 <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]143</div>
144<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]145 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy13538962010-02-26 17:53:04 +0000[diff] [blame]146</div>
147<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]148 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]149</div>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]150</div>
151</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]152</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]153
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]154<div class="eastbar">
155 <script type="text/javascript">
156 <!--
157 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]158 google_ad_slot = "0574824969";
159 google_ad_width = 160;
160 google_ad_height = 600;
161 //-->
162 </script>
163 <script type="text/javascript"
164 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
165 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]166</div>
167
168<div class="main">
169
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame^]170<h1>Module attribute
171 Methods</h1>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]172<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>
173
174<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
175_8c.html" target="source" name="GetImageChannelDepth">GetImageChannelDepth</a></h2>
176<div class="doc-section">
177
178<p>GetImageChannelDepth() returns the depth of a particular image channel.</p></ol>
179
180<p>The format of the GetImageChannelDepth method is:</p>
181
182<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]183 size_t GetImageDepth(const Image *image,ExceptionInfo *exception)
184 size_t GetImageChannelDepth(const Image *image,
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]185 const ChannelType channel,ExceptionInfo *exception)
186</pre>
187
188<p>A description of each parameter follows:</p></ol>
189
190<h5>image</h5>
191<ol><p>the image.</p></ol>
192
193<h5>channel</h5>
194<ol><p>the channel.</p></ol>
195
196<h5>exception</h5>
197<ol><p>return any errors or warnings in this structure.</p></ol>
198
199 </div>
200<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
201_8c.html" target="source" name="GetImageQuantumDepth">GetImageQuantumDepth</a></h2>
202<div class="doc-section">
203
204<p>GetImageQuantumDepth() returns the depth of the image rounded to a legal quantum depth: 8, 16, or 32.</p></ol>
205
206<p>The format of the GetImageQuantumDepth method is:</p>
207
208<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]209 size_t GetImageQuantumDepth(const Image *image,
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]210 const MagickBooleanType constrain)
211</pre>
212
213<p>A description of each parameter follows:</p></ol>
214
215<h5>image</h5>
216<ol><p>the image.</p></ol>
217
218<h5>constrain</h5>
219<ol><p>A value other than MagickFalse, constrains the depth to a maximum of MAGICKCORE_QUANTUM_DEPTH.</p></ol>
220
221 </div>
222<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
223_8c.html" target="source" name="GetImageType">GetImageType</a></h2>
224<div class="doc-section">
225
226<p>GetImageType() returns the potential type of image:</p></ol>
227
228<p>Bilevel Grayscale GrayscaleMatte Palette PaletteMatte TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte</p></ol>
229
230<p>To ensure the image type matches its potential, use SetImageType():</p>
231
232<pre class="text">
233 (void) SetImageType(image,GetImageType(image));
234</pre>
235
236<p>The format of the GetImageType method is:</p>
237
238<pre class="code">
239 ImageType GetImageType(const Image *image,ExceptionInfo *exception)
240</pre>
241
242<p>A description of each parameter follows:</p></ol>
243
244<h5>image</h5>
245<ol><p>the image.</p></ol>
246
247<h5>exception</h5>
248<ol><p>return any errors or warnings in this structure.</p></ol>
249
250 </div>
251<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
252_8c.html" target="source" name="IsGrayImage">IsGrayImage</a></h2>
253<div class="doc-section">
254
255<p>IsGrayImage() returns MagickTrue if all the pixels in the image have the same red, green, and blue intensities.</p></ol>
256
257<p>The format of the IsGrayImage method is:</p>
258
259<pre class="code">
260 MagickBooleanType IsGrayImage(const Image *image,
261 ExceptionInfo *exception)
262</pre>
263
264<p>A description of each parameter follows:</p></ol>
265
266<h5>image</h5>
267<ol><p>the image.</p></ol>
268
269<h5>exception</h5>
270<ol><p>return any errors or warnings in this structure.</p></ol>
271
272 </div>
273<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
274_8c.html" target="source" name="IsMonochromeImage">IsMonochromeImage</a></h2>
275<div class="doc-section">
276
277<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>
278
279<p>The format of the IsMonochromeImage method is:</p>
280
281<pre class="code">
282 MagickBooleanType IsMonochromeImage(const Image *image,
283 ExceptionInfo *exception)
284</pre>
285
286<p>A description of each parameter follows:</p></ol>
287
288<h5>image</h5>
289<ol><p>the image.</p></ol>
290
291<h5>exception</h5>
292<ol><p>return any errors or warnings in this structure.</p></ol>
293
294 </div>
295<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
296_8c.html" target="source" name="IsOpaqueImage">IsOpaqueImage</a></h2>
297<div class="doc-section">
298
299<p>IsOpaqueImage() returns MagickTrue if none of the pixels in the image have an opacity value other than opaque (0).</p></ol>
300
301<p>The format of the IsOpaqueImage method is:</p>
302
303<pre class="code">
304 MagickBooleanType IsOpaqueImage(const Image *image,
305 ExceptionInfo *exception)
306</pre>
307
308<p>A description of each parameter follows:</p></ol>
309
310<h5>image</h5>
311<ol><p>the image.</p></ol>
312
313<h5>exception</h5>
314<ol><p>return any errors or warnings in this structure.</p></ol>
315
316 </div>
317<h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
318_8c.html" target="source" name="SetImageChannelDepth">SetImageChannelDepth</a></h2>
319<div class="doc-section">
320
321<p>SetImageChannelDepth() sets the depth of the image.</p></ol>
322
323<p>The format of the SetImageChannelDepth method is:</p>
324
325<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]326 MagickBooleanType SetImageDepth(Image *image,const size_t depth)
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]327 MagickBooleanType SetImageChannelDepth(Image *image,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]328 const ChannelType channel,const size_t depth)
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]329</pre>
330
331<p>A description of each parameter follows:</p></ol>
332
333<h5>image</h5>
334<ol><p>the image.</p></ol>
335
336<h5>channel</h5>
337<ol><p>the channel.</p></ol>
338
339<h5>depth</h5>
340<ol><p>the image depth.</p></ol>
341
342 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]343
344</div>
345
346<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]347 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]348 <span id="linkbar-center">
349 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]350 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]351 </span>
352 <span id="linkbar-east">&nbsp;</span>
353 </div>
354 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]355 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]356 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
357 </div>
358 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]359 <script type="text/javascript">
360 var _gaq = _gaq || [];
361 _gaq.push(['_setAccount', 'UA-17690367-1']);
362 _gaq.push(['_trackPageview']);
363
364 (function() {
365 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
366 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
367 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
368 })();
369 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]370</body>
371</html>