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