Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > 0be7620be6a1578fbd49765844864a01 > files > 330

ocaml-lablgtk2-doc-2.14.0-2mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="Start" href="index.html">
<link rel="previous" href="GdkEvent.html">
<link rel="next" href="Gtk.html">
<link rel="Up" href="index.html">
<title>LablGTK : GdkPixbuf</title>
</head>
<body>
<div class="navbar"><a href="GdkEvent.html">Previous</a>
&nbsp;<a href="index.html">Up</a>
&nbsp;<a href="Gtk.html">Next</a>
</div>
<center><h1>Module <a href="type_GdkPixbuf.html">GdkPixbuf</a></h1></center>
<br>
<pre><span class="keyword">module</span> GdkPixbuf: <code class="code">sig</code> <a href="GdkPixbuf.html">..</a> <code class="code">end</code></pre>Object for manipulating image data<br>
<small>GTK documentation:&nbsp;<a href="file:///usr/share/gtk-doc/html/gdk-pixbuf/index.html">index</a></small><hr width="100%">
<br>
<a name="3_TheGdkPixbufStructure"></a>
<h3>The GdkPixbuf Structure</h3><br>
<pre><span class="keyword">type</span> <a name="TYPEpixbuf"></a><code class="type"></code>pixbuf = <code class="type">[ `pixbuf ] <a href="Gobject.html#TYPEobj">Gobject.obj</a></code> </pre>
<div class="info">
<small>GTK documentation:&nbsp;<a href="file:///usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html">gdk-pixbuf-gdk-pixbuf</a></small></div>

<pre><span class="keyword">type</span> <a name="TYPEcolorspace"></a><code class="type"></code>colorspace = <code class="type">[ `RGB ]</code> </pre>

<pre><span class="keyword">type</span> <a name="TYPEalpha_mode"></a><code class="type"></code>alpha_mode = <code class="type">[ `BILEVEL | `FULL ]</code> </pre>

<pre><span class="keyword">type</span> <a name="TYPEinterpolation"></a><code class="type"></code>interpolation = <code class="type">[ `BILINEAR | `HYPER | `NEAREST | `TILES ]</code> </pre>

<br><code><span class="keyword">type</span> <a name="TYPEgdkpixbuferror"></a><code class="type"></code>gdkpixbuferror = </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">ERROR_CORRUPT_IMAGE</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">ERROR_INSUFFICIENT_MEMORY</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">ERROR_BAD_OPTION</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">ERROR_UNKNOWN_TYPE</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">ERROR_UNSUPPORTED_OPERATION</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">ERROR_FAILED</span></code></td>

</tr></table>


