<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <link rel="stylesheet" href="style.css" type="text/css"> <meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type"> <link rel="Start" href="index.html"> <link rel="next" href="Lwt_term.Draw.html"> <link rel="Up" href="Lwt_term.html"> <link title="Index of types" rel=Appendix href="index_types.html"> <link title="Index of exceptions" rel=Appendix href="index_exceptions.html"> <link title="Index of values" rel=Appendix href="index_values.html"> <link title="Index of class attributes" rel=Appendix href="index_attributes.html"> <link title="Index of class methods" rel=Appendix href="index_methods.html"> <link title="Index of classes" rel=Appendix href="index_classes.html"> <link title="Index of class types" rel=Appendix href="index_class_types.html"> <link title="Index of modules" rel=Appendix href="index_modules.html"> <link title="Index of module types" rel=Appendix href="index_module_types.html"> <link title="Lwt_condition" rel="Chapter" href="Lwt_condition.html"> <link title="Lwt_list" rel="Chapter" href="Lwt_list.html"> <link title="Lwt" rel="Chapter" href="Lwt.html"> <link title="Lwt_mutex" rel="Chapter" href="Lwt_mutex.html"> <link title="Lwt_mvar" rel="Chapter" href="Lwt_mvar.html"> <link title="Lwt_pool" rel="Chapter" href="Lwt_pool.html"> <link title="Lwt_sequence" rel="Chapter" href="Lwt_sequence.html"> <link title="Lwt_stream" rel="Chapter" href="Lwt_stream.html"> <link title="Lwt_switch" rel="Chapter" href="Lwt_switch.html"> <link title="Lwt_util" rel="Chapter" href="Lwt_util.html"> <link title="Lwt_pqueue" rel="Chapter" href="Lwt_pqueue.html"> <link title="Lwt_lib" rel="Chapter" href="Lwt_lib.html"> <link title="Lwt_glib" rel="Chapter" href="Lwt_glib.html"> <link title="Lwt_preemptive" rel="Chapter" href="Lwt_preemptive.html"> <link title="Lwt_event" rel="Chapter" href="Lwt_event.html"> <link title="Lwt_signal" rel="Chapter" href="Lwt_signal.html"> <link title="Lwt_react" rel="Chapter" href="Lwt_react.html"> <link title="Lwt_ssl" rel="Chapter" href="Lwt_ssl.html"> <link title="Lwt_text" rel="Chapter" href="Lwt_text.html"> <link title="Lwt_term" rel="Chapter" href="Lwt_term.html"> <link title="Lwt_read_line" rel="Chapter" href="Lwt_read_line.html"> <link title="Lwt_top" rel="Chapter" href="Lwt_top.html"> <link title="Lwt_chan" rel="Chapter" href="Lwt_chan.html"> <link title="Lwt_daemon" rel="Chapter" href="Lwt_daemon.html"> <link title="Lwt_gc" rel="Chapter" href="Lwt_gc.html"> <link title="Lwt_io" rel="Chapter" href="Lwt_io.html"> <link title="Lwt_log" rel="Chapter" href="Lwt_log.html"> <link title="Lwt_main" rel="Chapter" href="Lwt_main.html"> <link title="Lwt_process" rel="Chapter" href="Lwt_process.html"> <link title="Lwt_throttle" rel="Chapter" href="Lwt_throttle.html"> <link title="Lwt_timeout" rel="Chapter" href="Lwt_timeout.html"> <link title="Lwt_unix" rel="Chapter" href="Lwt_unix.html"> <link title="Lwt_sys" rel="Chapter" href="Lwt_sys.html"> <link title="Lwt_engine" rel="Chapter" href="Lwt_engine.html"> <link title="Lwt_bytes" rel="Chapter" href="Lwt_bytes.html"> <link title="Pa_lwt" rel="Chapter" href="Pa_lwt.html"> <link title="Pa_lwt_log" rel="Chapter" href="Pa_lwt_log.html"><title>Lwt_term.Zone</title> </head> <body> <div class="navbar"> <a class="up" href="Lwt_term.html" title="Lwt_term">Up</a> <a class="post" href="Lwt_term.Draw.html" title="Lwt_term.Draw">Next</a> </div> <h1>Module <a href="type_Lwt_term.Zone.html">Lwt_term.Zone</a></h1> <pre><span class="keyword">module</span> Zone: <code class="code"><span class="keyword">sig</span></code> <a href="Lwt_term.Zone.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info"> Off-screen zones<br> </div> <hr width="100%"> <pre><code><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> = {</code></pre><table class="typetable"> <tr> <td align="left" valign="top" > <code> </code></td> <td align="left" valign="top" > <code><span id="TYPEELTt.points">points</span> :<code class="type"><a href="Lwt_term.html#TYPEpoint">Lwt_term.point</a> array array</code>;</code></td> <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >The off-screen matrix</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td> </tr> <tr> <td align="left" valign="top" > <code> </code></td> <td align="left" valign="top" > <code><span id="TYPEELTt.x">x</span> :<code class="type">int</code>;</code></td> </tr> <tr> <td align="left" valign="top" > <code> </code></td> <td align="left" valign="top" > <code><span id="TYPEELTt.y">y</span> :<code class="type">int</code>;</code></td> <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Absolute coordinates of the top-left corner of the zone</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td> </tr> <tr> <td align="left" valign="top" > <code> </code></td> <td align="left" valign="top" > <code><span id="TYPEELTt.width">width</span> :<code class="type">int</code>;</code></td> </tr> <tr> <td align="left" valign="top" > <code> </code></td> <td align="left" valign="top" > <code><span id="TYPEELTt.height">height</span> :<code class="type">int</code>;</code></td> <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Dimmensions of the zone</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td> </tr></table> } <pre><span id="VALpoints"><span class="keyword">val</span> points</span> : <code class="type"><a href="Lwt_term.Zone.html#TYPEt">t</a> -> <a href="Lwt_term.html#TYPEpoint">Lwt_term.point</a> array array</code></pre><pre><span id="VALx"><span class="keyword">val</span> x</span> : <code class="type"><a href="Lwt_term.Zone.html#TYPEt">t</a> -> int</code></pre><pre><span id="VALy"><span class="keyword">val</span> y</span> : <code class="type"><a href="Lwt_term.Zone.html#TYPEt">t</a> -> int</code></pre><pre><span id="VALwidth"><span class="keyword">val</span> width</span> : <code class="type"><a href="Lwt_term.Zone.html#TYPEt">t</a> -> int</code></pre><pre><span id="VALheight"><span class="keyword">val</span> height</span> : <code class="type"><a href="Lwt_term.Zone.html#TYPEt">t</a> -> int</code></pre><pre><span id="VALmake"><span class="keyword">val</span> make</span> : <code class="type">width:int -> height:int -> <a href="Lwt_term.Zone.html#TYPEt">t</a></code></pre><div class="info"> Make a new zone where all points are initialized to <a href="Lwt_term.html#VALblank"><code class="code"><span class="constructor">Lwt_term</span>.blank</code></a><br> </div> <pre><span id="VALsub"><span class="keyword">val</span> sub</span> : <code class="type">zone:<a href="Lwt_term.Zone.html#TYPEt">t</a> -><br> x:int -> y:int -> width:int -> height:int -> <a href="Lwt_term.Zone.html#TYPEt">t</a></code></pre><div class="info"> <code class="code">sub ~zone ~x ~y ~width ~height</code> creates a sub-zone of <code class="code">zone</code>. <code class="code">x</code> and <code class="code">y</code> are relatives to the zone top left corner.<br> <b>Raises</b> <code>Invalid_argument</code> if the sub zone is not included in <code class="code">zone</code><br> </div> <pre><span id="VALinner"><span class="keyword">val</span> inner</span> : <code class="type"><a href="Lwt_term.Zone.html#TYPEt">t</a> -> <a href="Lwt_term.Zone.html#TYPEt">t</a></code></pre><div class="info"> <code class="code">inner zone</code> returns the inner part of <code class="code">zone</code><br> </div> </body></html>