fdo-mirrors/cairo
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/cairo/cairo.git synced 2026-04-25 02:40:38 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

started to document from top to bottom. most things are obvious

Browse source
This commit is contained in:
Thomas Hunger 2003-10-16 10:54:34 +00:00
parent 8f7106a952
commit 007bbe56db
11 changed files with 46 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/reference/ChangeLog
View file

@ -1,3 +1,7 @@
2003-10-16 Thomas Hunger <info@teh-web.de>
* xml/some started to document stuff from top to bottom
2003-10-16 Thomas Hunger <info@teh-web.de>
* xml/* changed all files in the xml directory to

21
doc/reference/xml/cairo_copy.xml
View file

@ -1,4 +1,3 @@
<refentry id="cairo_copy">
<refmeta>
<refentrytitle>cairo_copy</refentrytitle>
@ -6,7 +5,7 @@
</refmeta>
<refnamediv>
<refname>cairo_copy</refname>
<refpurpose>some description</refpurpose>
<refpurpose>copy contents from one <link linkend="cairo_t">cairo_t</link> to another</refpurpose>
</refnamediv>
<refsynopsisdiv>
<programlisting>
@ -15,13 +14,13 @@ void cairo_copy (<link linkend="cairo_t">cairo_t</link> *dest, <link linkend="ca
<varlistentry>
<term><parameter>dest</parameter> :</term>
<listitem>
<simpara>description</simpara>
<simpara>an allocated <link linkend="cairo_t">cairo_t</link></simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>src</parameter> :</term>
<listitem>
<simpara>description</simpara>
<simpara><link linkend="cairo_t">cairo_t</link> to copy</simpara>
</listitem>
</varlistentry>
</variablelist>
@ -36,6 +35,20 @@ void cairo_copy (<link linkend="cairo_t">cairo_t</link> *dest, <link linkend="ca
<indexterm>
<primary/>
</indexterm>
This function copies all state information from src to dest. That includes not yet drawn paths and font information.
</para>
<para>
The new <link linkend="cairo_t">cairo_t</link> will become owner of the target and clip surfaces by incrementing their refcount. But the surfaces will not be copied, that means operations on either src or dest will be painted onto the same surface.
</para>
<para>
Note that saved states on the stack can only be restored once. So if you have unclosed calls to <link linkend="cairo_save">cairo_save</link> before copying, calling <link linkend="cairo_restore">cairo_restore</link> on both, src and dest is invalid.
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
cairo_clone
</para>
</refsect1>
</refentry>

4
doc/reference/xml/cairo_create.xml
View file

@ -1,4 +1,3 @@
<refentry id="cairo_create">
<refmeta>
<refentrytitle>cairo_create</refentrytitle>
@ -6,7 +5,7 @@
</refmeta>
<refnamediv>
<refname>cairo_create</refname>
<refpurpose>some description</refpurpose>
<refpurpose>create a new <link linkend="cairo_t">cairo_t</link> object</refpurpose>
</refnamediv>
<refsynopsisdiv>
<programlisting><link linkend="cairo_t">cairo_t</link> * cairo_create (void)</programlisting>
@ -29,6 +28,7 @@
<indexterm>
<primary/>
</indexterm>
This function creates a new <link linkend="cairo_t">cairo_t</link> with a reference count of one. Call <link linkend="cairo_destroy">cairo_destroy</link> to free the allocated resources.
</para>
</refsect1>
</refentry>

9
doc/reference/xml/cairo_destroy.xml
View file

@ -1,4 +1,3 @@
<refentry id="cairo_destroy">
<refmeta>
<refentrytitle>cairo_destroy</refentrytitle>
@ -6,7 +5,7 @@
</refmeta>
<refnamediv>
<refname>cairo_destroy</refname>
<refpurpose>some description</refpurpose>
<refpurpose>free a <link linkend="cairo_t">cairo_t</link></refpurpose>
</refnamediv>
<refsynopsisdiv>
<programlisting>
@ -15,7 +14,7 @@ void cairo_destroy (<link linkend="cairo_t">cairo_t</link> *cr)</programlisting>
<varlistentry>
<term><parameter>cr</parameter> :</term>
<listitem>
<simpara>description</simpara>
<simpara>a <link linkend="cairo_t">cairo_t</link></simpara>
</listitem>
</varlistentry>
</variablelist>
@ -30,6 +29,10 @@ void cairo_destroy (<link linkend="cairo_t">cairo_t</link> *cr)</programlisting>
<indexterm>
<primary/>
</indexterm>
Decreases the reference of a a <link linkend="cairo_t">cairo_t</link>. If the refcount drops to zero, all associated resources will be freed.
</para>
<para>
Saved states on the stack which were not restored with <link linkend="cairo_restore">cairo_restore</link> will be destroyed, too.
</para>
</refsect1>
</refentry>

2
doc/reference/xml/cairo_in_fill.xml
View file

@ -15,7 +15,7 @@
<funcsynopsisinfo>
</funcsynopsisinfo>
<funcprototype>
<funcdef>void <function>cairo_in_fill</function></funcdef><paramdef>cairo_t <parameter>*cr</parameter></paramdef>
<funcdef>void <function>cairo_in_fill</function></funcdef><paramdef><link linkend="cairo_t">cairo_t</link> <parameter>*cr</parameter></paramdef>
<paramdef>double <parameter>x</parameter></paramdef>
<paramdef>double <parameter>y</parameter></paramdef>
</funcprototype>

2
doc/reference/xml/cairo_in_stroke.xml
View file

@ -15,7 +15,7 @@
<funcsynopsisinfo>
</funcsynopsisinfo>
<funcprototype>
<funcdef>void <function>cairo_in_stroke</function></funcdef><paramdef>cairo_t <parameter>*cr</parameter></paramdef>
<funcdef>void <function>cairo_in_stroke</function></funcdef><paramdef><link linkend="cairo_t">cairo_t</link> <parameter>*cr</parameter></paramdef>
<paramdef>double <parameter>x</parameter></paramdef>
<paramdef>double <parameter>y</parameter></paramdef>
</funcprototype>

6
doc/reference/xml/cairo_reference.xml
View file

@ -1,4 +1,3 @@
<refentry id="cairo_reference">
<refmeta>
<refentrytitle>cairo_reference</refentrytitle>
@ -6,7 +5,7 @@
</refmeta>
<refnamediv>
<refname>cairo_reference</refname>
<refpurpose>some description</refpurpose>
<refpurpose>increase reference count of <link linkend="cairo_t">cairo_t</link></refpurpose>
</refnamediv>
<refsynopsisdiv>
<programlisting>
@ -15,7 +14,7 @@ void cairo_reference (<link linkend="cairo_t">cairo_t</link> *cr)</programlistin
<varlistentry>
<term><parameter>cr</parameter> :</term>
<listitem>
<simpara>description</simpara>
<simpara>a <link linkend="cairo_t">cairo_t</link></simpara>
</listitem>
</varlistentry>
</variablelist>
@ -30,6 +29,7 @@ void cairo_reference (<link linkend="cairo_t">cairo_t</link> *cr)</programlistin
<indexterm>
<primary/>
</indexterm>
When calling <function>cairo_reference</function> the reference count will be increased by one and the caller becomes owner of the <link linkend="cairo_t">cairo_t</link>. When the creator of the <link linkend="cairo_t">cairo_t</link> destroys the the object via <link linkend="cairo_destroy">cairo_destroy</link> the refcount will be decreased but the object will stay valid, since you are still owner of the object.
</para>
</refsect1>
</refentry>

3
doc/reference/xml/cairo_restore.xml
View file

@ -6,7 +6,7 @@
</refmeta>
<refnamediv>
<refname>cairo_restore</refname>
<refpurpose>some description</refpurpose>
<refpurpose>restore a saved state</refpurpose>
</refnamediv>
<refsynopsisdiv>
<programlisting>
@ -30,6 +30,7 @@ void cairo_restore (<link linkend="cairo_t">cairo_t</link> *cr)</programlisting>
<indexterm>
<primary/>
</indexterm>
This fucntion is the counterpart to <link linkend="cairo_save">cairo_save</link>. A saved state can be restored with cairo_restore.
</para>
</refsect1>
</refentry>

5
doc/reference/xml/cairo_save.xml
View file

@ -6,7 +6,7 @@
</refmeta>
<refnamediv>
<refname>cairo_save</refname>
<refpurpose>some description</refpurpose>
<refpurpose>save current state</refpurpose>
</refnamediv>
<refsynopsisdiv>
<programlisting>
@ -15,7 +15,7 @@ void cairo_save (<link linkend="cairo_t">cairo_t</link> *cr)</programlisting>
<varlistentry>
<term><parameter>cr</parameter> :</term>
<listitem>
<simpara>description</simpara>
<simpara>a <link linkend="cairo_t">cairo_t</link></simpara>
</listitem>
</varlistentry>
</variablelist>
@ -30,6 +30,7 @@ void cairo_save (<link linkend="cairo_t">cairo_t</link> *cr)</programlisting>
<indexterm>
<primary/>
</indexterm>
This function stores the complete state of a <link linkend="cairo_t">cairo_t</link>. It may then be changed in any way. The saved state can then be restored with <link linkend="cairo_restore">cairo_restore</link>. Calls to cairo_save may be nested to an arbitraty depth.
</para>
</refsect1>
</refentry>

7
doc/reference/xml/cairo_set_target_surface.xml
View file

@ -5,7 +5,7 @@
</refmeta>
<refnamediv>
<refname>cairo_set_target_surface</refname>
<refpurpose>some description</refpurpose>
<refpurpose>set surface for painting operations </refpurpose>
</refnamediv>
<refsynopsisdiv>
<programlisting>
@ -14,13 +14,13 @@ void cairo_set_target_surface (<link linkend="cairo_t">cairo_t</link> *cr, <link
<varlistentry>
<term><parameter>cr</parameter> :</term>
<listitem>
<simpara>description</simpara>
<simpara>a <link linkend="cairo_t">cairo_t</link></simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>surface</parameter> :</term>
<listitem>
<simpara>description</simpara>
<simpara>an allocated <link linkend="cairo_surface_t">cairo_surface_t</link></simpara>
</listitem>
</varlistentry>
</variablelist>
@ -35,6 +35,7 @@ void cairo_set_target_surface (<link linkend="cairo_t">cairo_t</link> *cr, <link
<indexterm>
<primary/>
</indexterm>
Selects <varname>surfacee</varname> as the surface to draw on. If there already is a surface set, it will be substituted by <varname>surface</varname>. It references <varname>surface</varname>e to ensure that it will be calid at least until another surface was selected or the <link linkend="cairo_t">cairo_t</link> is destroyed.
</para>
</refsect1>
</refentry>

6
doc/reference/xml/skeleton.xml
View file

@ -1,7 +1,7 @@
<refentry id="##function##">
<refnamediv>
<refname>##function##</refname>
<refname><link linkend="##function##">##function##</link></refname>
<refpurpose></refpurpose>
</refnamediv>
@ -11,7 +11,7 @@
#include &lt;cairo.h&gt;
</funcsynopsisinfo>
<funcprototype>
<funcdef>cairo_t *<function>##function##</function></funcdef>
<funcdef><link linkend="cairo_t">cairo_t</link> *<function><link linkend="##function##">##function##</link></function></funcdef>
<paramdef>
</paramdef>
</funcprototype>
@ -24,7 +24,7 @@
<secondary></secondary></indexterm>
<indexterm><primary></primary></indexterm>
<function>##function##</function>
<function><link linkend="##function##">##function##</link></function>
</para>
</refsect1>
</refentry>