<!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="Freetype.html">
<link rel="next" href="Fttext.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>Ftlow</title>
</head>
<body>
<div class="navbar"><a href="Freetype.html">Previous</a>
<a href="index.html">Up</a>
<a href="Fttext.html">Next</a>
</div>
<center><h1>Module <a href="type_Ftlow.html">Ftlow</a></h1></center>
<br>
<pre><span class="keyword">module</span> Ftlow: <code class="code">sig</code> <a href="Ftlow.html">..</a> <code class="code">end</code></pre>Almost all of the functions are just interpretation of functions of
the freetype library. See the documents of the freetype library.<br>
<hr width="100%">
<pre><span class="keyword">type</span> <a name="TYPElibrary"></a><code class="type"></code>library </pre>
<pre><span class="keyword">val</span> <a name="VALinit"></a>init : <code class="type">unit -> <a href="Ftlow.html#TYPElibrary">library</a></code></pre><pre><span class="keyword">val</span> <a name="VALclose"></a>close : <code class="type"><a href="Ftlow.html#TYPElibrary">library</a> -> unit</code></pre><pre><span class="keyword">type</span> <a name="TYPEface"></a><code class="type"></code>face </pre>
<br><code><span class="keyword">type</span> <a name="TYPEface_info"></a><code class="type"></code>face_info = {</code><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>num_faces : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>num_glyphs : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>family_name : <code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>style_name : <code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>has_horizontal : <code class="type">bool</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>has_vertical : <code class="type">bool</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>has_kerning : <code class="type">bool</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>is_scalable : <code class="type">bool</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>is_sfnt : <code class="type">bool</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>is_fixed_width : <code class="type">bool</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>has_fixed_sizes : <code class="type">bool</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>has_fast_glyphs : <code class="type">bool</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>has_glyph_names : <code class="type">bool</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>has_multiple_masters : <code class="type">bool</code>;</code></td>
</tr></table>
}
<pre><span class="keyword">val</span> <a name="VALnew_face"></a>new_face : <code class="type"><a href="Ftlow.html#TYPElibrary">library</a> -> string -> int -> <a href="Ftlow.html#TYPEface">face</a></code></pre><pre><span class="keyword">val</span> <a name="VALface_info"></a>face_info : <code class="type"><a href="Ftlow.html#TYPEface">face</a> -> <a href="Ftlow.html#TYPEface_info">face_info</a></code></pre><pre><span class="keyword">val</span> <a name="VALdone_face"></a>done_face : <code class="type"><a href="Ftlow.html#TYPEface">face</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALget_num_glyphs"></a>get_num_glyphs : <code class="type"><a href="Ftlow.html#TYPEface">face</a> -> int</code></pre><pre><span class="keyword">val</span> <a name="VALset_char_size"></a>set_char_size : <code class="type"><a href="Ftlow.html#TYPEface">face</a> -> int -> int -> int -> int -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALset_pixel_sizes"></a>set_pixel_sizes : <code class="type"><a href="Ftlow.html#TYPEface">face</a> -> int -> int -> unit</code></pre><br><code><span class="keyword">type</span> <a name="TYPEcharmap"></a><code class="type"></code>charmap = {</code><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>platform_id : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>encoding_id : <code class="type">int</code>;</code></td>
</tr></table>
}
<pre><span class="keyword">val</span> <a name="VALget_charmaps"></a>get_charmaps : <code class="type"><a href="Ftlow.html#TYPEface">face</a> -> <a href="Ftlow.html#TYPEcharmap">charmap</a> list</code></pre><pre><span class="keyword">val</span> <a name="VALset_charmap"></a>set_charmap : <code class="type"><a href="Ftlow.html#TYPEface">face</a> -> <a href="Ftlow.html#TYPEcharmap">charmap</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALget_char_index"></a>get_char_index : <code class="type"><a href="Ftlow.html#TYPEface">face</a> -> int -> int</code></pre><br><code><span class="keyword">type</span> <a name="TYPErender_mode"></a><code class="type"></code>render_mode = </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">Render_Normal</span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >default</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">Render_Mono</span></code></td>
</tr></table>
<br><code><span class="keyword">type</span> <a name="TYPEload_flag"></a><code class="type"></code>load_flag = </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_no_scale</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">Load_no_hinting</span></code></td>
</tr></table>
<pre><span class="keyword">val</span> <a name="VALload_glyph"></a>load_glyph : <code class="type"><a href="Ftlow.html#TYPEface">face</a> -> int -> <a href="Ftlow.html#TYPEload_flag">load_flag</a> list -> int * int</code></pre><pre><span class="keyword">val</span> <a name="VALload_char"></a>load_char : <code class="type"><a href="Ftlow.html#TYPEface">face</a> -> int -> <a href="Ftlow.html#TYPEload_flag">load_flag</a> list -> int * int</code></pre><pre><span class="keyword">val</span> <a name="VALrender_glyph_of_face"></a>render_glyph_of_face : <code class="type"><a href="Ftlow.html#TYPEface">face</a> -> <a href="Ftlow.html#TYPErender_mode">render_mode</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALrender_glyph"></a>render_glyph : <code class="type"><a href="Ftlow.html#TYPEface">face</a> -> int -> <a href="Ftlow.html#TYPEload_flag">load_flag</a> list -> <a href="Ftlow.html#TYPErender_mode">render_mode</a> -> int * int</code></pre><pre><span class="keyword">val</span> <a name="VALrender_char"></a>render_char : <code class="type"><a href="Ftlow.html#TYPEface">face</a> -> int -> <a href="Ftlow.html#TYPEload_flag">load_flag</a> list -> <a href="Ftlow.html#TYPErender_mode">render_mode</a> -> int * int</code></pre><pre><span class="keyword">val</span> <a name="VALset_transform"></a>set_transform : <code class="type"><a href="Ftlow.html#TYPEface">face</a> -> int * int * int * int -> int * int -> unit</code></pre><br><code><span class="keyword">type</span> <a name="TYPEbitmap_info"></a><code class="type"></code>bitmap_info = {</code><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>bitmap_left : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>bitmap_top : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>bitmap_width : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>bitmap_height : <code class="type">int</code>;</code></td>
</tr></table>
}
<pre><span class="keyword">val</span> <a name="VALget_bitmap_info"></a>get_bitmap_info : <code class="type"><a href="Ftlow.html#TYPEface">face</a> -> <a href="Ftlow.html#TYPEbitmap_info">bitmap_info</a></code></pre><pre><span class="keyword">val</span> <a name="VALread_bitmap"></a>read_bitmap : <code class="type"><a href="Ftlow.html#TYPEface">face</a> -> int -> int -> int</code></pre><br><code><span class="keyword">type</span> <a name="TYPEbbox"></a><code class="type"></code>bbox = {</code><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>xmin : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >26.6</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>ymin : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >26.6</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>xmax : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >26.6</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>ymax : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >26.6</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
}
<div class="info">
glyph metrics<br>
</div>
<br><code><span class="keyword">type</span> <a name="TYPEbearing_advance"></a><code class="type"></code>bearing_advance = {</code><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>bearingx : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >26.6</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>bearingy : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >26.6</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>advance : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >26.6</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
}
<br><code><span class="keyword">type</span> <a name="TYPEglyph_metrics"></a><code class="type"></code>glyph_metrics = {</code><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>gm_width : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >26.6</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>gm_height : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >26.6</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>gm_hori : <code class="type"><a href="Ftlow.html#TYPEbearing_advance">bearing_advance</a></code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>gm_vert : <code class="type"><a href="Ftlow.html#TYPEbearing_advance">bearing_advance</a></code>;</code></td>
</tr></table>
}
<pre><span class="keyword">val</span> <a name="VALget_glyph_metrics"></a>get_glyph_metrics : <code class="type"><a href="Ftlow.html#TYPEface">face</a> -> <a href="Ftlow.html#TYPEglyph_metrics">glyph_metrics</a></code></pre><br><code><span class="keyword">type</span> <a name="TYPEsize_metrics"></a><code class="type"></code>size_metrics = {</code><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>x_ppem : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>y_ppem : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>x_scale : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >16.16</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>y_scale : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >16.16</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
}
<div class="info">
size metrics<br>
</div>
<pre><span class="keyword">val</span> <a name="VALget_size_metrics"></a>get_size_metrics : <code class="type"><a href="Ftlow.html#TYPEface">face</a> -> <a href="Ftlow.html#TYPEsize_metrics">size_metrics</a></code></pre><br><code><span class="keyword">type</span> <a name="TYPEoutline_tag"></a><code class="type"></code>outline_tag = </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">On_point</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">Off_point_conic</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">Off_point_cubic</span></code></td>
</tr></table>
<div class="info">
outline info<br>
</div>
<br><code><span class="keyword">type</span> <a name="TYPEoutline_contents"></a><code class="type"></code>outline_contents = {</code><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>n_contours : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>n_points : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>points : <code class="type">(int * int) array</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>tags : <code class="type"><a href="Ftlow.html#TYPEoutline_tag">outline_tag</a> array</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>contours : <code class="type">int array</code>;</code></td>
</tr></table>
}
<pre><span class="keyword">val</span> <a name="VALget_outline_contents"></a>get_outline_contents : <code class="type"><a href="Ftlow.html#TYPEface">face</a> -> <a href="Ftlow.html#TYPEoutline_contents">outline_contents</a></code></pre></body></html>
