summaryrefslogtreecommitdiff
path: root/doc/public/xml/cairo-xlib.xml
diff options
context:
space:
mode:
authorSebastian Dröge <sebastian.droege@collabora.co.uk>2010-06-14 09:17:41 +0200
committerSebastian Dröge <sebastian.droege@collabora.co.uk>2010-06-14 09:17:41 +0200
commit728b3091c142e918935200adcd4facfec7ccd515 (patch)
treee7375cef54ef817fc3f310c2c27136d2edb104aa /doc/public/xml/cairo-xlib.xml
parent6af97522e5d98cd4618838be94635cf3d4559cb3 (diff)
Import upstream version 1.9.8
Diffstat (limited to 'doc/public/xml/cairo-xlib.xml')
-rw-r--r--doc/public/xml/cairo-xlib.xml224
1 files changed, 109 insertions, 115 deletions
diff --git a/doc/public/xml/cairo-xlib.xml b/doc/public/xml/cairo-xlib.xml
index 25a9552..472cfe1 100644
--- a/doc/public/xml/cairo-xlib.xml
+++ b/doc/public/xml/cairo-xlib.xml
@@ -7,9 +7,10 @@
<refmeta>
<refentrytitle role="top_of_page" id="cairo-xlib-surface.top_of_page">XLib Surfaces</refentrytitle>
<manvolnum>3</manvolnum>
-<refmiscinfo>CAIRO Library</refmiscinfo>
+<refmiscinfo>
+ CAIRO Library
+</refmiscinfo>
</refmeta>
-
<refnamediv>
<refname>XLib Surfaces</refname>
<refpurpose>X Window System rendering using XLib</refpurpose>
@@ -18,44 +19,35 @@
<refsynopsisdiv id="cairo-xlib-surface.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
-<synopsis>
-#define <link linkend="CAIRO-HAS-XLIB-SURFACE--CAPS">CAIRO_HAS_XLIB_SURFACE</link>
-<link linkend="cairo-surface-t">cairo_surface_t</link> * <link linkend="cairo-xlib-surface-create">cairo_xlib_surface_create</link> (<link linkend="Display">Display</link> *dpy,
- <link linkend="Drawable">Drawable</link> drawable,
- <link linkend="Visual">Visual</link> *visual,
- <link linkend="int">int</link> width,
- <link linkend="int">int</link> height);
-<link linkend="cairo-surface-t">cairo_surface_t</link> * <link linkend="cairo-xlib-surface-create-for-bitmap">cairo_xlib_surface_create_for_bitmap</link>
- (<link linkend="Display">Display</link> *dpy,
- <link linkend="Pixmap">Pixmap</link> bitmap,
- <link linkend="Screen">Screen</link> *screen,
- <link linkend="int">int</link> width,
- <link linkend="int">int</link> height);
-<link linkend="void">void</link> <link linkend="cairo-xlib-surface-set-size">cairo_xlib_surface_set_size</link> (<link linkend="cairo-surface-t">cairo_surface_t</link> *surface,
- <link linkend="int">int</link> width,
- <link linkend="int">int</link> height);
-<link linkend="Display">Display</link> * <link linkend="cairo-xlib-surface-get-display">cairo_xlib_surface_get_display</link> (<link linkend="cairo-surface-t">cairo_surface_t</link> *surface);
-<link linkend="Screen">Screen</link> * <link linkend="cairo-xlib-surface-get-screen">cairo_xlib_surface_get_screen</link> (<link linkend="cairo-surface-t">cairo_surface_t</link> *surface);
-<link linkend="void">void</link> <link linkend="cairo-xlib-surface-set-drawable">cairo_xlib_surface_set_drawable</link> (<link linkend="cairo-surface-t">cairo_surface_t</link> *surface,
- <link linkend="Drawable">Drawable</link> drawable,
- <link linkend="int">int</link> width,
- <link linkend="int">int</link> height);
-<link linkend="Drawable">Drawable</link> <link linkend="cairo-xlib-surface-get-drawable">cairo_xlib_surface_get_drawable</link> (<link linkend="cairo-surface-t">cairo_surface_t</link> *surface);
-<link linkend="Visual">Visual</link> * <link linkend="cairo-xlib-surface-get-visual">cairo_xlib_surface_get_visual</link> (<link linkend="cairo-surface-t">cairo_surface_t</link> *surface);
-<link linkend="int">int</link> <link linkend="cairo-xlib-surface-get-width">cairo_xlib_surface_get_width</link> (<link linkend="cairo-surface-t">cairo_surface_t</link> *surface);
-<link linkend="int">int</link> <link linkend="cairo-xlib-surface-get-height">cairo_xlib_surface_get_height</link> (<link linkend="cairo-surface-t">cairo_surface_t</link> *surface);
-<link linkend="int">int</link> <link linkend="cairo-xlib-surface-get-depth">cairo_xlib_surface_get_depth</link> (<link linkend="cairo-surface-t">cairo_surface_t</link> *surface);
+<synopsis>#define <link linkend="CAIRO-HAS-XLIB-SURFACE:CAPS">CAIRO_HAS_XLIB_SURFACE</link>
+<link linkend="cairo-surface-t"><returnvalue>cairo_surface_t</returnvalue></link> * <link linkend="cairo-xlib-surface-create">cairo_xlib_surface_create</link> (<parameter><link linkend="Display"><type>Display</type></link> *dpy</parameter>,
+ <parameter><link linkend="Drawable"><type>Drawable</type></link> drawable</parameter>,
+ <parameter><link linkend="Visual"><type>Visual</type></link> *visual</parameter>,
+ <parameter><link linkend="int"><type>int</type></link> width</parameter>,
+ <parameter><link linkend="int"><type>int</type></link> height</parameter>);
+<link linkend="cairo-surface-t"><returnvalue>cairo_surface_t</returnvalue></link> * <link linkend="cairo-xlib-surface-create-for-bitmap">cairo_xlib_surface_create_for_bitmap</link>
+ (<parameter><link linkend="Display"><type>Display</type></link> *dpy</parameter>,
+ <parameter><link linkend="Pixmap"><type>Pixmap</type></link> bitmap</parameter>,
+ <parameter><link linkend="Screen"><type>Screen</type></link> *screen</parameter>,
+ <parameter><link linkend="int"><type>int</type></link> width</parameter>,
+ <parameter><link linkend="int"><type>int</type></link> height</parameter>);
+<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="cairo-xlib-surface-set-size">cairo_xlib_surface_set_size</link> (<parameter><link linkend="cairo-surface-t"><type>cairo_surface_t</type></link> *surface</parameter>,
+ <parameter><link linkend="int"><type>int</type></link> width</parameter>,
+ <parameter><link linkend="int"><type>int</type></link> height</parameter>);
+<link linkend="Display"><returnvalue>Display</returnvalue></link> * <link linkend="cairo-xlib-surface-get-display">cairo_xlib_surface_get_display</link> (<parameter><link linkend="cairo-surface-t"><type>cairo_surface_t</type></link> *surface</parameter>);
+<link linkend="Screen"><returnvalue>Screen</returnvalue></link> * <link linkend="cairo-xlib-surface-get-screen">cairo_xlib_surface_get_screen</link> (<parameter><link linkend="cairo-surface-t"><type>cairo_surface_t</type></link> *surface</parameter>);
+<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="cairo-xlib-surface-set-drawable">cairo_xlib_surface_set_drawable</link> (<parameter><link linkend="cairo-surface-t"><type>cairo_surface_t</type></link> *surface</parameter>,
+ <parameter><link linkend="Drawable"><type>Drawable</type></link> drawable</parameter>,
+ <parameter><link linkend="int"><type>int</type></link> width</parameter>,
+ <parameter><link linkend="int"><type>int</type></link> height</parameter>);
+<link linkend="Drawable"><returnvalue>Drawable</returnvalue></link> <link linkend="cairo-xlib-surface-get-drawable">cairo_xlib_surface_get_drawable</link> (<parameter><link linkend="cairo-surface-t"><type>cairo_surface_t</type></link> *surface</parameter>);
+<link linkend="Visual"><returnvalue>Visual</returnvalue></link> * <link linkend="cairo-xlib-surface-get-visual">cairo_xlib_surface_get_visual</link> (<parameter><link linkend="cairo-surface-t"><type>cairo_surface_t</type></link> *surface</parameter>);
+<link linkend="int"><returnvalue>int</returnvalue></link> <link linkend="cairo-xlib-surface-get-width">cairo_xlib_surface_get_width</link> (<parameter><link linkend="cairo-surface-t"><type>cairo_surface_t</type></link> *surface</parameter>);
+<link linkend="int"><returnvalue>int</returnvalue></link> <link linkend="cairo-xlib-surface-get-height">cairo_xlib_surface_get_height</link> (<parameter><link linkend="cairo-surface-t"><type>cairo_surface_t</type></link> *surface</parameter>);
+<link linkend="int"><returnvalue>int</returnvalue></link> <link linkend="cairo-xlib-surface-get-depth">cairo_xlib_surface_get_depth</link> (<parameter><link linkend="cairo-surface-t"><type>cairo_surface_t</type></link> *surface</parameter>);
</synopsis>
</refsynopsisdiv>
-
-
-
-
-
-
-
-
<refsect1 id="cairo-xlib-surface.description" role="desc">
<title role="desc.title">Description</title>
<para>
@@ -67,23 +59,25 @@ Note that the XLib surface automatically takes advantage of X render extension
if it is available.
</para>
</refsect1>
-
<refsect1 id="cairo-xlib-surface.details" role="details">
<title role="details.title">Details</title>
-<refsect2 id="CAIRO-HAS-XLIB-SURFACE--CAPS" role="macro">
+<refsect2 id="CAIRO-HAS-XLIB-SURFACE:CAPS" role="macro">
<title>CAIRO_HAS_XLIB_SURFACE</title>
-<indexterm zone="CAIRO-HAS-XLIB-SURFACE--CAPS"><primary sortas="CAIRO_HAS_XLIB_SURFACE">CAIRO_HAS_XLIB_SURFACE</primary></indexterm><programlisting>#define CAIRO_HAS_XLIB_SURFACE</programlisting>
+<indexterm zone="CAIRO-HAS-XLIB-SURFACE:CAPS"><primary>CAIRO_HAS_XLIB_SURFACE</primary></indexterm>
+<programlisting>#define CAIRO_HAS_XLIB_SURFACE 1
+</programlisting>
<para>
Defined if the Xlib surface backend is available.
This macro can be used to conditionally compile backend-specific code.
</para></refsect2>
<refsect2 id="cairo-xlib-surface-create" role="function">
<title>cairo_xlib_surface_create ()</title>
-<indexterm zone="cairo-xlib-surface-create"><primary sortas="cairo_xlib_surface_create">cairo_xlib_surface_create</primary></indexterm><programlisting><link linkend="cairo-surface-t">cairo_surface_t</link> * cairo_xlib_surface_create (<link linkend="Display">Display</link> *dpy,
- <link linkend="Drawable">Drawable</link> drawable,
- <link linkend="Visual">Visual</link> *visual,
- <link linkend="int">int</link> width,
- <link linkend="int">int</link> height);</programlisting>
+<indexterm zone="cairo-xlib-surface-create"><primary>cairo_xlib_surface_create</primary></indexterm>
+<programlisting><link linkend="cairo-surface-t"><returnvalue>cairo_surface_t</returnvalue></link> * cairo_xlib_surface_create (<parameter><link linkend="Display"><type>Display</type></link> *dpy</parameter>,
+ <parameter><link linkend="Drawable"><type>Drawable</type></link> drawable</parameter>,
+ <parameter><link linkend="Visual"><type>Visual</type></link> *visual</parameter>,
+ <parameter><link linkend="int"><type>int</type></link> width</parameter>,
+ <parameter><link linkend="int"><type>int</type></link> height</parameter>);</programlisting>
<para>
Creates an Xlib surface that draws to the given drawable.
The way that colors are represented in the drawable is specified
@@ -98,65 +92,65 @@ window changes.
When <parameter>drawable</parameter> is a Window containing child windows then drawing to
the created surface will be clipped by those child windows. When
the created surface is used as a source, the contents of the
-children will be included.</para>
-<para>
+children will be included.
</para><variablelist role="params">
<varlistentry><term><parameter>dpy</parameter>&#160;:</term>
-<listitem><simpara> an X Display
+<listitem><simpara>an X Display
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>drawable</parameter>&#160;:</term>
-<listitem><simpara> an X Drawable, (a Pixmap or a Window)
+<listitem><simpara>an X Drawable, (a Pixmap or a Window)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>visual</parameter>&#160;:</term>
-<listitem><simpara> the visual to use for drawing to <parameter>drawable</parameter>. The depth
+<listitem><simpara>the visual to use for drawing to <parameter>drawable</parameter>. The depth
of the visual must match the depth of the drawable.
Currently, only TrueColor visuals are fully supported.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&#160;:</term>
-<listitem><simpara> the current width of <parameter>drawable</parameter>.
+<listitem><simpara>the current width of <parameter>drawable</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&#160;:</term>
-<listitem><simpara> the current height of <parameter>drawable</parameter>.
+<listitem><simpara>the current height of <parameter>drawable</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the newly created surface
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="cairo-xlib-surface-create-for-bitmap" role="function">
<title>cairo_xlib_surface_create_for_bitmap ()</title>
-<indexterm zone="cairo-xlib-surface-create-for-bitmap"><primary sortas="cairo_xlib_surface_create_for_bitmap">cairo_xlib_surface_create_for_bitmap</primary></indexterm><programlisting><link linkend="cairo-surface-t">cairo_surface_t</link> * cairo_xlib_surface_create_for_bitmap
- (<link linkend="Display">Display</link> *dpy,
- <link linkend="Pixmap">Pixmap</link> bitmap,
- <link linkend="Screen">Screen</link> *screen,
- <link linkend="int">int</link> width,
- <link linkend="int">int</link> height);</programlisting>
+<indexterm zone="cairo-xlib-surface-create-for-bitmap"><primary>cairo_xlib_surface_create_for_bitmap</primary></indexterm>
+<programlisting><link linkend="cairo-surface-t"><returnvalue>cairo_surface_t</returnvalue></link> * cairo_xlib_surface_create_for_bitmap
+ (<parameter><link linkend="Display"><type>Display</type></link> *dpy</parameter>,
+ <parameter><link linkend="Pixmap"><type>Pixmap</type></link> bitmap</parameter>,
+ <parameter><link linkend="Screen"><type>Screen</type></link> *screen</parameter>,
+ <parameter><link linkend="int"><type>int</type></link> width</parameter>,
+ <parameter><link linkend="int"><type>int</type></link> height</parameter>);</programlisting>
<para>
Creates an Xlib surface that draws to the given bitmap.
-This will be drawn to as a <link linkend="CAIRO-FORMAT-A1--CAPS"><literal>CAIRO_FORMAT_A1</literal></link> object.</para>
-<para>
+This will be drawn to as a <link linkend="CAIRO-FORMAT-A1:CAPS"><literal>CAIRO_FORMAT_A1</literal></link> object.
</para><variablelist role="params">
<varlistentry><term><parameter>dpy</parameter>&#160;:</term>
-<listitem><simpara> an X Display
+<listitem><simpara>an X Display
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>bitmap</parameter>&#160;:</term>
-<listitem><simpara> an X Drawable, (a depth-1 Pixmap)
+<listitem><simpara>an X Drawable, (a depth-1 Pixmap)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>screen</parameter>&#160;:</term>
-<listitem><simpara> the X Screen associated with <parameter>bitmap</parameter>
+<listitem><simpara>the X Screen associated with <parameter>bitmap</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&#160;:</term>
-<listitem><simpara> the current width of <parameter>bitmap</parameter>.
+<listitem><simpara>the current width of <parameter>bitmap</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&#160;:</term>
-<listitem><simpara> the current height of <parameter>bitmap</parameter>.
+<listitem><simpara>the current height of <parameter>bitmap</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the newly created surface
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="cairo-xlib-surface-set-size" role="function">
<title>cairo_xlib_surface_set_size ()</title>
-<indexterm zone="cairo-xlib-surface-set-size"><primary sortas="cairo_xlib_surface_set_size">cairo_xlib_surface_set_size</primary></indexterm><programlisting><link linkend="void">void</link> cairo_xlib_surface_set_size (<link linkend="cairo-surface-t">cairo_surface_t</link> *surface,
- <link linkend="int">int</link> width,
- <link linkend="int">int</link> height);</programlisting>
+<indexterm zone="cairo-xlib-surface-set-size"><primary>cairo_xlib_surface_set_size</primary></indexterm>
+<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> cairo_xlib_surface_set_size (<parameter><link linkend="cairo-surface-t"><type>cairo_surface_t</type></link> *surface</parameter>,
+ <parameter><link linkend="int"><type>int</type></link> width</parameter>,
+ <parameter><link linkend="int"><type>int</type></link> height</parameter>);</programlisting>
<para>
Informs cairo of the new size of the X Drawable underlying the
surface. For a surface created for a Window (rather than a Pixmap),
@@ -167,28 +161,27 @@ ConfigureNotify events.)
</para>
<para>
A Pixmap can never change size, so it is never necessary to call
-this function on a surface created for a Pixmap.</para>
-<para>
+this function on a surface created for a Pixmap.
</para><variablelist role="params">
<varlistentry><term><parameter>surface</parameter>&#160;:</term>
-<listitem><simpara> a <link linkend="cairo-surface-t"><type>cairo_surface_t</type></link> for the XLib backend
+<listitem><simpara>a <link linkend="cairo-surface-t"><type>cairo_surface_t</type></link> for the XLib backend
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&#160;:</term>
-<listitem><simpara> the new width of the surface
+<listitem><simpara>the new width of the surface
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&#160;:</term>
-<listitem><simpara> the new height of the surface
+<listitem><simpara>the new height of the surface
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="cairo-xlib-surface-get-display" role="function" condition="since:1.2">
<title>cairo_xlib_surface_get_display ()</title>
-<indexterm zone="cairo-xlib-surface-get-display" role="1.2"><primary sortas="cairo_xlib_surface_get_display">cairo_xlib_surface_get_display</primary></indexterm><programlisting><link linkend="Display">Display</link> * cairo_xlib_surface_get_display (<link linkend="cairo-surface-t">cairo_surface_t</link> *surface);</programlisting>
-<para>
-Get the X Display for the underlying X Drawable.</para>
+<indexterm zone="cairo-xlib-surface-get-display" role="1.2"><primary>cairo_xlib_surface_get_display</primary></indexterm>
+<programlisting><link linkend="Display"><returnvalue>Display</returnvalue></link> * cairo_xlib_surface_get_display (<parameter><link linkend="cairo-surface-t"><type>cairo_surface_t</type></link> *surface</parameter>);</programlisting>
<para>
+Get the X Display for the underlying X Drawable.
</para><variablelist role="params">
<varlistentry><term><parameter>surface</parameter>&#160;:</term>
-<listitem><simpara> a <link linkend="cairo-xlib-surface-t"><type>cairo_xlib_surface_t</type></link>
+<listitem><simpara>a <link linkend="cairo-xlib-surface-t"><type>cairo_xlib_surface_t</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the display.
@@ -196,13 +189,13 @@ Get the X Display for the underlying X Drawable.</para>
</variablelist><para role="since">Since 1.2</para></refsect2>
<refsect2 id="cairo-xlib-surface-get-screen" role="function" condition="since:1.2">
<title>cairo_xlib_surface_get_screen ()</title>
-<indexterm zone="cairo-xlib-surface-get-screen" role="1.2"><primary sortas="cairo_xlib_surface_get_screen">cairo_xlib_surface_get_screen</primary></indexterm><programlisting><link linkend="Screen">Screen</link> * cairo_xlib_surface_get_screen (<link linkend="cairo-surface-t">cairo_surface_t</link> *surface);</programlisting>
-<para>
-Get the X Screen for the underlying X Drawable.</para>
+<indexterm zone="cairo-xlib-surface-get-screen" role="1.2"><primary>cairo_xlib_surface_get_screen</primary></indexterm>
+<programlisting><link linkend="Screen"><returnvalue>Screen</returnvalue></link> * cairo_xlib_surface_get_screen (<parameter><link linkend="cairo-surface-t"><type>cairo_surface_t</type></link> *surface</parameter>);</programlisting>
<para>
+Get the X Screen for the underlying X Drawable.
</para><variablelist role="params">
<varlistentry><term><parameter>surface</parameter>&#160;:</term>
-<listitem><simpara> a <link linkend="cairo-xlib-surface-t"><type>cairo_xlib_surface_t</type></link>
+<listitem><simpara>a <link linkend="cairo-xlib-surface-t"><type>cairo_xlib_surface_t</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the screen.
@@ -210,41 +203,41 @@ Get the X Screen for the underlying X Drawable.</para>
</variablelist><para role="since">Since 1.2</para></refsect2>
<refsect2 id="cairo-xlib-surface-set-drawable" role="function">
<title>cairo_xlib_surface_set_drawable ()</title>
-<indexterm zone="cairo-xlib-surface-set-drawable"><primary sortas="cairo_xlib_surface_set_drawable">cairo_xlib_surface_set_drawable</primary></indexterm><programlisting><link linkend="void">void</link> cairo_xlib_surface_set_drawable (<link linkend="cairo-surface-t">cairo_surface_t</link> *surface,
- <link linkend="Drawable">Drawable</link> drawable,
- <link linkend="int">int</link> width,
- <link linkend="int">int</link> height);</programlisting>
+<indexterm zone="cairo-xlib-surface-set-drawable"><primary>cairo_xlib_surface_set_drawable</primary></indexterm>
+<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> cairo_xlib_surface_set_drawable (<parameter><link linkend="cairo-surface-t"><type>cairo_surface_t</type></link> *surface</parameter>,
+ <parameter><link linkend="Drawable"><type>Drawable</type></link> drawable</parameter>,
+ <parameter><link linkend="int"><type>int</type></link> width</parameter>,
+ <parameter><link linkend="int"><type>int</type></link> height</parameter>);</programlisting>
<para>
Informs cairo of a new X Drawable underlying the
surface. The drawable must match the display, screen
and format of the existing drawable or the application
will get X protocol errors and will probably terminate.
No checks are done by this function to ensure this
-compatibility.</para>
-<para>
+compatibility.
</para><variablelist role="params">
<varlistentry><term><parameter>surface</parameter>&#160;:</term>
-<listitem><simpara> a <link linkend="cairo-surface-t"><type>cairo_surface_t</type></link> for the XLib backend
+<listitem><simpara>a <link linkend="cairo-surface-t"><type>cairo_surface_t</type></link> for the XLib backend
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>drawable</parameter>&#160;:</term>
-<listitem><simpara> the new drawable for the surface
+<listitem><simpara>the new drawable for the surface
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&#160;:</term>
-<listitem><simpara> the width of the new drawable
+<listitem><simpara>the width of the new drawable
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&#160;:</term>
-<listitem><simpara> the height of the new drawable
+<listitem><simpara>the height of the new drawable
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="cairo-xlib-surface-get-drawable" role="function" condition="since:1.2">
<title>cairo_xlib_surface_get_drawable ()</title>
-<indexterm zone="cairo-xlib-surface-get-drawable" role="1.2"><primary sortas="cairo_xlib_surface_get_drawable">cairo_xlib_surface_get_drawable</primary></indexterm><programlisting><link linkend="Drawable">Drawable</link> cairo_xlib_surface_get_drawable (<link linkend="cairo-surface-t">cairo_surface_t</link> *surface);</programlisting>
-<para>
-Get the underlying X Drawable used for the surface.</para>
+<indexterm zone="cairo-xlib-surface-get-drawable" role="1.2"><primary>cairo_xlib_surface_get_drawable</primary></indexterm>
+<programlisting><link linkend="Drawable"><returnvalue>Drawable</returnvalue></link> cairo_xlib_surface_get_drawable (<parameter><link linkend="cairo-surface-t"><type>cairo_surface_t</type></link> *surface</parameter>);</programlisting>
<para>
+Get the underlying X Drawable used for the surface.
</para><variablelist role="params">
<varlistentry><term><parameter>surface</parameter>&#160;:</term>
-<listitem><simpara> a <link linkend="cairo-xlib-surface-t"><type>cairo_xlib_surface_t</type></link>
+<listitem><simpara>a <link linkend="cairo-xlib-surface-t"><type>cairo_xlib_surface_t</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the drawable.
@@ -252,27 +245,31 @@ Get the underlying X Drawable used for the surface.</para>
</variablelist><para role="since">Since 1.2</para></refsect2>
<refsect2 id="cairo-xlib-surface-get-visual" role="function" condition="since:1.2">
<title>cairo_xlib_surface_get_visual ()</title>
-<indexterm zone="cairo-xlib-surface-get-visual" role="1.2"><primary sortas="cairo_xlib_surface_get_visual">cairo_xlib_surface_get_visual</primary></indexterm><programlisting><link linkend="Visual">Visual</link> * cairo_xlib_surface_get_visual (<link linkend="cairo-surface-t">cairo_surface_t</link> *surface);</programlisting>
-<para>
-Get the X Visual used for underlying X Drawable.</para>
+<indexterm zone="cairo-xlib-surface-get-visual" role="1.2"><primary>cairo_xlib_surface_get_visual</primary></indexterm>
+<programlisting><link linkend="Visual"><returnvalue>Visual</returnvalue></link> * cairo_xlib_surface_get_visual (<parameter><link linkend="cairo-surface-t"><type>cairo_surface_t</type></link> *surface</parameter>);</programlisting>
<para>
+Gets the X Visual associated with <parameter>surface</parameter>, suitable for use with the
+underlying X Drawable. If <parameter>surface</parameter> was created by
+<link linkend="cairo-xlib-surface-create"><function>cairo_xlib_surface_create()</function></link>, the return value is the Visual passed to that
+constructor.
</para><variablelist role="params">
<varlistentry><term><parameter>surface</parameter>&#160;:</term>
-<listitem><simpara> a <link linkend="cairo-xlib-surface-t"><type>cairo_xlib_surface_t</type></link>
+<listitem><simpara>a <link linkend="cairo-xlib-surface-t"><type>cairo_xlib_surface_t</type></link>
</simpara></listitem></varlistentry>
-<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the visual.
+<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the Visual or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if there is no appropriate Visual for
+<parameter>surface</parameter>.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 1.2</para></refsect2>
<refsect2 id="cairo-xlib-surface-get-width" role="function" condition="since:1.2">
<title>cairo_xlib_surface_get_width ()</title>
-<indexterm zone="cairo-xlib-surface-get-width" role="1.2"><primary sortas="cairo_xlib_surface_get_width">cairo_xlib_surface_get_width</primary></indexterm><programlisting><link linkend="int">int</link> cairo_xlib_surface_get_width (<link linkend="cairo-surface-t">cairo_surface_t</link> *surface);</programlisting>
-<para>
-Get the width of the X Drawable underlying the surface in pixels.</para>
+<indexterm zone="cairo-xlib-surface-get-width" role="1.2"><primary>cairo_xlib_surface_get_width</primary></indexterm>
+<programlisting><link linkend="int"><returnvalue>int</returnvalue></link> cairo_xlib_surface_get_width (<parameter><link linkend="cairo-surface-t"><type>cairo_surface_t</type></link> *surface</parameter>);</programlisting>
<para>
+Get the width of the X Drawable underlying the surface in pixels.
</para><variablelist role="params">
<varlistentry><term><parameter>surface</parameter>&#160;:</term>
-<listitem><simpara> a <link linkend="cairo-xlib-surface-t"><type>cairo_xlib_surface_t</type></link>
+<listitem><simpara>a <link linkend="cairo-xlib-surface-t"><type>cairo_xlib_surface_t</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the width of the surface in pixels.
@@ -280,13 +277,13 @@ Get the width of the X Drawable underlying the surface in pixels.</para>
</variablelist><para role="since">Since 1.2</para></refsect2>
<refsect2 id="cairo-xlib-surface-get-height" role="function" condition="since:1.2">
<title>cairo_xlib_surface_get_height ()</title>
-<indexterm zone="cairo-xlib-surface-get-height" role="1.2"><primary sortas="cairo_xlib_surface_get_height">cairo_xlib_surface_get_height</primary></indexterm><programlisting><link linkend="int">int</link> cairo_xlib_surface_get_height (<link linkend="cairo-surface-t">cairo_surface_t</link> *surface);</programlisting>
-<para>
-Get the height of the X Drawable underlying the surface in pixels.</para>
+<indexterm zone="cairo-xlib-surface-get-height" role="1.2"><primary>cairo_xlib_surface_get_height</primary></indexterm>
+<programlisting><link linkend="int"><returnvalue>int</returnvalue></link> cairo_xlib_surface_get_height (<parameter><link linkend="cairo-surface-t"><type>cairo_surface_t</type></link> *surface</parameter>);</programlisting>
<para>
+Get the height of the X Drawable underlying the surface in pixels.
</para><variablelist role="params">
<varlistentry><term><parameter>surface</parameter>&#160;:</term>
-<listitem><simpara> a <link linkend="cairo-xlib-surface-t"><type>cairo_xlib_surface_t</type></link>
+<listitem><simpara>a <link linkend="cairo-xlib-surface-t"><type>cairo_xlib_surface_t</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the height of the surface in pixels.
@@ -294,13 +291,13 @@ Get the height of the X Drawable underlying the surface in pixels.</para>
</variablelist><para role="since">Since 1.2</para></refsect2>
<refsect2 id="cairo-xlib-surface-get-depth" role="function" condition="since:1.2">
<title>cairo_xlib_surface_get_depth ()</title>
-<indexterm zone="cairo-xlib-surface-get-depth" role="1.2"><primary sortas="cairo_xlib_surface_get_depth">cairo_xlib_surface_get_depth</primary></indexterm><programlisting><link linkend="int">int</link> cairo_xlib_surface_get_depth (<link linkend="cairo-surface-t">cairo_surface_t</link> *surface);</programlisting>
-<para>
-Get the number of bits used to represent each pixel value.</para>
+<indexterm zone="cairo-xlib-surface-get-depth" role="1.2"><primary>cairo_xlib_surface_get_depth</primary></indexterm>
+<programlisting><link linkend="int"><returnvalue>int</returnvalue></link> cairo_xlib_surface_get_depth (<parameter><link linkend="cairo-surface-t"><type>cairo_surface_t</type></link> *surface</parameter>);</programlisting>
<para>
+Get the number of bits used to represent each pixel value.
</para><variablelist role="params">
<varlistentry><term><parameter>surface</parameter>&#160;:</term>
-<listitem><simpara> a <link linkend="cairo-xlib-surface-t"><type>cairo_xlib_surface_t</type></link>
+<listitem><simpara>a <link linkend="cairo-xlib-surface-t"><type>cairo_xlib_surface_t</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the depth of the surface in bits.
@@ -308,9 +305,6 @@ Get the number of bits used to represent each pixel value.</para>
</variablelist><para role="since">Since 1.2</para></refsect2>
</refsect1>
-
-
-
<refsect1 id="cairo-xlib-surface.see-also">
<title>See Also</title>
<para>