Skip to content

Commit

Permalink
Update cairo2 doc to 0.6.5.
Browse files Browse the repository at this point in the history
  • Loading branch information
Chris00 committed Nov 8, 2024
1 parent b40580f commit 2951d2b
Show file tree
Hide file tree
Showing 65 changed files with 987 additions and 136 deletions.
Empty file removed doc/cairo2-gtk/Cairo_gtk/.dummy
Empty file.
8 changes: 4 additions & 4 deletions doc/cairo2-gtk/Cairo_gtk/index.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Cairo_gtk (cairo2-gtk.Cairo_gtk)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../index.html">cairo2-gtk</a> &#x00BB; Cairo_gtk</nav><header class="odoc-preamble"><h1>Module <code><span>Cairo_gtk</span></code></h1><p>Integration of Cairo with labgtk2.</p><p>It allows to create Cairo contexts which can be used to draw on GDK drawables. Additional functions allow to convert GDK's rectangles and regions into Cairo paths and to use pixbufs as sources for drawing operations.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value" id="val-create" class="anchored"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span><span><span>[&gt; `drawable ]</span> <span class="xref-unresolved">Gobject</span>.obj</span> <span class="arrow">&#45;&gt;</span></span> <a href="../../cairo2/Cairo/index.html#type-context">Cairo.context</a></span></code></div><div class="spec-doc"><p><code>create drawable</code> creates a Cairo context for drawing to <code>drawable</code>.</p><p>NOTE: due to double-buffering, Cairo contexts created in a GTK+ expose event handler cannot be cached and reused between different expose events.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-set_source_color" class="anchored"><a href="#val-set_source_color" class="anchor"></a><code><span><span class="keyword">val</span> set_source_color : <span><a href="../../cairo2/Cairo/index.html#type-context">Cairo.context</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Gdk</span>.color <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>set_source_color cr color</code> sets the specified <code>color</code> as the source color of cr.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-rectangle" class="anchored"><a href="#val-rectangle" class="anchor"></a><code><span><span class="keyword">val</span> rectangle : <span><a href="../../cairo2/Cairo/index.html#type-context">Cairo.context</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Gdk</span>.Rectangle.t <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>rectangle cr r</code> adds the rectangle <code>r</code> to the current path of <code>cr</code>.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-region" class="anchored"><a href="#val-region" class="anchor"></a><code><span><span class="keyword">val</span> region : <span><a href="../../cairo2/Cairo/index.html#type-context">Cairo.context</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Gdk</span>.region <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>region cr r</code> adds the region <code>r</code> to the current path of <code>cr</code>.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-set_source_pixbuf" class="anchored"><a href="#val-set_source_pixbuf" class="anchor"></a><code><span><span class="keyword">val</span> set_source_pixbuf :
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Cairo_gtk (cairo2-gtk.Cairo_gtk)</title><link rel="stylesheet" href="../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc v2.3.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../index.html">cairo2-gtk</a> &#x00BB; Cairo_gtk</nav><header class="odoc-preamble"><h1>Module <code><span>Cairo_gtk</span></code></h1><p>Integration of Cairo with labgtk2.</p><p>It allows to create Cairo contexts which can be used to draw on GDK drawables. Additional functions allow to convert GDK's rectangles and regions into Cairo paths and to use pixbufs as sources for drawing operations.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-create"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span><span><span>[&gt; `drawable ]</span> <span class="xref-unresolved">Gobject</span>.obj</span> <span class="arrow">&#45;&gt;</span></span> <a href="../../cairo2/Cairo/index.html#type-context">Cairo.context</a></span></code></div><div class="spec-doc"><p><code>create drawable</code> creates a Cairo context for drawing to <code>drawable</code>.</p><p>NOTE: due to double-buffering, Cairo contexts created in a GTK+ expose event handler cannot be cached and reused between different expose events.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_source_color"><a href="#val-set_source_color" class="anchor"></a><code><span><span class="keyword">val</span> set_source_color : <span><a href="../../cairo2/Cairo/index.html#type-context">Cairo.context</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Gdk</span>.color <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>set_source_color cr color</code> sets the specified <code>color</code> as the source color of cr.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-rectangle"><a href="#val-rectangle" class="anchor"></a><code><span><span class="keyword">val</span> rectangle : <span><a href="../../cairo2/Cairo/index.html#type-context">Cairo.context</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Gdk</span>.Rectangle.t <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>rectangle cr r</code> adds the rectangle <code>r</code> to the current path of <code>cr</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-region"><a href="#val-region" class="anchor"></a><code><span><span class="keyword">val</span> region : <span><a href="../../cairo2/Cairo/index.html#type-context">Cairo.context</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Gdk</span>.region <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>region cr r</code> adds the region <code>r</code> to the current path of <code>cr</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_source_pixbuf"><a href="#val-set_source_pixbuf" class="anchor"></a><code><span><span class="keyword">val</span> set_source_pixbuf :
<span><a href="../../cairo2/Cairo/index.html#type-context">Cairo.context</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="xref-unresolved">GdkPixbuf</span>.pixbuf <span class="arrow">&#45;&gt;</span></span>
<span>x:float <span class="arrow">&#45;&gt;</span></span>
<span>y:float <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p>Sets the given pixbuf as the source pattern for the Cairo context. The pattern has an extend mode of <a href="../../cairo2/Cairo/Pattern/index.html#type-extend"><code>Cairo.Pattern.extend</code></a> set to <code>NONE</code> and is aligned so that the origin of pixbuf is (<code>x</code>,<code>y</code>).</p></div></div></div></body></html>
<span><span class="label">x</span>:float <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">y</span>:float <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p>Sets the given pixbuf as the source pattern for the Cairo context. The pattern has an extend mode of <a href="../../cairo2/Cairo/Pattern/index.html#type-extend"><code>Cairo.Pattern.extend</code></a> set to <code>NONE</code> and is aligned so that the origin of pixbuf is (<code>x</code>,<code>y</code>).</p></div></div></div></body></html>
2 changes: 1 addition & 1 deletion doc/cairo2-gtk/index.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (cairo2-gtk.index)</title><link rel="stylesheet" href="../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – cairo2-gtk</nav><header class="odoc-preamble"><h1 id="cairo2-gtk-index"><a href="#cairo2-gtk-index" class="anchor"></a>cairo2-gtk index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-cairo2-gtk">Library cairo2-gtk</a></li></ul></nav><div class="odoc-content"><h2 id="library-cairo2-gtk"><a href="#library-cairo2-gtk" class="anchor"></a>Library cairo2-gtk</h2><p>The entry point of this library is the module: <a href="Cairo_gtk/index.html"><code>Cairo_gtk</code></a>.</p></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (cairo2-gtk.index)</title><link rel="stylesheet" href="../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc v2.3.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – cairo2-gtk</nav><header class="odoc-preamble"><h1 id="cairo2-gtk-index"><a href="#cairo2-gtk-index" class="anchor"></a>cairo2-gtk index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-cairo2-gtk">Library cairo2-gtk</a></li></ul></nav><div class="odoc-content"><h2 id="library-cairo2-gtk"><a href="#library-cairo2-gtk" class="anchor"></a>Library cairo2-gtk</h2><p>The entry point of this library is the module: <a href="Cairo_gtk/index.html"><code>Cairo_gtk</code></a>.</p></div></body></html>
Empty file.
Loading

0 comments on commit 2951d2b

Please sign in to comment.