Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / b2a2ad039073f47228f55eecd6d2dd49202305b7 / . / www / api / stream.html
blob: 27f508cbf82b42f0ae9c5bf7f65ce3908e38faf2 [file] [log] [blame]
cristy91469932014-07-25 11:00:25 +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 version="-//W3C//DTD XHTML 1.1//EN"
4 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:schemaLocation="http://www.w3.org/1999/xhtml
7 http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]8<head>
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]9 <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
10 <meta name=viewport content="width=device-width, initial-scale=0.3333334">
11 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4"/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]12 <title>ImageMagick: MagickCore, C API for ImageMagick: The Pixel FIFO</title>
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]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="application-name" content="ImageMagick"/>
17 <meta name="description" content="A collection of tools and libraries to read, write, and manipulate an image in any of the more popular image formats."/>
18 <meta name="application-url" content="http://www.imagemagick.org"/>
19 <meta name="generator" content="PHP"/>
20 <meta name="keywords" content="magickcore, c, api, for, imagemagick:, the, pixel, fifo, convert, edit, compose, image, pixel"/>
21 <meta name="rating" content="GENERAL"/>
22 <meta name="robots" content="INDEX, FOLLOW"/>
23 <meta name="generator" content="ImageMagick Studio LLC"/>
24 <meta name="author" content="ImageMagick Studio LLC"/>
25 <meta name="revisit-after" content="2 DAYS"/>
26 <meta name="resource-type" content="document"/>
27 <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"/>
28 <meta name="distribution" content="Global"/>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]29 <link rel="icon" href="../../../../images/wand.png"/>
30 <link rel="shortcut icon" href="../../../../images/wand.ico" type="images/x-icon"/>
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]31 <link rel="canonical" href="http://www.imagemagick.org" />
32 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]33
34 <!-- Add jQuery library -->
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]35 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/2.1.0/jquery.min.js"></script>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]36
37 <!-- Add mousewheel plugin (this is optional) -->
38 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/lib/jquery.mousewheel-3.0.6.pack.js"></script>
39
40 <!-- Add fancyBox -->
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]41 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/jquery.fancybox.css?v=2.1.5" type="text/css" media="screen" />
42 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/jquery.fancybox.pack.js?v=2.1.5"></script>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]43
44 <!-- Optionally add helpers - button, thumbnail and/or media -->
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]45 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.css?v=1.0.5" type="text/css" media="screen" />
46 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.js?v=1.0.5"></script>
47 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-media.js?v=1.0.6"></script>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]48
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]49 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.css?v=1.0.7" type="text/css" media="screen" />
50 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.js?v=1.0.7"></script>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]51
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]52 <script type="text/javascript">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]53 $(document).ready(function() {
54 $(".fancybox").fancybox();
55 });
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]56 </script>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]57
58 <!-- ImageMagick style -->
59 <style type="text/css" media="all">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]60 @import url("../../../../www/magick.css");
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]61 </style>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]62</head>
63
64<body id="www-imagemagick-org">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]65
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]66<script type="text/javascript">
67 (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
68 (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
69 m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
70 })(window,document,'offline-script','//www.google-analytics.com/analytics.js','ga');
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]71
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]72 ga('create', 'UA-40133312-1', 'imagemagick.org');
73 ga('send', 'pageview');
74</script>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]75
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]76<div class="titlebar">
77<div style="margin: 17px auto; float: left;">
78 <script type="text/javascript">
79 <!--
80 google_ad_client = "pub-3129977114552745";
81 google_ad_slot = "5439289906";
82 google_ad_width = 728;
83 google_ad_height = 90;
84 //-->
85 </script>
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]86 <script type="text/javascript"
87 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
88 </script>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]89</div>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]90<a href="../../../../discourse-server">
91 <img src="../../../../images/logo.jpg"
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]92 alt="ImageMagick Logo" width="123" height="118"
93 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristyf1b8a092014-02-20 15:46:11 +0000[diff] [blame]94<a href="http://www.imagemagick.org/ImageMagick-7.0.0/index.html">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]95 <img src="../../../../images/sprite.jpg"
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]96 alt="ImageMagick Sprite" width="114" height="118"
97 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]98</div>
99
100<div class="westbar">
101
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]102<div class="menu">
cristyf1b8a092014-02-20 15:46:11 +0000[diff] [blame]103 <a title="About ImageMagick" href="http://www.imagemagick.org/ImageMagick-7.0.0/index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]104</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]105<div class="menu">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]106 <a title="Binary Releases" href="../../../../www/binary-releases.html">Binary Releases</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]107</div>
108<div class="sub">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]109 <a title="Binary Release: Unix" href="../../../../www/binary-releases.html#unix">Unix</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]110</div>
111<div class="sub">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]112 <a title="Binary Release: MacOS X" href="../../../../www/binary-releases.html#macosx">Mac OS X</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]113</div>
114<div class="sub">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]115 <a title="Binary Release: iOS" href="../../../../www/binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +0000[diff] [blame]116</div>
117<div class="sub">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]118 <a title="Binary Release: Windows" href="../../../../www/binary-releases.html#windows">Windows</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]119</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]120<div class="sep"></div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]121<div class="menu">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]122 <a title="Command-line Tools" href="../../../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]123</div>
124<div class="sub">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]125 <a title="Command-line Tools: Processing" href="../../../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]126</div>
127<div class="sub">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]128 <a title="Command-line Tools: Options" href="../../../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]129</div>
130<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]131 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]132</div>
133<div class="menu">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]134 <a title="Program Interfaces" href="../../../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]135</div>
136<div class="sub">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]137 <a title="Program Interface: MagickWand" href="../../../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]138</div>
139<div class="sub">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]140 <a title="Program Interface: MagickCore" href="../../../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]141</div>
142<div class="sub">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]143 <a title="Program Interface: PerlMagick" href="../../../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]144</div>
145<div class="sub">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]146 <a title="Program Interface: Magick++" href="../../../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]147</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]148<div class="sep"></div>
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]149<div class="menu">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]150 <a title="Install from Source" href="../../../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]151</div>
152<div class="sub">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]153 <a title="Install from Source: Unix" href="../../../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]154</div>
155<div class="sub">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]156 <a title="Install from Source: Windows" href="../../../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]157 </div>
158<div class="menu">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]159 <a title="Resources" href="../../../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]160</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]161<div class="menu">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]162 <a title="Architecture" href="../../../../www/architecture.html">Architecture</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]163</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]164<div class="menu">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]165 <a title="Download" href="../../../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]166</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]167<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]168<div class="menu">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]169 <a title="Search" href="http://www.imagemagick.org/http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]170</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]171<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]172<div class="menu">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]173 <a title="Site Map" href="../../../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]174</div>
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]175<div class="sub">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]176 <a title="Site Map: Links" href="../../../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]177</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]178<div class="sep"></div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]179</div>
180
181<div class="eastbar">
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]182 <script type="text/javascript">
183 /* <![CDATA[ */
184 window.___gcfg = {
185 lang: 'en-US'
186 };
187
188 (function() {
189 var po = document.createElement('offline-script');
190 po.type = 'text/javascript';
191 po.async = true;
192 po.src = 'https://apis.google.com/js/plusone.js';
193 var script = document.getElementsByTagName('offline-script')[0];
194 script.parentNode.insertBefore(po, script);
195 })();
196 var gplusone = document.getElementById("gplusone");
197 gplusone.setAttribute("data-size","medium");
198 gplusone.setAttribute("data-count","true");
199 /* ]]> */
200 </script>
201 <script type="text/javascript">
202 /* <![CDATA[ */
203 (function() {
204 var po = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0];
205 po.type = 'text/javascript';
206 po.async = true;
207 po.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
208 var script = document.getElementsByTagName('offline-script')[0];
209 script.parentNode.insertBefore(po, script);
210 })();
211 /* ]]> */
212 </script>
cristyf1b8a092014-02-20 15:46:11 +0000[diff] [blame]213 <div> <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="http://www.imagemagick.org/"></a></div>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]214 <noscript>
215 <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]216 <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" width="93" height="20" border="0" /></a>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]217 </noscript>
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]218 <div class="g-plusone" data-size="standard" data-count="true"></div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]219</div>
220
221<div class="main">
222
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]223<h1>Module stream Methods</h1>
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]224<p class="navigation-index">[<a href="stream.html#ReadStream">ReadStream</a> &#8226; <a href="stream.html#WriteStream">WriteStream</a>]</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]225
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]226<h2><a href="http://www.imagemagick.org/api/MagickCore/stream_8c.html" id="ReadStream">ReadStream</a></h2>
227<div class="doc-section">
228
229<p>ReadStream() makes the image pixels available to a user supplied callback method immediately upon reading a scanline with the ReadImage() method.</p>
230
231<p>The format of the ReadStream() method is:</p>
232
233<pre class="code">
234 Image *ReadStream(const ImageInfo *image_info,StreamHandler stream,
235 ExceptionInfo *exception)
236</pre>
237
238<p>A description of each parameter follows:</p>
239
240<h5>image_info</h5>
241<p>the image info.</p>
242
243<h5>stream</h5>
244<p>a callback method.</p>
245
246<h5>exception</h5>
247<p>return any errors or warnings in this structure.</p>
248
249 </div>
250<h2><a href="http://www.imagemagick.org/api/MagickCore/stream_8c.html" id="WriteStream">WriteStream</a></h2>
251<div class="doc-section">
252
253<p>WriteStream() makes the image pixels available to a user supplied callback method immediately upon writing pixel data with the WriteImage() method.</p>
254
255<p>The format of the WriteStream() method is:</p>
256
257<pre class="code">
258 MagickBooleanType WriteStream(const ImageInfo *image_info,Image *,
259 StreamHandler stream)
260</pre>
261
262<p>A description of each parameter follows:</p>
263
264<h5>image_info</h5>
265<p>the image info.</p>
266
267<h5>stream</h5>
268<p>A callback method.</p>
269
270 </div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]271
272</div>
273
274<div id="linkbar">
cristyac1b4322013-07-28 13:58:06 +0000[diff] [blame]275 <span id="linkbar-west"> </span>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]276
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]277 <span id="linkbar-center">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]278 <a href="../../../../discourse-server">Discourse Server</a> •
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]279 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]280 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a> •
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]281 <a href="http://jqmagick.imagemagick.org/">JqMagick</a>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]282 </span>
cristyac1b4322013-07-28 13:58:06 +0000[diff] [blame]283 <span id="linkbar-east"> </span>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]284</div>
285<div class="footer">
cristy37b3d442015-02-28 14:00:30 +0000[diff] [blame]286 <span id="footer-west">© 1999-2014 ImageMagick Studio LLC</span>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]287 <span id="footer-east"> <a href="../../../../www/contact.html">Contact the Wizards</a></span>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]288</div>
289<div style="clear: both; margin: 0; width: 100%; "></div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]290</body>
291</html>