<!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="previous" href="Genimage.CONTAINER.html">
<link rel="next" href="Genimage.CONTAINER_INDEXED.html">
<link rel="Up" href="Genimage.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 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="Bitmap" rel="Chapter" href="Bitmap.html">
<link title="Blend" rel="Chapter" href="Blend.html">
<link title="Bmp" rel="Chapter" href="Bmp.html">
<link title="Cmyk32" rel="Chapter" href="Cmyk32.html">
<link title="Color" rel="Chapter" href="Color.html">
<link title="Freetype" rel="Chapter" href="Freetype.html">
<link title="Ftlow" rel="Chapter" href="Ftlow.html">
<link title="Fttext" rel="Chapter" href="Fttext.html">
<link title="Genimage" rel="Chapter" href="Genimage.html">
<link title="Gif" rel="Chapter" href="Gif.html">
<link title="Graphic_image" rel="Chapter" href="Graphic_image.html">
<link title="Images" rel="Chapter" href="Images.html">
<link title="Index16" rel="Chapter" href="Index16.html">
<link title="Index8" rel="Chapter" href="Index8.html">
<link title="Info" rel="Chapter" href="Info.html">
<link title="Jis_unicode" rel="Chapter" href="Jis_unicode.html">
<link title="Jpeg" rel="Chapter" href="Jpeg.html">
<link title="Mstring" rel="Chapter" href="Mstring.html">
<link title="OColor" rel="Chapter" href="OColor.html">
<link title="OImage" rel="Chapter" href="OImage.html">
<link title="OImages" rel="Chapter" href="OImages.html">
<link title="OXimage2" rel="Chapter" href="OXimage2.html">
<link title="OXvthumb" rel="Chapter" href="OXvthumb.html">
<link title="Png" rel="Chapter" href="Png.html">
<link title="Ppm" rel="Chapter" href="Ppm.html">
<link title="Ps" rel="Chapter" href="Ps.html">
<link title="Reduce" rel="Chapter" href="Reduce.html">
<link title="Region" rel="Chapter" href="Region.html">
<link title="Rgb24" rel="Chapter" href="Rgb24.html">
<link title="Rgba32" rel="Chapter" href="Rgba32.html">
<link title="Tmpfile" rel="Chapter" href="Tmpfile.html">
<link title="Ximage2" rel="Chapter" href="Ximage2.html">
<link title="Xpm" rel="Chapter" href="Xpm.html">
<link title="Xvthumb" rel="Chapter" href="Xvthumb.html"><title>Genimage.IMAGE</title>
</head>
<body>
<div class="navbar"><a href="Genimage.CONTAINER.html">Previous</a>
<a href="Genimage.html">Up</a>
<a href="Genimage.CONTAINER_INDEXED.html">Next</a>
</div>
<center><h1>Module type <a href="type_Genimage.IMAGE.html">Genimage.IMAGE</a></h1></center>
<br>
<pre><span class="keyword">module type</span> IMAGE = <code class="code">sig</code> <a href="Genimage.IMAGE.html">..</a> <code class="code">end</code></pre><hr width="100%">
<pre><span class="keyword">type</span> <a name="TYPEt"></a><code class="type"></code>t </pre>
<pre><span class="keyword">type</span> <a name="TYPEelt"></a><code class="type"></code>elt </pre>
<br>
Image creation<br>
<pre><span class="keyword">val</span> <a name="VALcreate"></a>create : <code class="type">int -> int -> <a href="Genimage.IMAGE.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">create w h</code> creates an image with a size <code class="code">w</code>x<code class="code">h</code>. The content is
the image is not initialized.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALmake"></a>make : <code class="type">int -> int -> <a href="Genimage.IMAGE.html#TYPEelt">elt</a> -> <a href="Genimage.IMAGE.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">make w h c</code> creates an image with a size <code class="code">w</code>x<code class="code">h</code>. The content is
the image is initialized to the color <code class="code">c</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALdestroy"></a>destroy : <code class="type"><a href="Genimage.IMAGE.html#TYPEt">t</a> -> unit</code></pre><div class="info">
<code class="code">destroy t</code> explicitly frees the image content of <code class="code">t</code>.
If you do not use bitmap swap files, you do not need to call
this function, since GC will free unreachable image data automatically.
Read bitmap.mli for more details.<br>
</div>
<br>
Pixel access<br>
<pre><span class="keyword">val</span> <a name="VALget"></a>get : <code class="type"><a href="Genimage.IMAGE.html#TYPEt">t</a> -> int -> int -> <a href="Genimage.IMAGE.html#TYPEelt">elt</a></code></pre><div class="info">
<code class="code">get t x y</code> gets image pixel of <code class="code">t</code> at <code class="code">x</code>,<code class="code">y</code>. If <code class="code">x</code>,<code class="code">y</code> is
outside of the image size, Images.Out_of_image exception is raised.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALset"></a>set : <code class="type"><a href="Genimage.IMAGE.html#TYPEt">t</a> -> int -> int -> <a href="Genimage.IMAGE.html#TYPEelt">elt</a> -> unit</code></pre><div class="info">
<code class="code">set t x y c</code> sets image pixel of <code class="code">t</code> at <code class="code">x</code>,<code class="code">y</code> by the color <code class="code">c</code>.
If <code class="code">x</code>,<code class="code">y</code> is outside of the image size, Images.Out_of_image exception
is raised.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALunsafe_get"></a>unsafe_get : <code class="type"><a href="Genimage.IMAGE.html#TYPEt">t</a> -> int -> int -> <a href="Genimage.IMAGE.html#TYPEelt">elt</a></code></pre><pre><span class="keyword">val</span> <a name="VALunsafe_set"></a>unsafe_set : <code class="type"><a href="Genimage.IMAGE.html#TYPEt">t</a> -> int -> int -> <a href="Genimage.IMAGE.html#TYPEelt">elt</a> -> unit</code></pre><div class="info">
Unsafe versions of <code class="code">get</code> and <code class="code">set</code>. It does not perform any image
boundary check. If the coordinates are out of the given image,
the result is undefined. Use carefully.<br>
</div>
<br>
Image copy<br>
<pre><span class="keyword">val</span> <a name="VALcopy"></a>copy : <code class="type"><a href="Genimage.IMAGE.html#TYPEt">t</a> -> <a href="Genimage.IMAGE.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">copy t</code> duplicates the image <code class="code">t</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsub"></a>sub : <code class="type"><a href="Genimage.IMAGE.html#TYPEt">t</a> -> int -> int -> int -> int -> <a href="Genimage.IMAGE.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">sub t x y w h</code> duplicates a subimage of <code class="code">t</code> of size <code class="code">w</code>x<code class="code">h</code>,
whose origin (0,0) is at (x,y) of <code class="code">t</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALblit"></a>blit : <code class="type"><a href="Genimage.IMAGE.html#TYPEt">t</a> -><br> int -> int -> <a href="Genimage.IMAGE.html#TYPEt">t</a> -> int -> int -> int -> int -> unit</code></pre><div class="info">
<code class="code">blit src x y dst x' y' w h</code> copies rectangular area of <code class="code">src</code> at
<code class="code">x</code>,<code class="code">y</code> with size <code class="code">w</code>x<code class="code">h</code>, to an image <code class="code">dst</code>. The origin of
the subimage comes at <code class="code">x'</code>,<code class="code">y'</code> of <code class="code">dst</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALmap"></a>map : <code class="type">(<a href="Genimage.IMAGE.html#TYPEelt">elt</a> -> <a href="Genimage.IMAGE.html#TYPEelt">elt</a> -> <a href="Genimage.IMAGE.html#TYPEelt">elt</a>) -><br> <a href="Genimage.IMAGE.html#TYPEt">t</a> -><br> int -> int -> <a href="Genimage.IMAGE.html#TYPEt">t</a> -> int -> int -> int -> int -> unit</code></pre><div class="info">
<code class="code">map f src x y dst x' y' w h</code> maps pixels of the rectangular area
of <code class="code">src</code> at <code class="code">x</code>,<code class="code">y</code> with size <code class="code">w</code>x<code class="code">h</code>, to an image <code class="code">dst</code>,
using color conversion function <code class="code">f</code>. The origin of the subimage
comes at <code class="code">x'</code>,<code class="code">y'</code> of <code class="code">dst</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALdump"></a>dump : <code class="type"><a href="Genimage.IMAGE.html#TYPEt">t</a> -> string</code></pre><div class="info">
functions for internal use<br>
</div>
<pre><span class="keyword">val</span> <a name="VALunsafe_access"></a>unsafe_access : <code class="type"><a href="Genimage.IMAGE.html#TYPEt">t</a> -> int -> int -> string * int</code></pre><pre><span class="keyword">val</span> <a name="VALget_strip"></a>get_strip : <code class="type"><a href="Genimage.IMAGE.html#TYPEt">t</a> -> int -> int -> int -> string</code></pre><pre><span class="keyword">val</span> <a name="VALset_strip"></a>set_strip : <code class="type"><a href="Genimage.IMAGE.html#TYPEt">t</a> -> int -> int -> int -> string -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALget_scanline"></a>get_scanline : <code class="type"><a href="Genimage.IMAGE.html#TYPEt">t</a> -> int -> string</code></pre><pre><span class="keyword">val</span> <a name="VALset_scanline"></a>set_scanline : <code class="type"><a href="Genimage.IMAGE.html#TYPEt">t</a> -> int -> string -> unit</code></pre></body></html>
