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.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 127 </div>
 128 <div  class="sponsor">
 129    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 133 </div>
 134 <div  class="sponsor">
 135   <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
 136 </div>
 137 <div  class="sponsor">
 138   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 139 </div>
 140 <div  class="sponsor">
 141   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201002010120 Buchhorn -->
 142 </div>
 143 </div>
 144 </div>
 145 \r
 146 \r
 147 </div>\r
 148 \r
 149 <div class="main">\r
 150 \r
 151 <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>
 152
 153 <h2><a href="http://www.imagemagick.org/api/MagickCore/blob
 154 _8c.html" target="source" name="BlobToImage">BlobToImage</a></h2>
 155 <div class="doc-section">
 156
 157 <p>BlobToImage() implements direct to memory image formats.  It returns the blob as an image.</p></ol>
 158
 159 <p>The format of the BlobToImage method is:</p>
 160
 161 <pre class="code">
 162   Image *BlobToImage(const ImageInfo *image_info,const void *blob,
 163     const size_t length,ExceptionInfo *exception)
 164 </pre>
 165
 166 <p>A description of each parameter follows:</p></ol>
 167
 168 <h5>image_info</h5>
 169 <ol><p>the image info.</p></ol>
 170
 171 <h5>blob</h5>
 172 <ol><p>the address of a character stream in one of the image formats understood by ImageMagick.</p></ol>
 173
 174 <h5>length</h5>
 175 <ol><p>This size_t integer reflects the length in bytes of the blob.</p></ol>
 176
 177 <h5>exception</h5>
 178 <ol><p>return any errors or warnings in this structure.</p></ol>
 179
 180  </div>
 181 <h2><a href="http://www.imagemagick.org/api/MagickCore/blob
 182 _8c.html" target="source" name="FileToImage">FileToImage</a></h2>
 183 <div class="doc-section">
 184
 185 <p>FileToImage() write the contents of a file to an image.</p></ol>
 186
 187 <p>The format of the FileToImage method is:</p>
 188
 189 <pre class="code">
 190   MagickBooleanType FileToImage(Image *,const char *filename)
 191 </pre>
 192
 193 <p>A description of each parameter follows:</p></ol>
 194
 195 <h5>image</h5>
 196 <ol><p>the image.</p></ol>
 197
 198 <h5>filename</h5>
 199 <ol><p>the filename.</p></ol>
 200
 201  </div>
 202 <h2><a href="http://www.imagemagick.org/api/MagickCore/blob
 203 _8c.html" target="source" name="GetBlobProperties">GetBlobProperties</a></h2>
 204 <div class="doc-section">
 205
 206 <p>GetBlobProperties() returns information about an image blob.</p></ol>
 207
 208 <p>The format of the GetBlobProperties method is:</p>
 209
 210 <pre class="code">
 211   const struct stat *GetBlobProperties(const Image *image)
 212 </pre>
 213
 214 <p>A description of each parameter follows:</p></ol>
 215
 216 <h5>image</h5>
 217 <ol><p>the image.</p></ol>
 218
 219  </div>
 220 <h2><a href="http://www.imagemagick.org/api/MagickCore/blob
 221 _8c.html" target="source" name="ImageToBlob">ImageToBlob</a></h2>
 222 <div class="doc-section">
 223
 224 <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>
 225
 226 <p>The format of the ImageToBlob method is:</p>
 227
 228 <pre class="code">
 229   unsigned char *ImageToBlob(const ImageInfo *image_info,Image *image,
 230     size_t *length,ExceptionInfo *exception)
 231 </pre>
 232
 233 <p>A description of each parameter follows:</p></ol>
 234
 235 <h5>image_info</h5>
 236 <ol><p>the image info.</p></ol>
 237
 238 <h5>image</h5>
 239 <ol><p>the image.</p></ol>
 240
 241 <h5>length</h5>
 242 <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>
 243
 244 <h5>exception</h5>
 245 <ol><p>return any errors or warnings in this structure.</p></ol>
 246
 247  </div>
 248 <h2><a href="http://www.imagemagick.org/api/MagickCore/blob
 249 _8c.html" target="source" name="ImageToFile">ImageToFile</a></h2>
 250 <div class="doc-section">
 251
 252 <p>ImageToFile() writes an image to a file.  It returns MagickFalse if an error occurs otherwise MagickTrue.</p></ol>
 253
 254 <p>The format of the ImageToFile method is:</p>
 255
 256 <pre class="code">
 257    MagickBooleanType ImageToFile(Image *image,char *filename,
 258      ExceptionInfo *exception)
 259 </pre>
 260
 261 <p>A description of each parameter follows:</p></ol>
 262
 263 <h5>image</h5>
 264 <ol><p>the image.</p></ol>
 265
 266 <h5>filename</h5>
 267 <ol><p>Write the image to this file.</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/blob
 274 _8c.html" target="source" name="ImagesToBlob">ImagesToBlob</a></h2>
 275 <div class="doc-section">
 276
 277 <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>
 278
 279 <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>
 280
 281 <p>The format of the ImagesToBlob method is:</p>
 282
 283 <pre class="code">
 284   unsigned char *ImagesToBlob(const ImageInfo *image_info,Image *images,
 285     size_t *length,ExceptionInfo *exception)
 286 </pre>
 287
 288 <p>A description of each parameter follows:</p></ol>
 289
 290 <h5>image_info</h5>
 291 <ol><p>the image info.</p></ol>
 292
 293 <h5>images</h5>
 294 <ol><p>the image list.</p></ol>
 295
 296 <h5>length</h5>
 297 <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>
 298
 299 <h5>exception</h5>
 300 <ol><p>return any errors or warnings in this structure.</p></ol>
 301
 302  </div>
 303 <h2><a href="http://www.imagemagick.org/api/MagickCore/blob
 304 _8c.html" target="source" name="InjectImageBlob">InjectImageBlob</a></h2>
 305 <div class="doc-section">
 306
 307 <p>InjectImageBlob() injects the image with a copy of itself in the specified format (e.g. inject JPEG into a PDF image).</p></ol>
 308
 309 <p>The format of the InjectImageBlob method is:</p>
 310
 311 <pre class="code">
 312   MagickBooleanType InjectImageBlob(const ImageInfo *image_info,
 313     Image *image,Image *inject_image,const char *format,
 314     ExceptionInfo *exception)
 315 </pre>
 316
 317 <p>A description of each parameter follows:</p></ol>
 318
 319 <h5>image_info</h5>
 320 <ol><p>the image info..</p></ol>
 321
 322 <h5>image</h5>
 323 <ol><p>the image.</p></ol>
 324
 325 <h5>inject_image</h5>
 326 <ol><p>inject into the image stream.</p></ol>
 327
 328 <h5>format</h5>
 329 <ol><p>the image format.</p></ol>
 330
 331 <h5>exception</h5>
 332 <ol><p>return any errors or warnings in this structure.</p></ol>
 333
 334  </div>
 335 \r
 336 </div>\r
 337 \r
 338 <div id="linkbar">\r
 339  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 340     <span id="linkbar-center">\r
 341       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 342       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 343     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 344     </span>\r
 345     <span id="linkbar-east">&nbsp;</span>\r
 346   </div>\r
 347   <div class="footer">\r
 348     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 349     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 350   </div>\r
 351   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 352 </body>\r
 353 </html>\r