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   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   8   <style type="text/css" media="all">\r
   9     @import url("../../www/magick.css");\r
  10   </style>\r
  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"/>
  25   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
  26   <meta name="Distribution" content="Global"/>
  27 </head>\r
  28 \r
  29 <body id="www-imagemagick-org">\r
  30 <div class="titlebar">\r
  31 <a href="../../index.html">\r
  32   <img src="../../images/script.png" alt="[ImageMagick]"\r
  33   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  34 <a href="http://www.networkredux.com">\r
  35   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  36   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  37 <a href="http://www.imagemagick.org/discourse-server/">\r
  38   <img src="../../images/logo.jpg" alt=""\r
  39   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  40 <a href="../../index.html">\r
  41   <img src="../../images/sprite.jpg" alt=""\r
  42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  43 </div>\r
  44 \r
  45 <div class="westbar">\r
  46 \r
  47 <div class="menu">
  48   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  49 </div>
  50 <div class="sep"></div>\r
  51 <div class="menu">
  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>\r
  64 <div class="menu">
  65   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  66 </div>
  67 <div class="sub">
  68     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  69 </div>
  70 <div class="sub">
  71     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  72 </div>
  73 <div class="sub">
  74     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  75 </div>
  76 <div class="menu">
  77   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  78 </div>
  79 <div class="sub">
  80     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
  81 </div>
  82 <div class="sub">
  83     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
  84 </div>
  85 <div class="sub">
  86     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
  90 </div>
  91 <div class="sep"></div>\r
  92 <div  class="menu">
  93    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
  94 </div>
  95 <div class="sub">
  96     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
  97 </div>
  98 <div class="sub">
  99     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 100  </div>
 101 <div class="menu">
 102   <a title="Resources" href="../../www/resources.html">Resources</a>
 103 </div>
 104 <div class="menu">
 105   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 106 </div>
 107 <div class="menu">
 108   <a title="Download" href="../../www/download.html">Download</a>
 109 </div>
 110 <div class="sep"></div>\r
 111 <div class="menu">
 112   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
 113 </div>
 114 <div class="sep"></div>\r
 115 <div class="menu">
 116   <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
 117 </div>
 118 <div  class="sub">
 119     <a title="Site Map: Links"href="../../www/links.html">Links</a>
 120 </div>
 121 <div class="sep"></div>\r
 122 <div  class="menu">
 123   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 124
 125 <div class="sponsbox">
 126 <div  class="sponsor">
 127   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 128 </div>
 129 <div  class="sponsor">
 130   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 137 </div>
 138 <div  class="sponsor">
 139   <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 140 </div>
 141 <div  class="sponsor">
 142    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 143 </div>
 144 <div  class="sponsor">
 145    <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
 146 </div>
 147 </div>
 148 </div>
 149 </div>\r
 150 \r
 151 <div class="eastbar">\r
 152   <script type="text/javascript">\r
 153   <!--\r
 154     google_ad_client = "pub-3129977114552745";\r
 155     google_ad_slot = "0574824969";\r
 156     google_ad_width = 160;\r
 157     google_ad_height = 600;\r
 158   //-->\r
 159   </script>\r
 160   <script type="text/javascript"\r
 161     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 162   </script>\r
 163 </div>\r
 164 \r
 165 <div class="main">\r
 166 \r
 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">
 178   size_t GetImageDepth(const Image *image,ExceptionInfo *exception)
 179   size_t GetImageChannelDepth(const Image *image,
 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">
 204   size_t GetImageQuantumDepth(const Image *image,
 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">
 321   MagickBooleanType SetImageDepth(Image *image,const size_t depth)
 322   MagickBooleanType SetImageChannelDepth(Image *image,
 323     const ChannelType channel,const size_t depth)
 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>
 338 \r
 339 </div>\r
 340 \r
 341 <div id="linkbar">\r
 342     <span id="linkbar-west">&nbsp;</span>\r
 343     <span id="linkbar-center">\r
 344       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 345       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 346     </span>\r
 347     <span id="linkbar-east">&nbsp;</span>\r
 348   </div>\r
 349   <div class="footer">\r
 350     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 351     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 352   </div>\r
 353   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 354   <script type="text/javascript">\r
 355     var _gaq = _gaq || [];\r
 356     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 357     _gaq.push(['_trackPageview']);\r
 358 \r
 359     (function() {\r
 360       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 361       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 362       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 363     })();\r
 364   </script>\r
 365 </body>\r
 366 </html>\r