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="eastbar">\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: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 128 </div>
 129 <div  class="sponsor">
 130   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 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: Webdesign" href="http://www.renehornig.com/" title="Webdesign">Webdesign</a><!-- 20111001000240 -->
 146 </div>
 147 </div>
 148 </div>
 149 \r
 150 \r
 151 </div>\r
 152 \r
 153 <div class="main">\r
 154 \r
 155 <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>
 156
 157 <h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
 158 _8c.html" target="source" name="GetImageChannelDepth">GetImageChannelDepth</a></h2>
 159 <div class="doc-section">
 160
 161 <p>GetImageChannelDepth() returns the depth of a particular image channel.</p></ol>
 162
 163 <p>The format of the GetImageChannelDepth method is:</p>
 164
 165 <pre class="code">
 166   size_t GetImageDepth(const Image *image,ExceptionInfo *exception)
 167   size_t GetImageChannelDepth(const Image *image,
 168     const ChannelType channel,ExceptionInfo *exception)
 169 </pre>
 170
 171 <p>A description of each parameter follows:</p></ol>
 172
 173 <h5>image</h5>
 174 <ol><p>the image.</p></ol>
 175
 176 <h5>channel</h5>
 177 <ol><p>the channel.</p></ol>
 178
 179 <h5>exception</h5>
 180 <ol><p>return any errors or warnings in this structure.</p></ol>
 181
 182  </div>
 183 <h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
 184 _8c.html" target="source" name="GetImageQuantumDepth">GetImageQuantumDepth</a></h2>
 185 <div class="doc-section">
 186
 187 <p>GetImageQuantumDepth() returns the depth of the image rounded to a legal quantum depth: 8, 16, or 32.</p></ol>
 188
 189 <p>The format of the GetImageQuantumDepth method is:</p>
 190
 191 <pre class="code">
 192   size_t GetImageQuantumDepth(const Image *image,
 193     const MagickBooleanType constrain)
 194 </pre>
 195
 196 <p>A description of each parameter follows:</p></ol>
 197
 198 <h5>image</h5>
 199 <ol><p>the image.</p></ol>
 200
 201 <h5>constrain</h5>
 202 <ol><p>A value other than MagickFalse, constrains the depth to a maximum of MAGICKCORE_QUANTUM_DEPTH.</p></ol>
 203
 204  </div>
 205 <h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
 206 _8c.html" target="source" name="GetImageType">GetImageType</a></h2>
 207 <div class="doc-section">
 208
 209 <p>GetImageType() returns the potential type of image:</p></ol>
 210
 211 <p>Bilevel         Grayscale        GrayscaleMatte Palette         PaletteMatte     TrueColor TrueColorMatte  ColorSeparation  ColorSeparationMatte</p></ol>
 212
 213 <p>To ensure the image type matches its potential, use SetImageType():</p>
 214
 215 <pre class="text">
 216       (void) SetImageType(image,GetImageType(image));
 217 </pre>
 218
 219 <p>The format of the GetImageType method is:</p>
 220
 221 <pre class="code">
 222   ImageType GetImageType(const Image *image,ExceptionInfo *exception)
 223 </pre>
 224
 225 <p>A description of each parameter follows:</p></ol>
 226
 227 <h5>image</h5>
 228 <ol><p>the image.</p></ol>
 229
 230 <h5>exception</h5>
 231 <ol><p>return any errors or warnings in this structure.</p></ol>
 232
 233  </div>
 234 <h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
 235 _8c.html" target="source" name="IsGrayImage">IsGrayImage</a></h2>
 236 <div class="doc-section">
 237
 238 <p>IsGrayImage() returns MagickTrue if all the pixels in the image have the same red, green, and blue intensities.</p></ol>
 239
 240 <p>The format of the IsGrayImage method is:</p>
 241
 242 <pre class="code">
 243   MagickBooleanType IsGrayImage(const Image *image,
 244     ExceptionInfo *exception)
 245 </pre>
 246
 247 <p>A description of each parameter follows:</p></ol>
 248
 249 <h5>image</h5>
 250 <ol><p>the image.</p></ol>
 251
 252 <h5>exception</h5>
 253 <ol><p>return any errors or warnings in this structure.</p></ol>
 254
 255  </div>
 256 <h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
 257 _8c.html" target="source" name="IsMonochromeImage">IsMonochromeImage</a></h2>
 258 <div class="doc-section">
 259
 260 <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>
 261
 262 <p>The format of the IsMonochromeImage method is:</p>
 263
 264 <pre class="code">
 265   MagickBooleanType IsMonochromeImage(const Image *image,
 266     ExceptionInfo *exception)
 267 </pre>
 268
 269 <p>A description of each parameter follows:</p></ol>
 270
 271 <h5>image</h5>
 272 <ol><p>the image.</p></ol>
 273
 274 <h5>exception</h5>
 275 <ol><p>return any errors or warnings in this structure.</p></ol>
 276
 277  </div>
 278 <h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
 279 _8c.html" target="source" name="IsOpaqueImage">IsOpaqueImage</a></h2>
 280 <div class="doc-section">
 281
 282 <p>IsOpaqueImage() returns MagickTrue if none of the pixels in the image have an opacity value other than opaque (0).</p></ol>
 283
 284 <p>The format of the IsOpaqueImage method is:</p>
 285
 286 <pre class="code">
 287   MagickBooleanType IsOpaqueImage(const Image *image,
 288     ExceptionInfo *exception)
 289 </pre>
 290
 291 <p>A description of each parameter follows:</p></ol>
 292
 293 <h5>image</h5>
 294 <ol><p>the image.</p></ol>
 295
 296 <h5>exception</h5>
 297 <ol><p>return any errors or warnings in this structure.</p></ol>
 298
 299  </div>
 300 <h2><a href="http://www.imagemagick.org/api/MagickCore/attribute
 301 _8c.html" target="source" name="SetImageChannelDepth">SetImageChannelDepth</a></h2>
 302 <div class="doc-section">
 303
 304 <p>SetImageChannelDepth() sets the depth of the image.</p></ol>
 305
 306 <p>The format of the SetImageChannelDepth method is:</p>
 307
 308 <pre class="code">
 309   MagickBooleanType SetImageDepth(Image *image,const size_t depth)
 310   MagickBooleanType SetImageChannelDepth(Image *image,
 311     const ChannelType channel,const size_t depth)
 312 </pre>
 313
 314 <p>A description of each parameter follows:</p></ol>
 315
 316 <h5>image</h5>
 317 <ol><p>the image.</p></ol>
 318
 319 <h5>channel</h5>
 320 <ol><p>the channel.</p></ol>
 321
 322 <h5>depth</h5>
 323 <ol><p>the image depth.</p></ol>
 324
 325  </div>
 326 \r
 327 </div>\r
 328 \r
 329 <div id="linkbar">\r
 330  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 331     <span id="linkbar-center">\r
 332       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 333     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 334     </span>\r
 335     <span id="linkbar-east">&nbsp;</span>\r
 336   </div>\r
 337   <div class="footer">\r
 338     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 339     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 340   </div>\r
 341   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 342 </body>\r
 343 </html>\r