Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / ffb69edc137c5ad509f39e4e2cdb1fefe792068a / . / www / api / blob.html
blob: 38d547966b715b379bb92c47df8537317625176e [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame]3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame^]7 <title>ImageMagick: MagickCore, C API for ImageMagick: Read or Write Binary Large OBjects</title>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]11 <meta name="Application-name" content="ImageMagick"/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame^]12 <meta name="Description" content="ImageMagick is a software suite to create, edit, or compose bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]13 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]14 <meta name="Generator" content="PHP"/>
15 <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"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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"/>
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]22 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]23 <meta name="Distribution" content="Global"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]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"/>
27 <style type="text/css" media="all">
28 @import url("../../www/magick.css");
29 </style>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]30</head>
31
32<body id="www-imagemagick-org">
33<div class="titlebar">
34<a href="../../index.html">
35 <img src="../../images/script.png" alt="[ImageMagick]"
36 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
37<a href="http://www.networkredux.com">
38 <img src="../../images/networkredux.png" alt="[sponsor]"
39 style="margin: 45px auto; border: 0px; float: left;" /></a>
40<a href="http://www.imagemagick.org/discourse-server/">
41 <img src="../../images/logo.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43<a href="../../index.html">
44 <img src="../../images/sprite.jpg" alt=""
45 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
46</div>
47
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]48<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]49
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]50<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]51 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]52</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]53<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]54<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]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>
67<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]68 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]69</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]71 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]72</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]74 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]75</div>
76<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]77 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]78</div>
79<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]80 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]83 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]84</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]86 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]87</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]89 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]90</div>
91<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]92 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]93</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]94<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]95<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]96 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]97</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]99 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103 </div>
104<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]105 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]107<div class="menu">
108 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
109</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]110<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]111 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]112</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]113<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]115 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]116</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]117<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]118<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame^]119 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
121<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame^]122 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]123</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]124<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]125<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]126 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]127
128<div class="sponsbox">
129<div class="sponsor">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame^]130 <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
cristy7d52cd62010-10-01 17:26:59 +0000[diff] [blame]131</div>
132<div class="sponsor">
133 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000[diff] [blame]134</div>
135<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]136 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
137</div>
138<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]139 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]142 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristyc02484c2010-03-08 00:14:58 +0000[diff] [blame]143</div>
144<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]145 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]146</div>
147<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]148 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
cristy916e1922009-10-01 12:52:47 +0000[diff] [blame]149</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]150</div>
151</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]152</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]153
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]154<div class="eastbar">
155 <script type="text/javascript">
156 <!--
157 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]158 google_ad_slot = "0574824969";
159 google_ad_width = 160;
160 google_ad_height = 600;
161 //-->
162 </script>
163 <script type="text/javascript"
164 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
165 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]166</div>
167
168<div class="main">
169
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]170<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>
171
172<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
173_8c.html" target="source" name="BlobToImage">BlobToImage</a></h2>
174<div class="doc-section">
175
176<p>BlobToImage() implements direct to memory image formats. It returns the blob as an image.</p></ol>
177
178<p>The format of the BlobToImage method is:</p>
179
180<pre class="code">
181 Image *BlobToImage(const ImageInfo *image_info,const void *blob,
182 const size_t length,ExceptionInfo *exception)
183</pre>
184
185<p>A description of each parameter follows:</p></ol>
186
187<h5>image_info</h5>
188<ol><p>the image info.</p></ol>
189
190<h5>blob</h5>
191<ol><p>the address of a character stream in one of the image formats understood by ImageMagick.</p></ol>
192
193<h5>length</h5>
194<ol><p>This size_t integer reflects the length in bytes of the blob.</p></ol>
195
196<h5>exception</h5>
197<ol><p>return any errors or warnings in this structure.</p></ol>
198
199 </div>
200<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
201_8c.html" target="source" name="FileToImage">FileToImage</a></h2>
202<div class="doc-section">
203
204<p>FileToImage() write the contents of a file to an image.</p></ol>
205
206<p>The format of the FileToImage method is:</p>
207
208<pre class="code">
209 MagickBooleanType FileToImage(Image *,const char *filename)
210</pre>
211
212<p>A description of each parameter follows:</p></ol>
213
214<h5>image</h5>
215<ol><p>the image.</p></ol>
216
217<h5>filename</h5>
218<ol><p>the filename.</p></ol>
219
220 </div>
221<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
222_8c.html" target="source" name="GetBlobProperties">GetBlobProperties</a></h2>
223<div class="doc-section">
224
225<p>GetBlobProperties() returns information about an image blob.</p></ol>
226
227<p>The format of the GetBlobProperties method is:</p>
228
229<pre class="code">
230 const struct stat *GetBlobProperties(const Image *image)
231</pre>
232
233<p>A description of each parameter follows:</p></ol>
234
235<h5>image</h5>
236<ol><p>the image.</p></ol>
237
238 </div>
239<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
240_8c.html" target="source" name="ImageToBlob">ImageToBlob</a></h2>
241<div class="doc-section">
242
243<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>
244
245<p>The format of the ImageToBlob method is:</p>
246
247<pre class="code">
248 unsigned char *ImageToBlob(const ImageInfo *image_info,Image *image,
249 size_t *length,ExceptionInfo *exception)
250</pre>
251
252<p>A description of each parameter follows:</p></ol>
253
254<h5>image_info</h5>
255<ol><p>the image info.</p></ol>
256
257<h5>image</h5>
258<ol><p>the image.</p></ol>
259
260<h5>length</h5>
261<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>
262
263<h5>exception</h5>
264<ol><p>return any errors or warnings in this structure.</p></ol>
265
266 </div>
267<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
268_8c.html" target="source" name="ImageToFile">ImageToFile</a></h2>
269<div class="doc-section">
270
271<p>ImageToFile() writes an image to a file. It returns MagickFalse if an error occurs otherwise MagickTrue.</p></ol>
272
273<p>The format of the ImageToFile method is:</p>
274
275<pre class="code">
276 MagickBooleanType ImageToFile(Image *image,char *filename,
277 ExceptionInfo *exception)
278</pre>
279
280<p>A description of each parameter follows:</p></ol>
281
282<h5>image</h5>
283<ol><p>the image.</p></ol>
284
285<h5>filename</h5>
286<ol><p>Write the image to this file.</p></ol>
287
288<h5>exception</h5>
289<ol><p>return any errors or warnings in this structure.</p></ol>
290
291 </div>
292<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
293_8c.html" target="source" name="ImagesToBlob">ImagesToBlob</a></h2>
294<div class="doc-section">
295
296<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>
297
298<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>
299
300<p>The format of the ImagesToBlob method is:</p>
301
302<pre class="code">
303 unsigned char *ImagesToBlob(const ImageInfo *image_info,Image *images,
304 size_t *length,ExceptionInfo *exception)
305</pre>
306
307<p>A description of each parameter follows:</p></ol>
308
309<h5>image_info</h5>
310<ol><p>the image info.</p></ol>
311
312<h5>images</h5>
313<ol><p>the image list.</p></ol>
314
315<h5>length</h5>
316<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>
317
318<h5>exception</h5>
319<ol><p>return any errors or warnings in this structure.</p></ol>
320
321 </div>
322<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
323_8c.html" target="source" name="InjectImageBlob">InjectImageBlob</a></h2>
324<div class="doc-section">
325
326<p>InjectImageBlob() injects the image with a copy of itself in the specified format (e.g. inject JPEG into a PDF image).</p></ol>
327
328<p>The format of the InjectImageBlob method is:</p>
329
330<pre class="code">
331 MagickBooleanType InjectImageBlob(const ImageInfo *image_info,
332 Image *image,Image *inject_image,const char *format,
333 ExceptionInfo *exception)
334</pre>
335
336<p>A description of each parameter follows:</p></ol>
337
338<h5>image_info</h5>
339<ol><p>the image info..</p></ol>
340
341<h5>image</h5>
342<ol><p>the image.</p></ol>
343
344<h5>inject_image</h5>
345<ol><p>inject into the image stream.</p></ol>
346
347<h5>format</h5>
348<ol><p>the image format.</p></ol>
349
350<h5>exception</h5>
351<ol><p>return any errors or warnings in this structure.</p></ol>
352
353 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]354
355</div>
356
357<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]358 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]359 <span id="linkbar-center">
360 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]361 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]362 </span>
363 <span id="linkbar-east">&nbsp;</span>
364 </div>
365 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]366 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]367 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
368 </div>
369 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]370 <script type="text/javascript">
371 var _gaq = _gaq || [];
372 _gaq.push(['_setAccount', 'UA-17690367-1']);
373 _gaq.push(['_trackPageview']);
374
375 (function() {
376 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
377 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
378 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
379 })();
380 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]381</body>
382</html>