blob: 4d499d6f78f13b20b6cce9e7991d1cd51e5d7188 [file] [log] [blame]
cristy44443b92015-05-05 00:06:07 +00001<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2<html lang="en">
cristy06f63f22012-10-31 00:50:07 +00003<head>
cristy44443b92015-05-05 00:06:07 +00004 <meta charset="utf-8">
5 <meta http-equiv="X-UA-Compatible" content="IE=edge">
6 <meta name="viewport" content="width=device-width, initial-scale=1">
cristyffb69ed2010-12-25 00:06:48 +00007 <title>ImageMagick: MagickCore, C API for ImageMagick: The Pixel FIFO</title>
cristy44443b92015-05-05 00:06:07 +00008 <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">
11 <meta name="application-name" content="ImageMagick">
12 <meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.">
13 <meta name="application-url" content="http://www.imagemagick.org">
14 <meta name="generator" content="PHP">
15 <meta name="keywords" content="magickcore, c, api, for, imagemagick:, the, pixel, fifo, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert">
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">
22 <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC">
23 <meta name="distribution" content="Global">
24 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1">
25 <link rel="icon" href="../../images/wand.png">
26 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon">
cristy85893d32015-05-06 13:44:09 +000027 <link rel="stylesheet" href="../../css/bootstrap.min.css">
28 <link rel="stylesheet" href="../../css/magick.css">
cristy06f63f22012-10-31 00:50:07 +000029</head>
30
cristy44443b92015-05-05 00:06:07 +000031<body>
cristy06f63f22012-10-31 00:50:07 +000032<div class="main">
cristy44443b92015-05-05 00:06:07 +000033<div class="magick-masthead">
34 <div class="container">
35 <script type="text/javascript">
36 <!--
37 google_ad_client = "pub-3129977114552745";
38 google_ad_slot = "5439289906";
39 google_ad_width = 728;
40 google_ad_height = 90;
41 //-->
42 </script>
43 <center><script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
44 </script></center>
45 <nav class="magick-nav">
46 <a class="magick-nav-item " href="../../index.html">Home</a>
47 <a class="magick-nav-item " href="../../www/binary-releases.html">Downloads</a>
48 <a class="magick-nav-item " href="../../www/command-line-tools.html">Tools</a>
49 <a class="magick-nav-item " href="../../www/command-line-options.html">Options</a>
50 <a class="magick-nav-item " href="../../www/api.html">Development</a>
51 <a class="magick-nav-item" href="http://www.imagemagick.org/discourse-server/">Community</a>
cristy85893d32015-05-06 13:44:09 +000052 <a class="magick-nav-item navbar-right " href="../../www/search.html">Search</a>
cristy44443b92015-05-05 00:06:07 +000053 </nav>
54 </div>
55</div>
56<div class="container">
57<p class="text-center"><a href="stream.html#ReadStream">ReadStream</a><a href="stream.html#WriteStream">WriteStream</a></p>
cristy06f63f22012-10-31 00:50:07 +000058
cristy44443b92015-05-05 00:06:07 +000059<div class="magick-header">
cristy20398432011-08-11 01:31:50 +000060<h2><a href="http://www.imagemagick.org/api/MagickCore/stream_8c.html" id="ReadStream">ReadStream</a></h2>
cristy20398432011-08-11 01:31:50 +000061
62<p>ReadStream() makes the image pixels available to a user supplied callback method immediately upon reading a scanline with the ReadImage() method.</p>
63
64<p>The format of the ReadStream() method is:</p>
65
cristy44443b92015-05-05 00:06:07 +000066<pre class="text">
67Image *ReadStream(const ImageInfo *image_info,StreamHandler stream,
68 ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +000069</pre>
70
71<p>A description of each parameter follows:</p>
72
cristy44443b92015-05-05 00:06:07 +000073<dd>
74</dd>
cristy20398432011-08-11 01:31:50 +000075
cristy44443b92015-05-05 00:06:07 +000076<dd> </dd>
77<dl class="dl-horizontal">
78<dt>image_info</dt>
79<dd>the image info. </dd>
cristy20398432011-08-11 01:31:50 +000080
cristy44443b92015-05-05 00:06:07 +000081<dd> </dd>
82<dt>stream</dt>
83<dd>a callback method. </dd>
cristy20398432011-08-11 01:31:50 +000084
cristy44443b92015-05-05 00:06:07 +000085<dd> </dd>
86<dt>exception</dt>
87<dd>return any errors or warnings in this structure. </dd>
88
89<dd> </dd>
90</dl>
cristy20398432011-08-11 01:31:50 +000091<h2><a href="http://www.imagemagick.org/api/MagickCore/stream_8c.html" id="WriteStream">WriteStream</a></h2>
cristy20398432011-08-11 01:31:50 +000092
93<p>WriteStream() makes the image pixels available to a user supplied callback method immediately upon writing pixel data with the WriteImage() method.</p>
94
95<p>The format of the WriteStream() method is:</p>
96
cristy44443b92015-05-05 00:06:07 +000097<pre class="text">
98MagickBooleanType WriteStream(const ImageInfo *image_info,Image *,
99 StreamHandler stream,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000100</pre>
101
102<p>A description of each parameter follows:</p>
103
cristy44443b92015-05-05 00:06:07 +0000104<dd>
105</dd>
cristy20398432011-08-11 01:31:50 +0000106
cristy44443b92015-05-05 00:06:07 +0000107<dd> </dd>
108<dl class="dl-horizontal">
109<dt>image_info</dt>
110<dd>the image info. </dd>
cristy20398432011-08-11 01:31:50 +0000111
cristy44443b92015-05-05 00:06:07 +0000112<dd> </dd>
113<dt>stream</dt>
114<dd>A callback method. </dd>
cristy06f63f22012-10-31 00:50:07 +0000115
cristy44443b92015-05-05 00:06:07 +0000116<dd> </dd>
117<dt>exception</dt>
118<dd>return any errors or warnings in this structure. </dd>
119
120<dd> </dd>
121</dl>
cristy06f63f22012-10-31 00:50:07 +0000122</div>
cristy44443b92015-05-05 00:06:07 +0000123 <footer class="magick-footer">
124 <div class="magick-nav-item navbar-left">
cristy85893d32015-05-06 13:44:09 +0000125 <a href="../../www/support.html">Donate</a>
cristy44443b92015-05-05 00:06:07 +0000126 </div>
127 <div class="magick-nav-item navbar-right">
128 <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="../../index.html"></a>
129 <noscript>
130 <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
131 <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0"></a>
132 </noscript>
133 </div>
134 <p><a href="../../www/sitemap.html">Sitemap</a>
135 <a href="../../www/links.html">Related</a>
136 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Image Studio</a>
137 <a href="http://jqmagick.imagemagick.org/">JqMagick</a>
138 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a>
139</p>
140 <p><a href="stream.html#">Back to top</a>
cristy85893d32015-05-06 13:44:09 +0000141 <a href="../../www/http://www.imagemagick.org/script/contact.php">Contact Us</a></p>
cristy44443b92015-05-05 00:06:07 +0000142 </footer>
143</div><!-- /.container -->
cristy06f63f22012-10-31 00:50:07 +0000144
cristy44443b92015-05-05 00:06:07 +0000145 <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
146 <script src="../../js/bootstrap.min.js"></script>
147 <script type="text/javascript">
148 /* */
149 (function() {
150 var s = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0];
151 s.type = 'text/javascript';
152 s.async = true;
153 s.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
154 t.parentNode.insertBefore(s, t);
155 })();
156 /* */
157 </script>
cristy44cbd482013-08-04 20:53:36 +0000158</div>
cristy06f63f22012-10-31 00:50:07 +0000159</body>
cristy5a367e42015-05-05 12:39:18 +0000160</html>