Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / ea2793ef7733b63d12c11557fd09df2f1062d61f / . / www / api / stream.html
blob: 2fa45c5356a1d6ca67c1ad0843c2b35c73140195 [file] [log] [blame]
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1<!DOCTYPE html>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]2<html lang="en">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]3<head>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]4 <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 +0000[diff] [blame]7 <title>ImageMagick: MagickCore, C API for ImageMagick: The Pixel FIFO</title>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]8 <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">
cristy4e638cd2015-05-07 16:47:40 +0000[diff] [blame]22 <meta name="copyright" content="Copyright (c) 1999-2015 ImageMagick Studio LLC">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]23 <meta name="distribution" content="Global">
24 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1">
cristy2f563d42015-05-06 23:36:51 +0000[diff] [blame]25 <link rel="icon" href="../images/wand.png">
26 <link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon">
27 <link rel="stylesheet" href="../css/bootstrap.min.css">
28 <link rel="stylesheet" href="../css/magick.css">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]29</head>
30
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]31<body>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]32<div class="main">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]33<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">
cristy2f563d42015-05-06 23:36:51 +0000[diff] [blame]46 <a class="magick-nav-item " href="../index.html">Home</a>
cristyea2793e2015-05-31 16:52:26 +0000[diff] [blame^]47 <a class="magick-nav-item " href="../binary-releases.html">Download</a>
cristy38185362015-05-07 20:09:56 +0000[diff] [blame]48 <a class="magick-nav-item " href="../command-line-tools.html">Tools</a>
49 <a class="magick-nav-item " href="../command-line-options.html">Options</a>
cristyea2793e2015-05-31 16:52:26 +0000[diff] [blame^]50 <a class="magick-nav-item " href="../resources.html">Resources</a>
51 <a class="magick-nav-item " href="api.html">Develop</a>
cristya1890f02015-05-15 23:32:44 +0000[diff] [blame]52 <a class="magick-nav-item " href="http://www.imagemagick.org/script/search.php">Search</a>
53 <a class="magick-nav-item pull-right" href="http://www.imagemagick.org/discourse-server/">Community</a>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]54 </nav>
55 </div>
56</div>
57<div class="container">
cristy4e638cd2015-05-07 16:47:40 +0000[diff] [blame]58<div class="magick-header">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]59<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 +0000[diff] [blame]60
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]61<h2><a href="http://www.imagemagick.org/api/MagickCore/stream_8c.html" id="ReadStream">ReadStream</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]62
63<p>ReadStream() makes the image pixels available to a user supplied callback method immediately upon reading a scanline with the ReadImage() method.</p>
64
65<p>The format of the ReadStream() method is:</p>
66
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]67<pre class="text">
68Image *ReadStream(const ImageInfo *image_info,StreamHandler stream,
69 ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]70</pre>
71
72<p>A description of each parameter follows:</p>
73
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]74<dd>
75</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]76
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]77<dd> </dd>
78<dl class="dl-horizontal">
79<dt>image_info</dt>
80<dd>the image info. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]81
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]82<dd> </dd>
83<dt>stream</dt>
84<dd>a callback method. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]85
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]86<dd> </dd>
87<dt>exception</dt>
88<dd>return any errors or warnings in this structure. </dd>
89
90<dd> </dd>
91</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]92<h2><a href="http://www.imagemagick.org/api/MagickCore/stream_8c.html" id="WriteStream">WriteStream</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]93
94<p>WriteStream() makes the image pixels available to a user supplied callback method immediately upon writing pixel data with the WriteImage() method.</p>
95
96<p>The format of the WriteStream() method is:</p>
97
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]98<pre class="text">
99MagickBooleanType WriteStream(const ImageInfo *image_info,Image *,
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]100 StreamHandler stream)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]101</pre>
102
103<p>A description of each parameter follows:</p>
104
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]105<dd>
106</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]107
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]108<dd> </dd>
109<dl class="dl-horizontal">
110<dt>image_info</dt>
111<dd>the image info. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]112
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]113<dd> </dd>
114<dt>stream</dt>
115<dd>A callback method. </dd>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]116
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]117<dd> </dd>
118</dl>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]119</div>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]120 <footer class="magick-footer">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]121 <div class="magick-nav-item pull-left">
cristy38185362015-05-07 20:09:56 +0000[diff] [blame]122 <a href="../support.html">Donate</a>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]123 </div>
cristy38185362015-05-07 20:09:56 +0000[diff] [blame]124 <p><a href="../sitemap.html">Sitemap</a> •
125 <a href="../links.html">Related</a> •
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]126 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Image Studio</a> •
cristyea2793e2015-05-31 16:52:26 +0000[diff] [blame^]127 <a href="http://jqmagick.imagemagick.org/">JqMagick</a>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]128</p>
129 <p><a href="stream.html#">Back to top</a> •
cristyea2793e2015-05-31 16:52:26 +0000[diff] [blame^]130 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
cristyabed55c2015-05-06 17:07:00 +0000[diff] [blame]131 <a href="http://www.imagemagick.org/script/contact.php">Contact Us</a></p>
cristya1890f02015-05-15 23:32:44 +0000[diff] [blame]132 <p><small>© 1999-2015 ImageMagick Studio LLC</small></p>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]133 </footer>
134</div><!-- /.container -->
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]135
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]136 <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
cristy2f563d42015-05-06 23:36:51 +0000[diff] [blame]137 <script src="../js/bootstrap.min.js"></script>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]138 <script type="text/javascript">
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]139 /* <![CDATA[ */
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]140 (function() {
141 var s = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0];
142 s.type = 'text/javascript';
143 s.async = true;
144 s.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
145 t.parentNode.insertBefore(s, t);
146 })();
cristy82a2ff22015-05-12 16:41:32 +0000[diff] [blame]147 /* ]]> */
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]148 </script>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]149</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]150</body>
cristy5a367e42015-05-05 12:39:18 +0000[diff] [blame]151</html>