granicus.if.org Git - imagemagick/blob - www/api/attribute.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
   2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">\r
   4 <head>\r
   5   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
   6   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
   7   <title>ImageMagick: MagickCore, C API for ImageMagick: Set Text Attributes</title/>
   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"/>
  11   <meta name="Application-name" content="ImageMagick"/>
  12   <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."/>
  13   <meta name="Application-url" content="http://www.imagemagick.org"/>
  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"/>
  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"/>
  22   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
  23   <meta name="Distribution" content="Global"/>
  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"/>\r
  27   <style type="text/css" media="all">\r
  28     @import url("../../www/magick.css");\r
  29   </style>\r
  30 </head>\r
  31 \r
  32 <body id="www-imagemagick-org">\r
  33 <div class="titlebar">\r
  34 <a href="../../index.html">\r
  35   <img src="../../images/script.png" alt="[ImageMagick]"\r
  36   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  37 <a href="http://www.networkredux.com">\r
  38   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  39   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  40 <a href="http://www.imagemagick.org/discourse-server/">\r
  41   <img src="../../images/logo.jpg" alt=""\r
  42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  43 <a href="../../index.html">\r
  44   <img src="../../images/sprite.jpg" alt=""\r
  45   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  46 </div>\r
  47 \r
  48 <div class="westbar">\r
  49 \r
  50 <div class="menu">
  51   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  52 </div>
  53 <div class="sep"></div>\r
  54 <div class="menu">
  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>\r
  67 <div class="menu">
  68   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  69 </div>
  70 <div class="sub">
  71     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  72 </div>
  73 <div class="sub">
  74     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  75 </div>
  76 <div class="sub">
  77     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  78 </div>
  79 <div class="menu">
  80   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  81 </div>
  82 <div class="sub">
  83     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
  84 </div>
  85 <div class="sub">
  86     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
  90 </div>
  91 <div class="sub">
  92     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
  93 </div>
  94 <div class="sep"></div>\r
  95 <div  class="menu">
  96    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
  97 </div>
  98 <div class="sub">
  99     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 100 </div>
 101 <div class="sub">
 102     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 103  </div>
 104 <div class="menu">
 105   <a title="Resources" href="../../www/resources.html">Resources</a>
 106 </div>
 107 <div class="menu">
 108   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 109 </div>
 110 <div class="menu">
 111   <a title="Download" href="../../www/download.html">Download</a>
 112 </div>
 113 <div class="sep"></div>\r
 114 <div class="menu">
 115   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
 116 </div>
 117 <div class="sep"></div>\r
 118 <div class="menu">
 119   <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
 120 </div>
 121 <div  class="sub">
 122     <a title="Site Map: Links"href="../../www/links.html">Links</a>
 123 </div>
 124 <div class="sep"></div>\r
 125 <div  class="menu">
 126   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 127
 128 <div class="sponsbox">
 129 <div  class="sponsor">
 130    <a title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 137 </div>
 138 <div  class="sponsor">
 139   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 140 </div>
 141 <div  class="sponsor">
 142   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 143 </div>
 144 <div  class="sponsor">
 145   <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
 146 </div>
 147 <div  class="sponsor">
 148    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 149 </div>
 150 </div>
 151 </div>
 152 </div>\r
 153 \r
 154 <div class="eastbar">\r
 155   <script type="text/javascript">\r
 156   <!--\r
 157     google_ad_client = "pub-3129977114552745";\r
 158     google_ad_slot = "0574824969";\r
 159     google_ad_width = 160;\r
 160     google_ad_height = 600;\r
 161   //-->\r
 162   </script>\r
 163   <script type="text/javascript"\r
 164     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 165   </script>\r
 166 </div>\r
 167 \r
 168 <div class="main">\r
 169 \r
 170 <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>
 171
 172 <h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
 173 _8c.html" target="source" name="GetImageChannelDepth">GetImageChannelDepth</a></h2>
 174 <div class="doc-section">
 175
 176 <p>GetImageChannelDepth() returns the depth of a particular image channel.</p></ol>
 177
 178 <p>The format of the GetImageChannelDepth method is:</p>
 179
 180 <pre class="code">
 181   size_t GetImageDepth(const Image *image,ExceptionInfo *exception)
 182   size_t GetImageChannelDepth(const Image *image,
 183     const ChannelType channel,ExceptionInfo *exception)
 184 </pre>
 185
 186 <p>A description of each parameter follows:</p></ol>
 187
 188 <h5>image</h5>
 189 <ol><p>the image.</p></ol>
 190
 191 <h5>channel</h5>
 192 <ol><p>the channel.</p></ol>
 193
 194 <h5>exception</h5>
 195 <ol><p>return any errors or warnings in this structure.</p></ol>
 196
 197  </div>
 198 <h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
 199 _8c.html" target="source" name="GetImageQuantumDepth">GetImageQuantumDepth</a></h2>
 200 <div class="doc-section">
 201
 202 <p>GetImageQuantumDepth() returns the depth of the image rounded to a legal quantum depth: 8, 16, or 32.</p></ol>
 203
 204 <p>The format of the GetImageQuantumDepth method is:</p>
 205
 206 <pre class="code">
 207   size_t GetImageQuantumDepth(const Image *image,
 208     const MagickBooleanType constrain)
 209 </pre>
 210
 211 <p>A description of each parameter follows:</p></ol>
 212
 213 <h5>image</h5>
 214 <ol><p>the image.</p></ol>
 215
 216 <h5>constrain</h5>
 217 <ol><p>A value other than MagickFalse, constrains the depth to a maximum of MAGICKCORE_QUANTUM_DEPTH.</p></ol>
 218
 219  </div>
 220 <h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
 221 _8c.html" target="source" name="GetImageType">GetImageType</a></h2>
 222 <div class="doc-section">
 223
 224 <p>GetImageType() returns the potential type of image:</p></ol>
 225
 226 <p>Bilevel         Grayscale        GrayscaleMatte Palette         PaletteMatte     TrueColor TrueColorMatte  ColorSeparation  ColorSeparationMatte</p></ol>
 227
 228 <p>To ensure the image type matches its potential, use SetImageType():</p>
 229
 230 <pre class="text">
 231       (void) SetImageType(image,GetImageType(image));
 232 </pre>
 233
 234 <p>The format of the GetImageType method is:</p>
 235
 236 <pre class="code">
 237   ImageType GetImageType(const Image *image,ExceptionInfo *exception)
 238 </pre>
 239
 240 <p>A description of each parameter follows:</p></ol>
 241
 242 <h5>image</h5>
 243 <ol><p>the image.</p></ol>
 244
 245 <h5>exception</h5>
 246 <ol><p>return any errors or warnings in this structure.</p></ol>
 247
 248  </div>
 249 <h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
 250 _8c.html" target="source" name="IsGrayImage">IsGrayImage</a></h2>
 251 <div class="doc-section">
 252
 253 <p>IsGrayImage() returns MagickTrue if all the pixels in the image have the same red, green, and blue intensities.</p></ol>
 254
 255 <p>The format of the IsGrayImage method is:</p>
 256
 257 <pre class="code">
 258   MagickBooleanType IsGrayImage(const Image *image,
 259     ExceptionInfo *exception)
 260 </pre>
 261
 262 <p>A description of each parameter follows:</p></ol>
 263
 264 <h5>image</h5>
 265 <ol><p>the image.</p></ol>
 266
 267 <h5>exception</h5>
 268 <ol><p>return any errors or warnings in this structure.</p></ol>
 269
 270  </div>
 271 <h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
 272 _8c.html" target="source" name="IsMonochromeImage">IsMonochromeImage</a></h2>
 273 <div class="doc-section">
 274
 275 <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>
 276
 277 <p>The format of the IsMonochromeImage method is:</p>
 278
 279 <pre class="code">
 280   MagickBooleanType IsMonochromeImage(const Image *image,
 281     ExceptionInfo *exception)
 282 </pre>
 283
 284 <p>A description of each parameter follows:</p></ol>
 285
 286 <h5>image</h5>
 287 <ol><p>the image.</p></ol>
 288
 289 <h5>exception</h5>
 290 <ol><p>return any errors or warnings in this structure.</p></ol>
 291
 292  </div>
 293 <h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
 294 _8c.html" target="source" name="IsOpaqueImage">IsOpaqueImage</a></h2>
 295 <div class="doc-section">
 296
 297 <p>IsOpaqueImage() returns MagickTrue if none of the pixels in the image have an opacity value other than opaque (0).</p></ol>
 298
 299 <p>The format of the IsOpaqueImage method is:</p>
 300
 301 <pre class="code">
 302   MagickBooleanType IsOpaqueImage(const Image *image,
 303     ExceptionInfo *exception)
 304 </pre>
 305
 306 <p>A description of each parameter follows:</p></ol>
 307
 308 <h5>image</h5>
 309 <ol><p>the image.</p></ol>
 310
 311 <h5>exception</h5>
 312 <ol><p>return any errors or warnings in this structure.</p></ol>
 313
 314  </div>
 315 <h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
 316 _8c.html" target="source" name="SetImageChannelDepth">SetImageChannelDepth</a></h2>
 317 <div class="doc-section">
 318
 319 <p>SetImageChannelDepth() sets the depth of the image.</p></ol>
 320
 321 <p>The format of the SetImageChannelDepth method is:</p>
 322
 323 <pre class="code">
 324   MagickBooleanType SetImageDepth(Image *image,const size_t depth)
 325   MagickBooleanType SetImageChannelDepth(Image *image,
 326     const ChannelType channel,const size_t depth)
 327 </pre>
 328
 329 <p>A description of each parameter follows:</p></ol>
 330
 331 <h5>image</h5>
 332 <ol><p>the image.</p></ol>
 333
 334 <h5>channel</h5>
 335 <ol><p>the channel.</p></ol>
 336
 337 <h5>depth</h5>
 338 <ol><p>the image depth.</p></ol>
 339
 340  </div>
 341 \r
 342 </div>\r
 343 \r
 344 <div id="linkbar">\r
 345     <span id="linkbar-west">&nbsp;</span>\r
 346     <span id="linkbar-center">\r
 347       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 348       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 349     </span>\r
 350     <span id="linkbar-east">&nbsp;</span>\r
 351   </div>\r
 352   <div class="footer">\r
 353     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 354     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 355   </div>\r
 356   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 357   <script type="text/javascript">\r
 358     var _gaq = _gaq || [];\r
 359     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 360     _gaq.push(['_trackPageview']);\r
 361 \r
 362     (function() {\r
 363       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 364       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 365       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 366     })();\r
 367   </script>\r
 368 </body>\r
 369 </html>\r