summaryrefslogtreecommitdiffstats
path: root/abs/mv-core/ghosd/ghosd-0.0.1/doc/xml/ghosd.xml
diff options
context:
space:
mode:
Diffstat (limited to 'abs/mv-core/ghosd/ghosd-0.0.1/doc/xml/ghosd.xml')
-rw-r--r--abs/mv-core/ghosd/ghosd-0.0.1/doc/xml/ghosd.xml209
1 files changed, 209 insertions, 0 deletions
diff --git a/abs/mv-core/ghosd/ghosd-0.0.1/doc/xml/ghosd.xml b/abs/mv-core/ghosd/ghosd-0.0.1/doc/xml/ghosd.xml
new file mode 100644
index 0000000..5aac1c0
--- /dev/null
+++ b/abs/mv-core/ghosd/ghosd-0.0.1/doc/xml/ghosd.xml
@@ -0,0 +1,209 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+<refentry id="ghosd-Basics">
+<refmeta>
+<refentrytitle>Basics</refentrytitle>
+<manvolnum>3</manvolnum>
+<refmiscinfo>GHOSD Library</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+<refname>Basics</refname><refpurpose>Creation, rendering, destruction.</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv><title>Synopsis</title>
+
+<synopsis>
+
+#include &lt;ghosd/ghosd.h&gt;
+
+
+ <link linkend="Ghosd">Ghosd</link>;
+<link linkend="void">void</link> (<link linkend="GhosdRenderFunc">*GhosdRenderFunc</link>) (<link linkend="Ghosd">Ghosd</link> *ghosd,
+ <link linkend="cairo-t">cairo_t</link> *cr,
+ <link linkend="void">void</link> *user_data);
+<link linkend="Ghosd">Ghosd</link>* <link linkend="ghosd-new">ghosd_new</link> (void);
+<link linkend="void">void</link> <link linkend="ghosd-set-transparent">ghosd_set_transparent</link> (<link linkend="Ghosd">Ghosd</link> *ghosd,
+ <link linkend="int">int</link> transparent);
+#define <link linkend="GHOSD-COORD-CENTER:CAPS">GHOSD_COORD_CENTER</link>
+<link linkend="void">void</link> <link linkend="ghosd-set-position">ghosd_set_position</link> (<link linkend="Ghosd">Ghosd</link> *ghosd,
+ <link linkend="int">int</link> x,
+ <link linkend="int">int</link> y,
+ <link linkend="int">int</link> width,
+ <link linkend="int">int</link> height);
+<link linkend="void">void</link> <link linkend="ghosd-set-render">ghosd_set_render</link> (<link linkend="Ghosd">Ghosd</link> *ghosd,
+ <link linkend="GhosdRenderFunc">GhosdRenderFunc</link> render_func,
+ <link linkend="void">void</link> *data);
+<link linkend="void">void</link> <link linkend="ghosd-render">ghosd_render</link> (<link linkend="Ghosd">Ghosd</link> *ghosd);
+<link linkend="void">void</link> <link linkend="ghosd-show">ghosd_show</link> (<link linkend="Ghosd">Ghosd</link> *ghosd);
+</synopsis>
+</refsynopsisdiv>
+
+
+
+
+
+
+
+
+
+<refsect1>
+<title>Description</title>
+<para>
+
+</para>
+</refsect1>
+
+<refsect1>
+<title>Details</title>
+<refsect2>
+<title><anchor id="Ghosd"/>Ghosd</title>
+<indexterm><primary>Ghosd</primary></indexterm><programlisting>typedef struct _Ghosd Ghosd;</programlisting>
+<para>
+An opaque Ghosd object. Think of it as the window that the content is
+displayed in.
+</para></refsect2>
+<refsect2>
+<title><anchor id="GhosdRenderFunc"/>GhosdRenderFunc ()</title>
+<indexterm><primary>GhosdRenderFunc</primary></indexterm><programlisting><link linkend="void">void</link> (*GhosdRenderFunc) (<link linkend="Ghosd">Ghosd</link> *ghosd,
+ <link linkend="cairo-t">cairo_t</link> *cr,
+ <link linkend="void">void</link> *user_data);</programlisting>
+<para>
+The type of callback called when Ghosd needs to render the content.
+</para><variablelist role="params">
+<varlistentry><term><parameter>ghosd</parameter>&nbsp;:</term>
+<listitem><simpara>A <link linkend="Ghosd"><type>Ghosd</type></link> object.
+</simpara></listitem></varlistentry>
+<varlistentry><term><parameter>cr</parameter>&nbsp;:</term>
+<listitem><simpara>A <link linkend="cairo-t"><type>cairo_t</type></link> to draw on.
+</simpara></listitem></varlistentry>
+<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
+<listitem><simpara>User data that was passed to <link linkend="ghosd-set-render"><function>ghosd_set_render()</function></link>.
+
+
+</simpara></listitem></varlistentry>
+</variablelist></refsect2>
+<refsect2>
+<title><anchor id="ghosd-new"/>ghosd_new ()</title>
+<indexterm><primary>ghosd_new</primary></indexterm><programlisting><link linkend="Ghosd">Ghosd</link>* ghosd_new (void);</programlisting>
+<para>
+Create a new <link linkend="Ghosd"><type>Ghosd</type></link> object.
+</para>
+<para>
+Can return <literal>NULL</literal> if unable to connect to the X server.</para>
+<para>
+
+</para><variablelist role="params">
+<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="Ghosd"><type>Ghosd</type></link> object.
+</simpara></listitem></varlistentry>
+</variablelist></refsect2>
+<refsect2>
+<title><anchor id="ghosd-set-transparent"/>ghosd_set_transparent ()</title>
+<indexterm><primary>ghosd_set_transparent</primary></indexterm><programlisting><link linkend="void">void</link> ghosd_set_transparent (<link linkend="Ghosd">Ghosd</link> *ghosd,
+ <link linkend="int">int</link> transparent);</programlisting>
+<para>
+Change the "transparent" setting. Setting <parameter>transparent</parameter> to <literal>FALSE</literal> is
+mostly useful for debugging.</para>
+<para>
+
+</para><variablelist role="params">
+<varlistentry><term><parameter>ghosd</parameter>&nbsp;:</term>
+<listitem><simpara> a <link linkend="Ghosd"><type>Ghosd</type></link> object.
+</simpara></listitem></varlistentry>
+<varlistentry><term><parameter>transparent</parameter>&nbsp;:</term>
+<listitem><simpara> a boolean indicating the transparent setting.
+</simpara></listitem></varlistentry>
+</variablelist></refsect2>
+<refsect2>
+<title><anchor id="GHOSD-COORD-CENTER:CAPS"/>GHOSD_COORD_CENTER</title>
+<indexterm><primary>GHOSD_COORD_CENTER</primary></indexterm><programlisting>#define GHOSD_COORD_CENTER MAXINT
+</programlisting>
+<para>
+Pass this as a coordinate to <link linkend="ghosd-set-position"><function>ghosd_set_position()</function></link> to center along that axis.
+</para></refsect2>
+<refsect2>
+<title><anchor id="ghosd-set-position"/>ghosd_set_position ()</title>
+<indexterm><primary>ghosd_set_position</primary></indexterm><programlisting><link linkend="void">void</link> ghosd_set_position (<link linkend="Ghosd">Ghosd</link> *ghosd,
+ <link linkend="int">int</link> x,
+ <link linkend="int">int</link> y,
+ <link linkend="int">int</link> width,
+ <link linkend="int">int</link> height);</programlisting>
+<para>
+Position the initial <link linkend="Ghosd"><type>Ghosd</type></link>. Must be called before <link linkend="ghosd-render"><function>ghosd_render()</function></link> and
+<link linkend="ghosd-show"><function>ghosd_show()</function></link>, and can only be called once.
+</para>
+<para>
+Positive x,y are interpreted as normal coordinates.
+Pass <literal>GHOSD_COORD_CENTER</literal> to center on a given dimension,
+and negative coordinates right-align (like CSS right).</para>
+<para>
+
+</para><variablelist role="params">
+<varlistentry><term><parameter>ghosd</parameter>&nbsp;:</term>
+<listitem><simpara> a <link linkend="Ghosd"><type>Ghosd</type></link> object.
+</simpara></listitem></varlistentry>
+<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
+<listitem><simpara> x coordinate in screen pixels.
+</simpara></listitem></varlistentry>
+<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
+<listitem><simpara> y coordinate in screen pixels.
+</simpara></listitem></varlistentry>
+<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
+<listitem><simpara> width in screen pixels.
+</simpara></listitem></varlistentry>
+<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
+<listitem><simpara> width in screen pixels.
+</simpara></listitem></varlistentry>
+</variablelist></refsect2>
+<refsect2>
+<title><anchor id="ghosd-set-render"/>ghosd_set_render ()</title>
+<indexterm><primary>ghosd_set_render</primary></indexterm><programlisting><link linkend="void">void</link> ghosd_set_render (<link linkend="Ghosd">Ghosd</link> *ghosd,
+ <link linkend="GhosdRenderFunc">GhosdRenderFunc</link> render_func,
+ <link linkend="void">void</link> *data);</programlisting>
+<para>
+Register a function to draw on the <link linkend="Ghosd"><type>Ghosd</type></link>.</para>
+<para>
+
+</para><variablelist role="params">
+<varlistentry><term><parameter>ghosd</parameter>&nbsp;:</term>
+<listitem><simpara> a <link linkend="Ghosd"><type>Ghosd</type></link> object.
+</simpara></listitem></varlistentry>
+<varlistentry><term><parameter>render_func</parameter>&nbsp;:</term>
+<listitem><simpara> a <link linkend="GhosdRenderFunc"><type>GhosdRenderFunc</type></link> callback.
+</simpara></listitem></varlistentry>
+<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
+<listitem><simpara> user data to pass to the callback.
+</simpara></listitem></varlistentry>
+</variablelist></refsect2>
+<refsect2>
+<title><anchor id="ghosd-render"/>ghosd_render ()</title>
+<indexterm><primary>ghosd_render</primary></indexterm><programlisting><link linkend="void">void</link> ghosd_render (<link linkend="Ghosd">Ghosd</link> *ghosd);</programlisting>
+<para>
+Makes the Ghosd redraw itself.</para>
+<para>
+
+</para><variablelist role="params">
+<varlistentry><term><parameter>ghosd</parameter>&nbsp;:</term>
+<listitem><simpara> a <link linkend="Ghosd"><type>Ghosd</type></link> object.
+</simpara></listitem></varlistentry>
+</variablelist></refsect2>
+<refsect2>
+<title><anchor id="ghosd-show"/>ghosd_show ()</title>
+<indexterm><primary>ghosd_show</primary></indexterm><programlisting><link linkend="void">void</link> ghosd_show (<link linkend="Ghosd">Ghosd</link> *ghosd);</programlisting>
+<para>
+Show the <link linkend="Ghosd"><type>Ghosd</type></link>.</para>
+<para>
+
+</para><variablelist role="params">
+<varlistentry><term><parameter>ghosd</parameter>&nbsp;:</term>
+<listitem><simpara> a <link linkend="Ghosd"><type>Ghosd</type></link> object.
+</simpara></listitem></varlistentry>
+</variablelist></refsect2>
+
+</refsect1>
+
+
+
+
+</refentry>
generated by cgit v0.12 at 2024-06-25 06:40:24 (GMT)