Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 16af1cbdffcc02e7239d432e5fb51734fcf9f9ff / . / www / api / blob.html
blob: c2357a907d446d11fb5758e167e19af641924e3f [file] [log] [blame]
cristyf3bb4782009-09-08 13:10:04 +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">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<head>
cristy1f9e1ed2009-11-18 04:09:38 +0000[diff] [blame]5 <meta http-equiv="Content-Type" value="application/xhtml+xml" />
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
7 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
8 <style type="text/css" media="screen,projection"><!--
9 @import url("../../www/magick.css");
10 --></style>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]11 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
12 <title>ImageMagick: MagickCore, C API for ImageMagick: Read or Write Binary Large OBjects</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:, 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"/>
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"/>
cristy16af1cb2009-12-11 21:38:29 +0000[diff] [blame^]25 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]26 <meta name="Distribution" content="Global"/>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]27</head>
28
29<body id="www-imagemagick-org">
30<div class="titlebar">
31<a href="../../index.html">
32 <img src="../../images/script.png" alt="[ImageMagick]"
33 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
34<a href="http://www.networkredux.com">
35 <img src="../../images/networkredux.png" alt="[sponsor]"
36 style="margin: 45px auto; border: 0px; float: left;" /></a>
37<a href="http://www.imagemagick.org/discourse-server/">
38 <img src="../../images/logo.jpg" alt=""
39 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
40<a href="../../index.html">
41 <img src="../../images/sprite.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43</div>
44
45<div class="eastbar">
46
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]47<div class="menu">
48 <a href="../../index.html">About ImageMagick</a>
49</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]50<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]51<div class="menu">
52 <a href="../../www/command-line-tools.html">Command-line Tools</a>
53</div>
54<div class="sub">
55 <a href="../../www/command-line-processing.html">Processing</a>
56</div>
57<div class="sub">
58 <a href="../../www/command-line-options.html">Options</a>
59</div>
60<div class="sub">
61 <a href="http://www.imagemagick.org/Usage/">Usage</a>
62</div>
63<div class="menu">
64 <a href="../../www/api.html">Program Interfaces</a>
65</div>
66<div class="sub">
67 <a href="../../www/magick-wand.html">MagickWand</a>
68</div>
69<div class="sub">
70 <a href="../../www/magick-core.html">MagickCore</a>
71</div>
72<div class="sub">
73 <a href="../../www/perl-magick.html">PerlMagick</a>
74</div>
75<div class="sub">
76 <a href="../../Magick++/">Magick++</a>
77</div>
78<div class="menu">
79 <a href="../../www/architecture.html">Architecture</a>
80</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]81<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]82<div class="menu">
83 <a href="../../www/install-source.html">Install from Source</a>
84</div>
85<div class="sub">
86 <a href="../../www/install-source.html#unix">Unix</a>
87</div>
88<div class="sub">
89 <a href="../../www/install-source.html#windows">Windows</a>
90 </div>
91<div class="menu">
92 <a href="../../www/binary-releases.html">Binary Releases</a>
93</div>
94<div class="sub">
95 <a href="../../www/binary-releases.html#unix">Unix</a>
96</div>
97<div class="sub">
98 <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
99</div>
100<div class="sub">
101 <a href="../../www/binary-releases.html#windows">Windows</a>
102</div>
103<div class="menu">
104 <a href="../../www/resources.html">Resources</a>
105</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]106<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107<div class="menu">
108 <a href="../../www/download.html">Download</a>
109</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111<div class="menu">
112 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
113</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115<div class="menu">
116 <a href="../../www/sitemap.html">Site Map</a>
117</div>
118<div class="sub">
119 <a href="../../www/links.html">Links</a>
120</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]122<div class="menu">
123 <a href="../../www/sponsors.html">Sponsors:</a>
124
125<div class="sponsbox">
126<div class="sponsor">
cristya13871a2009-12-06 19:01:22 +0000[diff] [blame]127 <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20101101000200 -->
cristyec407392009-11-28 22:42:05 +0000[diff] [blame]128</div>
129<div class="sponsor">
cristy1f9e1ed2009-11-18 04:09:38 +0000[diff] [blame]130 <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
131</div>
132<div class="sponsor">
cristy0f61e612009-11-10 20:03:57 +0000[diff] [blame]133 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201004010120 Buchhorn -->
cristyc1c61662009-09-30 14:04:37 +0000[diff] [blame]134</div>
135<div class="sponsor">
cristy0f61e612009-11-10 20:03:57 +0000[diff] [blame]136 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
cristy916e1922009-10-01 12:52:47 +0000[diff] [blame]137</div>
138<div class="sponsor">
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]139 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
140</div>
141<div class="sponsor">
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]142 <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
143</div>
144<div class="sponsor">
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]145 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
146</div>
147<div class="sponsor">
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]148 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
149</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]150</div>
151</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]152
153
154</div>
155
156<div class="main">
157
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]158<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>
159
160<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
161_8c.html" target="source" name="BlobToImage">BlobToImage</a></h2>
162<div class="doc-section">
163
164<p>BlobToImage() implements direct to memory image formats. It returns the blob as an image.</p></ol>
165
166<p>The format of the BlobToImage method is:</p>
167
168<pre class="code">
169 Image *BlobToImage(const ImageInfo *image_info,const void *blob,
170 const size_t length,ExceptionInfo *exception)
171</pre>
172
173<p>A description of each parameter follows:</p></ol>
174
175<h5>image_info</h5>
176<ol><p>the image info.</p></ol>
177
178<h5>blob</h5>
179<ol><p>the address of a character stream in one of the image formats understood by ImageMagick.</p></ol>
180
181<h5>length</h5>
182<ol><p>This size_t integer reflects the length in bytes of the blob.</p></ol>
183
184<h5>exception</h5>
185<ol><p>return any errors or warnings in this structure.</p></ol>
186
187 </div>
188<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
189_8c.html" target="source" name="FileToImage">FileToImage</a></h2>
190<div class="doc-section">
191
192<p>FileToImage() write the contents of a file to an image.</p></ol>
193
194<p>The format of the FileToImage method is:</p>
195
196<pre class="code">
197 MagickBooleanType FileToImage(Image *,const char *filename)
198</pre>
199
200<p>A description of each parameter follows:</p></ol>
201
202<h5>image</h5>
203<ol><p>the image.</p></ol>
204
205<h5>filename</h5>
206<ol><p>the filename.</p></ol>
207
208 </div>
209<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
210_8c.html" target="source" name="GetBlobProperties">GetBlobProperties</a></h2>
211<div class="doc-section">
212
213<p>GetBlobProperties() returns information about an image blob.</p></ol>
214
215<p>The format of the GetBlobProperties method is:</p>
216
217<pre class="code">
218 const struct stat *GetBlobProperties(const Image *image)
219</pre>
220
221<p>A description of each parameter follows:</p></ol>
222
223<h5>image</h5>
224<ol><p>the image.</p></ol>
225
226 </div>
227<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
228_8c.html" target="source" name="ImageToBlob">ImageToBlob</a></h2>
229<div class="doc-section">
230
231<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>
232
233<p>The format of the ImageToBlob method is:</p>
234
235<pre class="code">
236 unsigned char *ImageToBlob(const ImageInfo *image_info,Image *image,
237 size_t *length,ExceptionInfo *exception)
238</pre>
239
240<p>A description of each parameter follows:</p></ol>
241
242<h5>image_info</h5>
243<ol><p>the image info.</p></ol>
244
245<h5>image</h5>
246<ol><p>the image.</p></ol>
247
248<h5>length</h5>
249<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>
250
251<h5>exception</h5>
252<ol><p>return any errors or warnings in this structure.</p></ol>
253
254 </div>
255<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
256_8c.html" target="source" name="ImageToFile">ImageToFile</a></h2>
257<div class="doc-section">
258
259<p>ImageToFile() writes an image to a file. It returns MagickFalse if an error occurs otherwise MagickTrue.</p></ol>
260
261<p>The format of the ImageToFile method is:</p>
262
263<pre class="code">
264 MagickBooleanType ImageToFile(Image *image,char *filename,
265 ExceptionInfo *exception)
266</pre>
267
268<p>A description of each parameter follows:</p></ol>
269
270<h5>image</h5>
271<ol><p>the image.</p></ol>
272
273<h5>filename</h5>
274<ol><p>Write the image to this file.</p></ol>
275
276<h5>exception</h5>
277<ol><p>return any errors or warnings in this structure.</p></ol>
278
279 </div>
280<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
281_8c.html" target="source" name="ImagesToBlob">ImagesToBlob</a></h2>
282<div class="doc-section">
283
284<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>
285
286<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>
287
288<p>The format of the ImagesToBlob method is:</p>
289
290<pre class="code">
291 unsigned char *ImagesToBlob(const ImageInfo *image_info,Image *images,
292 size_t *length,ExceptionInfo *exception)
293</pre>
294
295<p>A description of each parameter follows:</p></ol>
296
297<h5>image_info</h5>
298<ol><p>the image info.</p></ol>
299
300<h5>images</h5>
301<ol><p>the image list.</p></ol>
302
303<h5>length</h5>
304<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>
305
306<h5>exception</h5>
307<ol><p>return any errors or warnings in this structure.</p></ol>
308
309 </div>
310<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
311_8c.html" target="source" name="InjectImageBlob">InjectImageBlob</a></h2>
312<div class="doc-section">
313
314<p>InjectImageBlob() injects the image with a copy of itself in the specified format (e.g. inject JPEG into a PDF image).</p></ol>
315
316<p>The format of the InjectImageBlob method is:</p>
317
318<pre class="code">
319 MagickBooleanType InjectImageBlob(const ImageInfo *image_info,
320 Image *image,Image *inject_image,const char *format,
321 ExceptionInfo *exception)
322</pre>
323
324<p>A description of each parameter follows:</p></ol>
325
326<h5>image_info</h5>
327<ol><p>the image info..</p></ol>
328
329<h5>image</h5>
330<ol><p>the image.</p></ol>
331
332<h5>inject_image</h5>
333<ol><p>inject into the image stream.</p></ol>
334
335<h5>format</h5>
336<ol><p>the image format.</p></ol>
337
338<h5>exception</h5>
339<ol><p>return any errors or warnings in this structure.</p></ol>
340
341 </div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]342
343</div>
344
345<div id="linkbar">
346 <!-- <span id="linkbar-west">&nbsp;</span> -->
347 <span id="linkbar-center">
348 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
349 <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
cristycb03ed62009-12-11 21:30:51 +0000[diff] [blame]350 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]351 </span>
352 <span id="linkbar-east">&nbsp;</span>
353 </div>
354 <div class="footer">
cristy16af1cb2009-12-11 21:38:29 +0000[diff] [blame^]355 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]356 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
357 </div>
358 <div style="clear: both; margin: 0; width: 100%; "></div>
359</body>
360</html>