<!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="Graphic_image.html">
<link rel="next" href="Index16.html">
<link rel="Up" href="index.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>Images</title>
</head>
<body>
<div class="navbar"><a href="Graphic_image.html">Previous</a>
<a href="index.html">Up</a>
<a href="Index16.html">Next</a>
</div>
<center><h1>Module <a href="type_Images.html">Images</a></h1></center>
<br>
<pre><span class="keyword">module</span> Images: <code class="code">sig</code> <a href="Images.html">..</a> <code class="code">end</code></pre>The image data structure definition.<br>
<hr width="100%">
<pre><span class="keyword">exception</span> <a name="EXCEPTIONOut_of_image"></a>Out_of_image</pre>
<div class="info">
Exception for illegal point access<br>
</div>
<pre><span class="keyword">exception</span> <a name="EXCEPTIONWrong_image_type"></a>Wrong_image_type</pre>
<div class="info">
Exception for illegal internal image type<br>
</div>
<pre><span class="keyword">exception</span> <a name="EXCEPTIONWrong_file_type"></a>Wrong_file_type</pre>
<div class="info">
Exception for unsupported image FILE format<br>
</div>
<br><code><span class="keyword">type</span> <a name="TYPEt"></a><code class="type"></code>t = </code><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">Index8</span> <span class="keyword">of</span> <code class="type"><a href="Index8.html#TYPEt">Index8.t</a></code></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">Rgb24</span> <span class="keyword">of</span> <code class="type"><a href="Rgb24.html#TYPEt">Rgb24.t</a></code></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">Index16</span> <span class="keyword">of</span> <code class="type"><a href="Index16.html#TYPEt">Index16.t</a></code></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">Rgba32</span> <span class="keyword">of</span> <code class="type"><a href="Rgba32.html#TYPEt">Rgba32.t</a></code></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">Cmyk32</span> <span class="keyword">of</span> <code class="type"><a href="Cmyk32.html#TYPEt">Cmyk32.t</a></code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Generic image type</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<br><code><span class="keyword">type</span> <a name="TYPEsequence"></a><code class="type"></code>sequence = {</code><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>seq_width : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>seq_height : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>seq_frames : <code class="type"><a href="Images.html#TYPEframe">frame</a> list</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>seq_loops : <code class="type">int</code>;</code></td>
</tr></table>
}
<br><code><span class="keyword">type</span> <a name="TYPEframe"></a><code class="type"></code>frame = {</code><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>frame_left : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>frame_top : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>frame_image : <code class="type"><a href="Images.html#TYPEt">t</a></code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>frame_delay : <code class="type">int</code>;</code></td>
</tr></table>
}
<pre><span class="keyword">type</span> <a name="TYPErgb"></a><code class="type"></code>rgb = <code class="type"><a href="Color.html#TYPErgb">Color.rgb</a></code> = {</pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>r : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>g : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>b : <code class="type">int</code>;</code></td>
</tr></table>
}
<div class="info">
Colors: the copies of color.mli<br>
</div>
<pre><span class="keyword">type</span> <a name="TYPErgba"></a><code class="type"></code>rgba = <code class="type"><a href="Color.html#TYPErgba">Color.rgba</a></code> = {</pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>color : <code class="type"><a href="Images.html#TYPErgb">rgb</a></code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>alpha : <code class="type">int</code>;</code></td>
</tr></table>
}
<pre><span class="keyword">type</span> <a name="TYPEcmyk"></a><code class="type"></code>cmyk = <code class="type"><a href="Color.html#TYPEcmyk">Color.cmyk</a></code> = {</pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>c : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>m : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>y : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>k : <code class="type">int</code>;</code></td>
</tr></table>
}
<pre><span class="keyword">type</span> <a name="TYPEmap"></a><code class="type">'a</code> map = <code class="type">'a <a href="Color.html#TYPEmap">Color.map</a></code> = {</pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>max : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span class="keyword">mutable </span>map : <code class="type">'a array</code>;</code></td>
</tr></table>
}
<br><code><span class="keyword">type</span> <a name="TYPEformat"></a><code class="type"></code>format = </code><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">Gif</span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">Bmp</span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">Jpeg</span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">Tiff</span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">Png</span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">Xpm</span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">Ppm</span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">Ps</span></code></td>
</tr></table>
<div class="info">
Image formats<br>
</div>
<pre><span class="keyword">val</span> <a name="VALextension"></a>extension : <code class="type"><a href="Images.html#TYPEformat">format</a> -> string</code></pre><div class="info">
Functions for filename extensions
<p>
returns the corresponding extension "gif", "bmp" etc. for given format<br>
</div>
<pre><span class="keyword">val</span> <a name="VALguess_format"></a>guess_format : <code class="type">string -> <a href="Images.html#TYPEformat">format</a></code></pre><div class="info">
returns the image format guessed from the file extension of
a given file name<br>
</div>
<pre><span class="keyword">val</span> <a name="VALget_extension"></a>get_extension : <code class="type">string -> string * string</code></pre><div class="info">
Lower interface<br>
</div>
<pre><span class="keyword">val</span> <a name="VALguess_extension"></a>guess_extension : <code class="type">string -> <a href="Images.html#TYPEformat">format</a></code></pre><pre><span class="keyword">type</span> <a name="TYPEcolormodel"></a><code class="type"></code>colormodel = <code class="type"><a href="Info.html#TYPEcolormodel">Info.colormodel</a></code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">Gray</span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">RGB</span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">Index</span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">GrayA</span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">RGBA</span></code></td>
</tr></table>
<pre><span class="keyword">type</span> <a name="TYPEinfo"></a><code class="type"></code>info = <code class="type"><a href="Info.html#TYPEinfo">Info.info</a></code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">Info_DPI</span> <span class="keyword">of</span> <code class="type">float</code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >dot per inch</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">Info_BigEndian</span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">Info_LittleEndian</span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >endianness of image file</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">Info_ColorModel</span> <span class="keyword">of</span> <code class="type"><a href="Images.html#TYPEcolormodel">colormodel</a></code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >color model of image file</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">Info_Depth</span> <span class="keyword">of</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" >Image bit depth</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">Info_Corrupted</span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >For corrupted PNG files</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
Infos attached to bitmaps<br>
</div>
<pre><span class="keyword">val</span> <a name="VALdpi"></a>dpi : <code class="type"><a href="Images.html#TYPEinfo">info</a> list -> float option</code></pre><div class="info">
Info query<br>
</div>
<br><code><span class="keyword">type</span> <a name="TYPEheader"></a><code class="type"></code>header = {</code><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>header_width : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>header_height : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>header_infos : <code class="type"><a href="Images.html#TYPEinfo">info</a> list</code>;</code></td>
</tr></table>
}
<div class="info">
Image file header<br>
</div>
<pre><span class="keyword">val</span> <a name="VALfile_format"></a>file_format : <code class="type">string -> <a href="Images.html#TYPEformat">format</a> * <a href="Images.html#TYPEheader">header</a></code></pre><div class="info">
<code class="code">file_format filename</code> reads the header of image file <code class="code">filename</code>
and returns its format and some useful information found in the
header (ex. width, height). <code class="code">file_format</code> does not read image
contents, but just quickly returns file header information.
<p>
<code class="code">file_format</code> does not depend on any external libraries<br>
</div>
<br><code><span class="keyword">type</span> <a name="TYPEload_option"></a><code class="type"></code>load_option = </code><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">Load_Progress</span> <span class="keyword">of</span> <code class="type">(float -> unit)</code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >For progress meters</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">Load_Resolution</span> <span class="keyword">of</span> <code class="type">float * float</code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Pixel/Inch for rasterization of PS</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
Load options<br>
</div>
<br><code><span class="keyword">type</span> <a name="TYPEsave_option"></a><code class="type"></code>save_option = </code><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">Save_Quality</span> <span class="keyword">of</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" >Save quality for Jpeg compression</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">Save_Progress</span> <span class="keyword">of</span> <code class="type">(float -> unit)</code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >For progress meters</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span class="constructor">Save_Interlace</span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Interlaced Gif</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
Save options<br>
</div>
<pre><span class="keyword">val</span> <a name="VALload_progress"></a>load_progress : <code class="type"><a href="Images.html#TYPEload_option">load_option</a> list -> (float -> unit) option</code></pre><div class="info">
Option queries<br>
</div>
<pre><span class="keyword">val</span> <a name="VALload_resolution"></a>load_resolution : <code class="type"><a href="Images.html#TYPEload_option">load_option</a> list -> (float * float) option</code></pre><pre><span class="keyword">val</span> <a name="VALsave_progress"></a>save_progress : <code class="type"><a href="Images.html#TYPEsave_option">save_option</a> list -> (float -> unit) option</code></pre><pre><span class="keyword">val</span> <a name="VALsave_interlace"></a>save_interlace : <code class="type"><a href="Images.html#TYPEsave_option">save_option</a> list -> bool</code></pre><pre><span class="keyword">val</span> <a name="VALsave_quality"></a>save_quality : <code class="type"><a href="Images.html#TYPEsave_option">save_option</a> list -> int option</code></pre><br><code><span class="keyword">type</span> <a name="TYPEformat_methods"></a><code class="type"></code>format_methods = {</code><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>check_header : <code class="type">string -> <a href="Images.html#TYPEheader">header</a></code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>load : <code class="type">(string -> <a href="Images.html#TYPEload_option">load_option</a> list -> <a href="Images.html#TYPEt">t</a>) option</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>save : <code class="type">(string -> <a href="Images.html#TYPEsave_option">save_option</a> list -> <a href="Images.html#TYPEt">t</a> -> unit) option</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>load_sequence : <code class="type">(string -> <a href="Images.html#TYPEload_option">load_option</a> list -> <a href="Images.html#TYPEsequence">sequence</a>) option</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>save_sequence : <code class="type">(string -> <a href="Images.html#TYPEsave_option">save_option</a> list -> <a href="Images.html#TYPEsequence">sequence</a> -> unit) option</code>;</code></td>
</tr></table>
}
<pre><span class="keyword">val</span> <a name="VALadd_methods"></a>add_methods : <code class="type"><a href="Images.html#TYPEformat">format</a> -> <a href="Images.html#TYPEformat_methods">format_methods</a> -> unit</code></pre><div class="info">
If you write new drivers for some image format, use this function
to register their loading/saving functions into the libaray<br>
</div>
<pre><span class="keyword">val</span> <a name="VALload"></a>load : <code class="type">string -> <a href="Images.html#TYPEload_option">load_option</a> list -> <a href="Images.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">load filename options</code> read the header of an image file <code class="code">filename</code>,
loads the image by calling corresponding loading method, and
returns it. If the file format is not supported by the library,
a Wrong_file_type exception will be raised. You can specify loading
options in <code class="code">options</code> such as progressive meter function.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsave"></a>save : <code class="type">string -> <a href="Images.html#TYPEformat">format</a> option -> <a href="Images.html#TYPEsave_option">save_option</a> list -> <a href="Images.html#TYPEt">t</a> -> unit</code></pre><div class="info">
<code class="code">save filename formatopt options image</code> saves <code class="code">image</code> into a file
<code class="code">filename</code>. The image format can be specified by <code class="code">formatopt</code>.
If <code class="code">formatopt</code> is <code class="code">Some format</code>, then <code class="code">format</code> is used. If it is
<code class="code">None</code>, then the image format is guessed from <code class="code">filename</code>.
You can specify some saving parameters <code class="code">options</code>. Some options are
specific to some image formats and do not work with the others.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALload_sequence"></a>load_sequence : <code class="type">string -> <a href="Images.html#TYPEload_option">load_option</a> list -> <a href="Images.html#TYPEsequence">sequence</a></code></pre><pre><span class="keyword">val</span> <a name="VALsave_sequence"></a>save_sequence : <code class="type">string -><br> <a href="Images.html#TYPEformat">format</a> option -> <a href="Images.html#TYPEsave_option">save_option</a> list -> <a href="Images.html#TYPEsequence">sequence</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALunoptimize_sequence"></a>unoptimize_sequence : <code class="type"><a href="Images.html#TYPEsequence">sequence</a> -> <a href="Images.html#TYPEsequence">sequence</a></code></pre><pre><span class="keyword">val</span> <a name="VALsize"></a>size : <code class="type"><a href="Images.html#TYPEt">t</a> -> int * int</code></pre><div class="info">
Returns size (width and height) of image<br>
</div>
<pre><span class="keyword">val</span> <a name="VALdestroy"></a>destroy : <code class="type"><a href="Images.html#TYPEt">t</a> -> unit</code></pre><div class="info">
Free the image. If you turn on image swapping (see bitmap.mli),
you can call this function explicitly to tell the library that this image
is no longer used. (This is not required, though.)<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsub"></a>sub : <code class="type"><a href="Images.html#TYPEt">t</a> -> int -> int -> int -> int -> <a href="Images.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">sub dst x y width height</code> returns sub-bitmap of <code class="code">dst</code>,
at (x, y) - (x + width - 1, y + height - 1).<br>
</div>
<pre><span class="keyword">val</span> <a name="VALblit"></a>blit : <code class="type"><a href="Images.html#TYPEt">t</a> -> int -> int -> <a href="Images.html#TYPEt">t</a> -> int -> int -> int -> int -> unit</code></pre><div class="info">
<code class="code">blit src sx sy dst dx dy width height</code> copies the rectangle
region of <code class="code">src</code> at (sx, sy) - (sx + width - 1, sy + height - 1) to <code class="code">dst</code>, at
(dx, dy) - (dx + width - 1, dy + height - 1).<br>
</div>
</body></html>