<pre><span class="keyword">exception</span> <a name="EXCEPTIONGdkPixbufError"></a>GdkPixbufError <span class="keyword">of</span> <code class="type"><a href="GdkPixbuf.html#TYPEgdkpixbuferror">gdkpixbuferror</a> * string</code></pre>
<pre><span class="keyword">val</span> <a name="VALset_marshal_use_rle"></a>set_marshal_use_rle : <code class="type">bool -> unit</code></pre><br>
<a name="3_Creation"></a>
<h3>Creation</h3><br>
<pre><span class="keyword">val</span> <a name="VALcreate"></a>create : <code class="type">width:int -><br>       height:int -><br>       ?bits:int -><br>       ?colorspace:<a href="GdkPixbuf.html#TYPEcolorspace">colorspace</a> -><br>       ?has_alpha:bool -> unit -> <a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a></code></pre><div class="info">
<small>GTK documentation:&nbsp;<a href="file:///usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-creating.html">gdk-pixbuf-creating</a></small></div>
<pre><span class="keyword">val</span> <a name="VALcast"></a>cast : <code class="type">'a <a href="Gobject.html#TYPEobj">Gobject.obj</a> -> <a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a></code></pre><pre><span class="keyword">val</span> <a name="VALcopy"></a>copy : <code class="type"><a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -> <a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a></code></pre><pre><span class="keyword">val</span> <a name="VALsubpixbuf"></a>subpixbuf : <code class="type"><a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -><br>       src_x:int -> src_y:int -> width:int -> height:int -> <a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a></code></pre><pre><span class="keyword">val</span> <a name="VALfrom_file"></a>from_file : <code class="type">string -> <a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a></code></pre><div class="info">
<small>GTK documentation:&nbsp;<a href="file:///usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-file-loading.html">gdk-pixbuf-file-loading</a></small></div>
<pre><span class="keyword">val</span> <a name="VALget_file_info"></a>get_file_info : <code class="type">string -> string * int * int</code></pre><div class="info">
<b>Since</b> GTK 2.4<br>
</div>
<pre><span class="keyword">val</span> <a name="VALfrom_file_at_size"></a>from_file_at_size : <code class="type">string -> width:int -> height:int -> <a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a></code></pre><div class="info">
<b>Since</b> GTK 2.4<br>
<small>GTK documentation:&nbsp;<a href="file:///usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-file-loading.html">gdk-pixbuf-file-loading</a></small></div>
<pre><span class="keyword">val</span> <a name="VALfrom_xpm_data"></a>from_xpm_data : <code class="type">string array -> <a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a></code></pre><pre><span class="keyword">val</span> <a name="VALfrom_data"></a>from_data : <code class="type">width:int -><br>       height:int -><br>       ?bits:int -><br>       ?rowstride:int -> ?has_alpha:bool -> <a href="Gpointer.html#TYPEregion">Gpointer.region</a> -> <a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a></code></pre><pre><span class="keyword">val</span> <a name="VALget_from_drawable"></a>get_from_drawable : <code class="type">dest:<a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -><br>       ?dest_x:int -><br>       ?dest_y:int -><br>       ?width:int -><br>       ?height:int -><br>       ?src_x:int -><br>       ?src_y:int -> ?colormap:<a href="Gdk.html#TYPEcolormap">Gdk.colormap</a> -> [> `drawable ] <a href="Gobject.html#TYPEobj">Gobject.obj</a> -> unit</code></pre><div class="info">
<small>GTK documentation:&nbsp;<a href="file:///usr/share/gtk-doc/html/gdk/gdk-Pixbufs.html">gdk-Pixbufs</a></small></div>
<br>
<a name="3_Accessors"></a>
<h3>Accessors</h3><br>
<pre><span class="keyword">val</span> <a name="VALget_n_channels"></a>get_n_channels : <code class="type"><a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -> int</code></pre><pre><span class="keyword">val</span> <a name="VALget_has_alpha"></a>get_has_alpha : <code class="type"><a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -> bool</code></pre><pre><span class="keyword">val</span> <a name="VALget_bits_per_sample"></a>get_bits_per_sample : <code class="type"><a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -> int</code></pre><pre><span class="keyword">val</span> <a name="VALget_width"></a>get_width : <code class="type"><a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -> int</code></pre><pre><span class="keyword">val</span> <a name="VALget_height"></a>get_height : <code class="type"><a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -> int</code></pre><pre><span class="keyword">val</span> <a name="VALget_rowstride"></a>get_rowstride : <code class="type"><a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -> int</code></pre><pre><span class="keyword">val</span> <a name="VALget_pixels"></a>get_pixels : <code class="type"><a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -> <a href="Gpointer.html#TYPEregion">Gpointer.region</a></code></pre><br>
<a name="3_Rendering"></a>
<h3>Rendering</h3><br>
<pre><span class="keyword">val</span> <a name="VALdraw_pixbuf"></a>draw_pixbuf : <code class="type">[> `drawable ] <a href="Gobject.html#TYPEobj">Gobject.obj</a> -><br>       <a href="Gdk.html#TYPEgc">Gdk.gc</a> -><br>       ?dest_x:int -><br>       ?dest_y:int -><br>       ?width:int -><br>       ?height:int -><br>       ?dither:<a href="Gdk.Tags.html#TYPErgb_dither">Gdk.Tags.rgb_dither</a> -><br>       ?x_dither:int -><br>       ?y_dither:int -> ?src_x:int -> ?src_y:int -> <a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -> unit</code></pre><div class="info">
<small>GTK documentation:&nbsp;<a href="file:///usr/share/gtk-doc/html/gdk/gdk-Drawing-Primitives.html">gdk-Drawing-Primitives</a></small></div>
<pre><span class="keyword">val</span> <a name="VALrender_to_drawable"></a>render_to_drawable : <code class="type">[> `drawable ] <a href="Gobject.html#TYPEobj">Gobject.obj</a> -><br>       ?gc:<a href="Gdk.html#TYPEgc">Gdk.gc</a> -><br>       ?dest_x:int -><br>       ?dest_y:int -><br>       ?width:int -><br>       ?height:int -><br>       ?dither:<a href="Gdk.Tags.html#TYPErgb_dither">Gdk.Tags.rgb_dither</a> -><br>       ?x_dither:int -><br>       ?y_dither:int -> ?src_x:int -> ?src_y:int -> <a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -> unit</code></pre><div class="info">
<span class="warning">Deprecated.</span>use <a href="GdkPixbuf.html#VALdraw_pixbuf"><code class="code">GdkPixbuf.draw_pixbuf</code></a><br>
<small>GTK documentation:&nbsp;<a href="file:///usr/share/gtk-doc/html/gdk/gdk-Pixbufs.html">gdk-Pixbufs</a></small></div>
<pre><span class="keyword">val</span> <a name="VALrender_alpha"></a>render_alpha : <code class="type"><a href="Gdk.html#TYPEbitmap">Gdk.bitmap</a> -><br>       ?dest_x:int -><br>       ?dest_y:int -><br>       ?width:int -><br>       ?height:int -><br>       ?threshold:int -> ?src_x:int -> ?src_y:int -> <a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -> unit</code></pre><div class="info">
<small>GTK documentation:&nbsp;<a href="file:///usr/share/gtk-doc/html/gdk/gdk-Pixbufs.html">gdk-Pixbufs</a></small></div>
<pre><span class="keyword">val</span> <a name="VALrender_to_drawable_alpha"></a>render_to_drawable_alpha : <code class="type">[> `drawable ] <a href="Gobject.html#TYPEobj">Gobject.obj</a> -><br>       ?dest_x:int -><br>       ?dest_y:int -><br>       ?width:int -><br>       ?height:int -><br>       ?alpha:<a href="GdkPixbuf.html#TYPEalpha_mode">alpha_mode</a> -><br>       ?threshold:int -><br>       ?dither:<a href="Gdk.Tags.html#TYPErgb_dither">Gdk.Tags.rgb_dither</a> -><br>       ?x_dither:int -><br>       ?y_dither:int -> ?src_x:int -> ?src_y:int -> <a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -> unit</code></pre><div class="info">
<span class="warning">Deprecated.</span>use <a href="GdkPixbuf.html#VALdraw_pixbuf"><code class="code">GdkPixbuf.draw_pixbuf</code></a><br>
<small>GTK documentation:&nbsp;<a href="file:///usr/share/gtk-doc/html/gdk/gdk-Pixbufs.html">gdk-Pixbufs</a></small></div>
<pre><span class="keyword">val</span> <a name="VALcreate_pixmap"></a>create_pixmap : <code class="type">?threshold:int -> <a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -> <a href="Gdk.html#TYPEpixmap">Gdk.pixmap</a> * <a href="Gdk.html#TYPEbitmap">Gdk.bitmap</a> option</code></pre><div class="info">
<small>GTK documentation:&nbsp;<a href="file:///usr/share/gtk-doc/html/gdk/gdk-Pixbufs.html">gdk-Pixbufs</a></small></div>
<br>
<a name="3_Transform"></a>
<h3>Transform</h3><br>
<pre><span class="keyword">val</span> <a name="VALadd_alpha"></a>add_alpha : <code class="type">?transparent:int * int * int -> <a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -> <a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a></code></pre><div class="info">
<small>GTK documentation:&nbsp;<a href="file:///usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-util.html">gdk-pixbuf-util</a></small></div>
<pre><span class="keyword">val</span> <a name="VALfill"></a>fill : <code class="type"><a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -> int32 -> unit</code></pre><div class="info">
<small>GTK documentation:&nbsp;<a href="file:///usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-util.html">gdk-pixbuf-util</a></small></div>
<pre><span class="keyword">val</span> <a name="VALsaturate_and_pixelate"></a>saturate_and_pixelate : <code class="type">dest:<a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -><br>       saturation:float -> pixelate:bool -> <a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -> unit</code></pre><div class="info">
<small>GTK documentation:&nbsp;<a href="file:///usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-util.html">gdk-pixbuf-util</a></small></div>
<pre><span class="keyword">val</span> <a name="VALcopy_area"></a>copy_area : <code class="type">dest:<a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -><br>       ?dest_x:int -><br>       ?dest_y:int -><br>       ?width:int -><br>       ?height:int -> ?src_x:int -> ?src_y:int -> <a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -> unit</code></pre><div class="info">
<small>GTK documentation:&nbsp;<a href="file:///usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-util.html">gdk-pixbuf-util</a></small></div>
<pre><span class="keyword">val</span> <a name="VALscale"></a>scale : <code class="type">dest:<a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -><br>       ?dest_x:int -><br>       ?dest_y:int -><br>       ?width:int -><br>       ?height:int -><br>       ?ofs_x:float -><br>       ?ofs_y:float -><br>       ?scale_x:float -><br>       ?scale_y:float -> ?interp:<a href="GdkPixbuf.html#TYPEinterpolation">interpolation</a> -> <a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -> unit</code></pre><div class="info">
<small>GTK documentation:&nbsp;<a href="file:///usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-scaling.html">gdk-pixbuf-scaling</a></small></div>
<pre><span class="keyword">val</span> <a name="VALcomposite"></a>composite : <code class="type">dest:<a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -><br>       alpha:int -><br>       ?dest_x:int -><br>       ?dest_y:int -><br>       ?width:int -><br>       ?height:int -><br>       ?ofs_x:float -><br>       ?ofs_y:float -><br>       ?scale_x:float -><br>       ?scale_y:float -> ?interp:<a href="GdkPixbuf.html#TYPEinterpolation">interpolation</a> -> <a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -> unit</code></pre><div class="info">
<small>GTK documentation:&nbsp;<a href="file:///usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-scaling.html">gdk-pixbuf-scaling</a></small></div>
<br>
<a name="3_Saving"></a>
<h3>Saving</h3><br>
<pre><span class="keyword">val</span> <a name="VALsave"></a>save : <code class="type">filename:string -><br>       typ:string -> ?options:(string * string) list -> <a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -> unit</code></pre><div class="info">
<small>GTK documentation:&nbsp;<a href="file:///usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-file-saving.html">gdk-pixbuf-file-saving</a></small></div>
<pre><span class="keyword">val</span> <a name="VALsave_to_callback"></a>save_to_callback : <code class="type"><a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -><br>       typ:string -> ?options:(string * string) list -> (string -> unit) -> unit</code></pre><div class="info">
<b>Since</b> GTK 2.4<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsave_to_buffer"></a>save_to_buffer : <code class="type"><a href="GdkPixbuf.html#TYPEpixbuf">pixbuf</a> -><br>       typ:string -> ?options:(string * string) list -> Buffer.t -> unit</code></pre><div class="info">
<b>Since</b> GTK 2.4<br>
</div>
</body></html>