Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 3ed852eea50f9d4cd633efb8c2b054b8e33c2530 / . / www / api / blob.html
blob: 647f9764fc29f90931861497eaad8546edf4c546 [file] [log] [blame]
cristy3ed852e2009-09-05 21:47:34 +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>
5 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
6 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
7 <style type="text/css" media="screen,projection"><!--
8 @import url("../../www/magick.css");
9 --></style>
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>
27
28<body id="www-imagemagick-org">
29<div class="titlebar">
30<a href="../../index.html">
31 <img src="../../images/script.png" alt="[ImageMagick]"
32 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
33<a href="http://www.networkredux.com">
34 <img src="../../images/networkredux.png" alt="[sponsor]"
35 style="margin: 45px auto; border: 0px; float: left;" /></a>
36<a href="http://www.imagemagick.org/discourse-server/">
37 <img src="../../images/logo.jpg" alt=""
38 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
39<a href="../../index.html">
40 <img src="../../images/sprite.jpg" alt=""
41 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
42</div>
43
44<div class="eastbar">
45
46<div class="menu">
47 <a href="../../index.html">About ImageMagick</a>
48</div>
49<div class="sep"></div>
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>
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>
106<div class="menu">
107 <a href="../../www/download.html">Download</a>
108</div>
109<div class="sep"></div>
110<div class="menu">
111 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
112</div>
113<div class="sep"></div>
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>
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.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
127</div>
128<div class="sponsor">
129 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
130</div>
131<div class="sponsor">
132 <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
133</div>
134<div class="sponsor">
135 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
136</div>
137<div class="sponsor">
138 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201001010120 Buchhorn -->
139</div>
140</div>
141</div>
142
143
144</div>
145
146<div class="main">
147
148<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>
149
150<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
151_8c.html" target="source" name="BlobToImage">BlobToImage</a></h2>
152<div class="doc-section">
153
154<p>BlobToImage() implements direct to memory image formats. It returns the blob as an image.</p></ol>
155
156<p>The format of the BlobToImage method is:</p>
157
158<pre class="code">
159 Image *BlobToImage(const ImageInfo *image_info,const void *blob,
160 const size_t length,ExceptionInfo *exception)
161</pre>
162
163<p>A description of each parameter follows:</p></ol>
164
165<h5>image_info</h5>
166<ol><p>the image info.</p></ol>
167
168<h5>blob</h5>
169<ol><p>the address of a character stream in one of the image formats understood by ImageMagick.</p></ol>
170
171<h5>length</h5>
172<ol><p>This size_t integer reflects the length in bytes of the blob.</p></ol>
173
174<h5>exception</h5>
175<ol><p>return any errors or warnings in this structure.</p></ol>
176
177 </div>
178<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
179_8c.html" target="source" name="FileToImage">FileToImage</a></h2>
180<div class="doc-section">
181
182<p>FileToImage() write the contents of a file to an image.</p></ol>
183
184<p>The format of the FileToImage method is:</p>
185
186<pre class="code">
187 MagickBooleanType FileToImage(Image *,const char *filename)
188</pre>
189
190<p>A description of each parameter follows:</p></ol>
191
192<h5>image</h5>
193<ol><p>the image.</p></ol>
194
195<h5>filename</h5>
196<ol><p>the filename.</p></ol>
197
198 </div>
199<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
200_8c.html" target="source" name="GetBlobProperties">GetBlobProperties</a></h2>
201<div class="doc-section">
202
203<p>GetBlobProperties() returns information about an image blob.</p></ol>
204
205<p>The format of the GetBlobProperties method is:</p>
206
207<pre class="code">
208 const struct stat *GetBlobProperties(const Image *image)
209</pre>
210
211<p>A description of each parameter follows:</p></ol>
212
213<h5>image</h5>
214<ol><p>the image.</p></ol>
215
216 </div>
217<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
218_8c.html" target="source" name="ImageToBlob">ImageToBlob</a></h2>
219<div class="doc-section">
220
221<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>
222
223<p>The format of the ImageToBlob method is:</p>
224
225<pre class="code">
226 unsigned char *ImageToBlob(const ImageInfo *image_info,Image *image,
227 size_t *length,ExceptionInfo *exception)
228</pre>
229
230<p>A description of each parameter follows:</p></ol>
231
232<h5>image_info</h5>
233<ol><p>the image info.</p></ol>
234
235<h5>image</h5>
236<ol><p>the image.</p></ol>
237
238<h5>length</h5>
239<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>
240
241<h5>exception</h5>
242<ol><p>return any errors or warnings in this structure.</p></ol>
243
244 </div>
245<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
246_8c.html" target="source" name="ImageToFile">ImageToFile</a></h2>
247<div class="doc-section">
248
249<p>ImageToFile() writes an image to a file. It returns MagickFalse if an error occurs otherwise MagickTrue.</p></ol>
250
251<p>The format of the ImageToFile method is:</p>
252
253<pre class="code">
254 MagickBooleanType ImageToFile(Image *image,char *filename,
255 ExceptionInfo *exception)
256</pre>
257
258<p>A description of each parameter follows:</p></ol>
259
260<h5>image</h5>
261<ol><p>the image.</p></ol>
262
263<h5>filename</h5>
264<ol><p>Write the image to this file.</p></ol>
265
266<h5>exception</h5>
267<ol><p>return any errors or warnings in this structure.</p></ol>
268
269 </div>
270<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
271_8c.html" target="source" name="ImagesToBlob">ImagesToBlob</a></h2>
272<div class="doc-section">
273
274<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>
275
276<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>
277
278<p>The format of the ImagesToBlob method is:</p>
279
280<pre class="code">
281 unsigned char *ImagesToBlob(const ImageInfo *image_info,Image *images,
282 size_t *length,ExceptionInfo *exception)
283</pre>
284
285<p>A description of each parameter follows:</p></ol>
286
287<h5>image_info</h5>
288<ol><p>the image info.</p></ol>
289
290<h5>images</h5>
291<ol><p>the image list.</p></ol>
292
293<h5>length</h5>
294<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>
295
296<h5>exception</h5>
297<ol><p>return any errors or warnings in this structure.</p></ol>
298
299 </div>
300<h2><a href="http://www.imagemagick.org/api/MagickCore/blob
301_8c.html" target="source" name="InjectImageBlob">InjectImageBlob</a></h2>
302<div class="doc-section">
303
304<p>InjectImageBlob() injects the image with a copy of itself in the specified format (e.g. inject JPEG into a PDF image).</p></ol>
305
306<p>The format of the InjectImageBlob method is:</p>
307
308<pre class="code">
309 MagickBooleanType InjectImageBlob(const ImageInfo *image_info,
310 Image *image,Image *inject_image,const char *format,
311 ExceptionInfo *exception)
312</pre>
313
314<p>A description of each parameter follows:</p></ol>
315
316<h5>image_info</h5>
317<ol><p>the image info..</p></ol>
318
319<h5>image</h5>
320<ol><p>the image.</p></ol>
321
322<h5>inject_image</h5>
323<ol><p>inject into the image stream.</p></ol>
324
325<h5>format</h5>
326<ol><p>the image format.</p></ol>
327
328<h5>exception</h5>
329<ol><p>return any errors or warnings in this structure.</p></ol>
330
331 </div>
332
333</div>
334
335<div id="linkbar">
336 <!-- <span id="linkbar-west">&nbsp;</span> -->
337 <span id="linkbar-center">
338 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
339 <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
340 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
341 </span>
342 <span id="linkbar-east">&nbsp;</span>
343 </div>
344 <div class="footer">
345 <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
346 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
347 </div>
348 <div style="clear: both; margin: 0; width: 100%; "></div>
349</body>
350</html>