granicus.if.org Git - imagemagick/blob - www/api/blob.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">\r
   4 <head>\r
   5   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   6   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   7   <style type="text/css" media="screen,projection"><!--\r
   8     @import url("../../www/magick.css");\r
   9   --></style>\r
  10   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  11   <title>ImageMagick: MagickCore, C API for ImageMagick: Read or Write Binary Large OBjects</title>
  12   <meta http-equiv="Content-Language" content="en-US"/>
  13   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  14   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  15   <meta name="Generator" content="PHP"/>
  16   <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, read, or, write, binary, large, objects, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
  17   <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."/>
  18   <meta name="Rating" content="GENERAL"/>
  19   <meta name="Robots" content="INDEX, FOLLOW"/>
  20   <meta name="Generator" content="ImageMagick Studio LLC"/>
  21   <meta name="Author" content="ImageMagick Studio LLC"/>
  22   <meta name="Revisit-after" content="2 DAYS"/>
  23   <meta name="Resource-type" content="document"/>
  24   <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
  25   <meta name="Distribution" content="Global"/>
  26 </head>\r
  27 \r
  28 <body id="www-imagemagick-org">\r
  29 <div class="titlebar">\r
  30 <a href="../../index.html">\r
  31   <img src="../../images/script.png" alt="[ImageMagick]"\r
  32   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  33 <a href="http://www.networkredux.com">\r
  34   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  35   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  36 <a href="http://www.imagemagick.org/discourse-server/">\r
  37   <img src="../../images/logo.jpg" alt=""\r
  38   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  39 <a href="../../index.html">\r
  40   <img src="../../images/sprite.jpg" alt=""\r
  41   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  42 </div>\r
  43 \r
  44 <div class="eastbar">\r
  45 \r
  46 <div class="menu">
  47   <a href="../../index.html">About ImageMagick</a>
  48 </div>
  49 <div class="sep"></div>\r
  50 <div class="menu">
  51   <a href="../../www/command-line-tools.html">Command-line Tools</a>
  52 </div>
  53 <div class="sub">
  54     <a href="../../www/command-line-processing.html">Processing</a>
  55 </div>
  56 <div class="sub">
  57     <a href="../../www/command-line-options.html">Options</a>
  58 </div>
  59 <div class="sub">
  60     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  61 </div>
  62 <div class="menu">
  63   <a href="../../www/api.html">Program Interfaces</a>
  64 </div>
  65 <div class="sub">
  66     <a href="../../www/magick-wand.html">MagickWand</a>
  67 </div>
  68 <div class="sub">
  69     <a href="../../www/magick-core.html">MagickCore</a>
  70 </div>
  71 <div class="sub">
  72     <a href="../../www/perl-magick.html">PerlMagick</a>
  73 </div>
  74 <div class="sub">
  75     <a href="../../Magick++/">Magick++</a>
  76 </div>
  77 <div class="menu">
  78   <a href="../../www/architecture.html">Architecture</a>
  79 </div>
  80 <div class="sep"></div>\r
  81 <div  class="menu">
  82    <a href="../../www/install-source.html">Install from Source</a>
  83 </div>
  84 <div class="sub">
  85     <a href="../../www/install-source.html#unix">Unix</a>
  86 </div>
  87 <div class="sub">
  88     <a href="../../www/install-source.html#windows">Windows</a>
  89  </div>
  90 <div class="menu">
  91   <a href="../../www/binary-releases.html">Binary Releases</a>
  92 </div>
  93 <div class="sub">
  94     <a href="../../www/binary-releases.html#unix">Unix</a>
  95 </div>
  96 <div class="sub">
  97     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
  98 </div>
  99 <div class="sub">
 100     <a href="../../www/binary-releases.html#windows">Windows</a>
 101 </div>
 102 <div class="menu">
 103   <a href="../../www/resources.html">Resources</a>
 104 </div>
 105 <div class="sep"></div>\r
 106 <div class="menu">
 107   <a href="../../www/download.html">Download</a>
 108 </div>
 109 <div class="sep"></div>\r
 110 <div class="menu">
 111   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 112 </div>
 113 <div class="sep"></div>\r
 114 <div class="menu">
 115   <a href="../../www/sitemap.html">Site Map</a>
 116 </div>
 117 <div  class="sub">
 118     <a href="../../www/links.html">Links</a>
 119 </div>
 120 <div class="sep"></div>\r
 121 <div  class="menu">
 122   <a href="../../www/sponsors.html">Sponsors:</a>
 123
 124 <div class="sponsbox">
 125 <div  class="sponsor">
 126    <a href="http://www.hygi.de">Reinigungsmittel</a><!-- 201002000400+ -->
 127 </div>
 128 <div  class="sponsor">
 129   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201003010120 Buchhorn -->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 133 </div>
 134 <div  class="sponsor">
 135    <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 136 </div>
 137 <div  class="sponsor">
 138    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 139 </div>
 140 <div  class="sponsor">
 141   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 142 </div>
 143 <div  class="sponsor">
 144   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 145 </div>
 146 </div>
 147 </div>
 148 \r
 149 \r
 150 </div>\r
 151 \r
 152 <div class="main">\r
 153 \r
 154 <p class="navigation-index">[<a href="#BlobToImage">BlobToImage</a> &bull; <a href="#FileToImage">FileToImage</a> &bull; <a href="#GetBlobProperties">GetBlobProperties</a> &bull; <a href="#ImageToBlob">ImageToBlob</a> &bull; <a href="#ImageToFile">ImageToFile</a> &bull; <a href="#ImagesToBlob">ImagesToBlob</a> &bull; <a href="#InjectImageBlob">InjectImageBlob</a>]</p>
 155
 156 <h2><a href="http://www.imagemagick.org/api/MagickCore/blob
 157 _8c.html" target="source" name="BlobToImage">BlobToImage</a></h2>
 158 <div class="doc-section">
 159
 160 <p>BlobToImage() implements direct to memory image formats.  It returns the blob as an image.</p></ol>
 161
 162 <p>The format of the BlobToImage method is:</p>
 163
 164 <pre class="code">
 165   Image *BlobToImage(const ImageInfo *image_info,const void *blob,
 166     const size_t length,ExceptionInfo *exception)
 167 </pre>
 168
 169 <p>A description of each parameter follows:</p></ol>
 170
 171 <h5>image_info</h5>
 172 <ol><p>the image info.</p></ol>
 173
 174 <h5>blob</h5>
 175 <ol><p>the address of a character stream in one of the image formats understood by ImageMagick.</p></ol>
 176
 177 <h5>length</h5>
 178 <ol><p>This size_t integer reflects the length in bytes of the blob.</p></ol>
 179
 180 <h5>exception</h5>
 181 <ol><p>return any errors or warnings in this structure.</p></ol>
 182
 183  </div>
 184 <h2><a href="http://www.imagemagick.org/api/MagickCore/blob
 185 _8c.html" target="source" name="FileToImage">FileToImage</a></h2>
 186 <div class="doc-section">
 187
 188 <p>FileToImage() write the contents of a file to an image.</p></ol>
 189
 190 <p>The format of the FileToImage method is:</p>
 191
 192 <pre class="code">
 193   MagickBooleanType FileToImage(Image *,const char *filename)
 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>filename</h5>
 202 <ol><p>the filename.</p></ol>
 203
 204  </div>
 205 <h2><a href="http://www.imagemagick.org/api/MagickCore/blob
 206 _8c.html" target="source" name="GetBlobProperties">GetBlobProperties</a></h2>
 207 <div class="doc-section">
 208
 209 <p>GetBlobProperties() returns information about an image blob.</p></ol>
 210
 211 <p>The format of the GetBlobProperties method is:</p>
 212
 213 <pre class="code">
 214   const struct stat *GetBlobProperties(const Image *image)
 215 </pre>
 216
 217 <p>A description of each parameter follows:</p></ol>
 218
 219 <h5>image</h5>
 220 <ol><p>the image.</p></ol>
 221
 222  </div>
 223 <h2><a href="http://www.imagemagick.org/api/MagickCore/blob
 224 _8c.html" target="source" name="ImageToBlob">ImageToBlob</a></h2>
 225 <div class="doc-section">
 226
 227 <p>ImageToBlob() implements direct to memory image formats.  It returns the image as a blob and its length.  The magick member of the ImageInfo structure determines the format of the returned blob (GIF, JPEG,  PNG, etc.)</p></ol>
 228
 229 <p>The format of the ImageToBlob method is:</p>
 230
 231 <pre class="code">
 232   unsigned char *ImageToBlob(const ImageInfo *image_info,Image *image,
 233     size_t *length,ExceptionInfo *exception)
 234 </pre>
 235
 236 <p>A description of each parameter follows:</p></ol>
 237
 238 <h5>image_info</h5>
 239 <ol><p>the image info.</p></ol>
 240
 241 <h5>image</h5>
 242 <ol><p>the image.</p></ol>
 243
 244 <h5>length</h5>
 245 <ol><p>This pointer to a size_t integer sets the initial length of the blob.  On return, it reflects the actual length of the blob.</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/blob
 252 _8c.html" target="source" name="ImageToFile">ImageToFile</a></h2>
 253 <div class="doc-section">
 254
 255 <p>ImageToFile() writes an image to a file.  It returns MagickFalse if an error occurs otherwise MagickTrue.</p></ol>
 256
 257 <p>The format of the ImageToFile method is:</p>
 258
 259 <pre class="code">
 260    MagickBooleanType ImageToFile(Image *image,char *filename,
 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>filename</h5>
 270 <ol><p>Write the image to this file.</p></ol>
 271
 272 <h5>exception</h5>
 273 <ol><p>return any errors or warnings in this structure.</p></ol>
 274
 275  </div>
 276 <h2><a href="http://www.imagemagick.org/api/MagickCore/blob
 277 _8c.html" target="source" name="ImagesToBlob">ImagesToBlob</a></h2>
 278 <div class="doc-section">
 279
 280 <p>ImagesToBlob() implements direct to memory image formats.  It returns the image sequence as a blob and its length.  The magick member of the ImageInfo structure determines the format of the returned blob (GIF, JPEG,  PNG, etc.)</p></ol>
 281
 282 <p>Note, some image formats do not permit multiple images to the same image stream (e.g. JPEG).  in this instance, just the first image of the sequence is returned as a blob.</p></ol>
 283
 284 <p>The format of the ImagesToBlob method is:</p>
 285
 286 <pre class="code">
 287   unsigned char *ImagesToBlob(const ImageInfo *image_info,Image *images,
 288     size_t *length,ExceptionInfo *exception)
 289 </pre>
 290
 291 <p>A description of each parameter follows:</p></ol>
 292
 293 <h5>image_info</h5>
 294 <ol><p>the image info.</p></ol>
 295
 296 <h5>images</h5>
 297 <ol><p>the image list.</p></ol>
 298
 299 <h5>length</h5>
 300 <ol><p>This pointer to a size_t integer sets the initial length of the blob.  On return, it reflects the actual length of the blob.</p></ol>
 301
 302 <h5>exception</h5>
 303 <ol><p>return any errors or warnings in this structure.</p></ol>
 304
 305  </div>
 306 <h2><a href="http://www.imagemagick.org/api/MagickCore/blob
 307 _8c.html" target="source" name="InjectImageBlob">InjectImageBlob</a></h2>
 308 <div class="doc-section">
 309
 310 <p>InjectImageBlob() injects the image with a copy of itself in the specified format (e.g. inject JPEG into a PDF image).</p></ol>
 311
 312 <p>The format of the InjectImageBlob method is:</p>
 313
 314 <pre class="code">
 315   MagickBooleanType InjectImageBlob(const ImageInfo *image_info,
 316     Image *image,Image *inject_image,const char *format,
 317     ExceptionInfo *exception)
 318 </pre>
 319
 320 <p>A description of each parameter follows:</p></ol>
 321
 322 <h5>image_info</h5>
 323 <ol><p>the image info..</p></ol>
 324
 325 <h5>image</h5>
 326 <ol><p>the image.</p></ol>
 327
 328 <h5>inject_image</h5>
 329 <ol><p>inject into the image stream.</p></ol>
 330
 331 <h5>format</h5>
 332 <ol><p>the image format.</p></ol>
 333
 334 <h5>exception</h5>
 335 <ol><p>return any errors or warnings in this structure.</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="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 346     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 347     </span>\r
 348     <span id="linkbar-east">&nbsp;</span>\r
 349   </div>\r
 350   <div class="footer">\r
 351     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 352     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 353   </div>\r
 354   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 355 </body>\r
 356 </html>\r