Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 2c8396015846a8b80baa4772893cf50b36268276 / . / www / api / blob.html
blob: 2087aeb611fd56705cff51dda6ceb865c622f934 [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>
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame^]5 <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +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"/>
cristy3eaa0ef2010-03-06 20:35:26 +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>
cristy3eaa0ef2010-03-06 20:35:26 +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>
cristy3eaa0ef2010-03-06 20:35:26 +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>
cristy3eaa0ef2010-03-06 20:35:26 +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>
cristy3eaa0ef2010-03-06 20:35:26 +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>
cristy3eaa0ef2010-03-06 20:35:26 +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>
cristy3eaa0ef2010-03-06 20:35:26 +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">
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame^]127 <a href="http://www.geschenke-elsen.de/" title="Lampe Berger">Lampe Berger</a><!-- 20106101000040 -->
cristyc02484c2010-03-08 00:14:58 +0000[diff] [blame]128</div>
129<div class="sponsor">
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]130 <a href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
131</div>
132<div class="sponsor">
cristy1f9e1ed2009-11-18 04:09:38 +0000[diff] [blame]133 <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
134</div>
135<div class="sponsor">
cristycdbe2742010-02-07 19:30:44 +0000[diff] [blame]136 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
cristyc1c61662009-09-30 14:04:37 +0000[diff] [blame]137</div>
138<div class="sponsor">
cristy0f61e612009-11-10 20:03:57 +0000[diff] [blame]139 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
cristy916e1922009-10-01 12:52:47 +0000[diff] [blame]140</div>
141<div class="sponsor">
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]142 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
143</div>
144<div class="sponsor">
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]145 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]146</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]147</div>
148</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]149
150
151</div>
152
153<div class="main">
154
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]155<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>
156
157<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
158_8c.html" target="source" name="BlobToImage">BlobToImage</a></h2>
159<div class="doc-section">
160
161<p>BlobToImage() implements direct to memory image formats. It returns the blob as an image.</p></ol>
162
163<p>The format of the BlobToImage method is:</p>
164
165<pre class="code">
166 Image *BlobToImage(const ImageInfo *image_info,const void *blob,
167 const size_t length,ExceptionInfo *exception)
168</pre>
169
170<p>A description of each parameter follows:</p></ol>
171
172<h5>image_info</h5>
173<ol><p>the image info.</p></ol>
174
175<h5>blob</h5>
176<ol><p>the address of a character stream in one of the image formats understood by ImageMagick.</p></ol>
177
178<h5>length</h5>
179<ol><p>This size_t integer reflects the length in bytes of the blob.</p></ol>
180
181<h5>exception</h5>
182<ol><p>return any errors or warnings in this structure.</p></ol>
183
184 </div>
185<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
186_8c.html" target="source" name="FileToImage">FileToImage</a></h2>
187<div class="doc-section">
188
189<p>FileToImage() write the contents of a file to an image.</p></ol>
190
191<p>The format of the FileToImage method is:</p>
192
193<pre class="code">
194 MagickBooleanType FileToImage(Image *,const char *filename)
195</pre>
196
197<p>A description of each parameter follows:</p></ol>
198
199<h5>image</h5>
200<ol><p>the image.</p></ol>
201
202<h5>filename</h5>
203<ol><p>the filename.</p></ol>
204
205 </div>
206<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
207_8c.html" target="source" name="GetBlobProperties">GetBlobProperties</a></h2>
208<div class="doc-section">
209
210<p>GetBlobProperties() returns information about an image blob.</p></ol>
211
212<p>The format of the GetBlobProperties method is:</p>
213
214<pre class="code">
215 const struct stat *GetBlobProperties(const Image *image)
216</pre>
217
218<p>A description of each parameter follows:</p></ol>
219
220<h5>image</h5>
221<ol><p>the image.</p></ol>
222
223 </div>
224<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
225_8c.html" target="source" name="ImageToBlob">ImageToBlob</a></h2>
226<div class="doc-section">
227
228<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>
229
230<p>The format of the ImageToBlob method is:</p>
231
232<pre class="code">
233 unsigned char *ImageToBlob(const ImageInfo *image_info,Image *image,
234 size_t *length,ExceptionInfo *exception)
235</pre>
236
237<p>A description of each parameter follows:</p></ol>
238
239<h5>image_info</h5>
240<ol><p>the image info.</p></ol>
241
242<h5>image</h5>
243<ol><p>the image.</p></ol>
244
245<h5>length</h5>
246<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>
247
248<h5>exception</h5>
249<ol><p>return any errors or warnings in this structure.</p></ol>
250
251 </div>
252<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
253_8c.html" target="source" name="ImageToFile">ImageToFile</a></h2>
254<div class="doc-section">
255
256<p>ImageToFile() writes an image to a file. It returns MagickFalse if an error occurs otherwise MagickTrue.</p></ol>
257
258<p>The format of the ImageToFile method is:</p>
259
260<pre class="code">
261 MagickBooleanType ImageToFile(Image *image,char *filename,
262 ExceptionInfo *exception)
263</pre>
264
265<p>A description of each parameter follows:</p></ol>
266
267<h5>image</h5>
268<ol><p>the image.</p></ol>
269
270<h5>filename</h5>
271<ol><p>Write the image to this file.</p></ol>
272
273<h5>exception</h5>
274<ol><p>return any errors or warnings in this structure.</p></ol>
275
276 </div>
277<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
278_8c.html" target="source" name="ImagesToBlob">ImagesToBlob</a></h2>
279<div class="doc-section">
280
281<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>
282
283<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>
284
285<p>The format of the ImagesToBlob method is:</p>
286
287<pre class="code">
288 unsigned char *ImagesToBlob(const ImageInfo *image_info,Image *images,
289 size_t *length,ExceptionInfo *exception)
290</pre>
291
292<p>A description of each parameter follows:</p></ol>
293
294<h5>image_info</h5>
295<ol><p>the image info.</p></ol>
296
297<h5>images</h5>
298<ol><p>the image list.</p></ol>
299
300<h5>length</h5>
301<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>
302
303<h5>exception</h5>
304<ol><p>return any errors or warnings in this structure.</p></ol>
305
306 </div>
307<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
308_8c.html" target="source" name="InjectImageBlob">InjectImageBlob</a></h2>
309<div class="doc-section">
310
311<p>InjectImageBlob() injects the image with a copy of itself in the specified format (e.g. inject JPEG into a PDF image).</p></ol>
312
313<p>The format of the InjectImageBlob method is:</p>
314
315<pre class="code">
316 MagickBooleanType InjectImageBlob(const ImageInfo *image_info,
317 Image *image,Image *inject_image,const char *format,
318 ExceptionInfo *exception)
319</pre>
320
321<p>A description of each parameter follows:</p></ol>
322
323<h5>image_info</h5>
324<ol><p>the image info..</p></ol>
325
326<h5>image</h5>
327<ol><p>the image.</p></ol>
328
329<h5>inject_image</h5>
330<ol><p>inject into the image stream.</p></ol>
331
332<h5>format</h5>
333<ol><p>the image format.</p></ol>
334
335<h5>exception</h5>
336<ol><p>return any errors or warnings in this structure.</p></ol>
337
338 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]339
340</div>
341
342<div id="linkbar">
343 <!-- <span id="linkbar-west">&nbsp;</span> -->
344 <span id="linkbar-center">
345 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame^]346 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]347 </span>
348 <span id="linkbar-east">&nbsp;</span>
349 </div>
350 <div class="footer">
351 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
352 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
353 </div>
354 <div style="clear: both; margin: 0; width: 100%; "></div>
355</body>
356</html>