[cairo-commit] cairo/doc/reference/xml cairo_set_target_drawable.xml,NONE,1.1 cairo_set_target_png.xml,NONE,1.1 cairo_set_target_ps.xml,NONE,1.1 cairo_set_target_xcb.xml,NONE,1.1 cairo_text_extents.xml,NONE,1.1 cairo_text_extents_t.xml,NONE,1.1 cairo_set_target_surface.xml,1.4,1.5

Thomas Hunger commit at pdx.freedesktop.org
Mon Aug 15 11:12:59 PDT 2005


Committed by: tom

Update of /cvs/cairo/cairo/doc/reference/xml
In directory pdx:/tmp/cvs-serv27509/xml

Modified Files:
	cairo_set_target_surface.xml 
Added Files:
	cairo_set_target_drawable.xml cairo_set_target_png.xml 
	cairo_set_target_ps.xml cairo_set_target_xcb.xml 
	cairo_text_extents.xml cairo_text_extents_t.xml 
Log Message:
added functions to describe the new backends, added text_extents function


--- NEW FILE: cairo_set_target_drawable.xml ---
<refentry id="cairo_set_target_drawable">
  <refmeta>
    <refentrytitle>cairo_set_target_drawable</refentrytitle>
    <manvolnum>3</manvolnum>
  </refmeta>
  <refnamediv>
    <refname>cairo_set_target_drawable</refname>
    <refpurpose>set surface for painting operations </refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <programlisting>void cairo_set_target_drawable (<link linkend="cairo_t">cairo_t</link> *cr, Display *dpy, Drawable drawable);</programlisting>
    <variablelist role="params">
      <varlistentry>
        <term><parameter>cr</parameter> :</term>
        <listitem>
          <simpara>a <link linkend="cairo_t">cairo_t</link></simpara>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><parameter>dpy</parameter> :</term>
        <listitem>
          <simpara>X Display</simpara>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><parameter>drawable</parameter> :</term>
        <listitem>
          <simpara>an X onscreen or offscreen drawable</simpara>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsynopsisdiv>
  <refsect1>
    <title>Description</title>
    <para>
      <indexterm>
        <primary>functions</primary>
        <secondary>cairo_set_target_drawable</secondary>
      </indexterm>
      <indexterm>
        <primary/>
      </indexterm>
    </para>
  </refsect1>
</refentry>

--- NEW FILE: cairo_set_target_png.xml ---
<refentry id="cairo_set_target_png">
  <refmeta>
    <refentrytitle>cairo_set_target_png</refentrytitle>
    <manvolnum>3</manvolnum>
  </refmeta>
  <refnamediv>
    <refname>cairo_set_target_png</refname>
    <refpurpose>set surface for painting operations </refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <programlisting>void cairo_set_target_png (<link linkend="cairo_t">cairo_t</link> *cr, FILE *file, <link linkend="cairo_format_t">cairo_format_t</link> format, int width, int height);</programlisting>
    <variablelist role="params">
      <varlistentry>
        <term><parameter>cr</parameter> :</term>
        <listitem>
          <simpara>a <link linkend="cairo_t">cairo_t</link></simpara>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><parameter>FILE</parameter> :</term>
        <listitem>
          <simpara>an open, writeable file</simpara>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><parameter><link linkend="cairo_format_t">cairo_format_t</link></parameter> :</term>
        <listitem>
          <simpara>determines the color-depth of the resulting png image</simpara>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><parameter>width, height</parameter> :</term>
        <listitem>
          <simpara>sets width and height of resulting png image </simpara>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsynopsisdiv>
  <refsect1>
    <title>Description</title>
    <para>
      <indexterm>
        <primary>functions</primary>
        <secondary>cairo_set_target_png</secondary>
      </indexterm>
      <indexterm>
        <primary/>
      </indexterm>
    </para>
  </refsect1>
</refentry>

--- NEW FILE: cairo_set_target_ps.xml ---
<refentry id="cairo_set_target_ps">
  <refmeta>
    <refentrytitle>cairo_set_target_ps</refentrytitle>
    <manvolnum>3</manvolnum>
  </refmeta>
  <refnamediv>
    <refname>cairo_set_target_ps</refname>
    <refpurpose>set surface for painting operations </refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <programlisting>
void cairo_set_target_ps (<link linkend="cairo_t">cairo_t</link> *cr,FILE *file, double width_inches, double height_inches, double x_pixels_per_inch, double y_pixels_per_inch);</programlisting>
    <variablelist role="params">
      <varlistentry>
        <term><parameter>cr</parameter> :</term>
        <listitem>
          <simpara>a <link linkend="cairo_t">cairo_t</link></simpara>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><parameter>FILE</parameter> :</term>
        <listitem>
          <simpara>an open, writeable file</simpara>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><parameter>width_inches, height_inches</parameter> :</term>
        <listitem>
          <simpara>width and height of an output page in inches</simpara>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><parameter>x_pixels_per_inch, y_pixels_per_inch</parameter> :</term>
        <listitem>
          <simpara>Resolution of the postscript file. Right now cairo dumps an entire image on every page, so this parameters define the resolution of the resulting image.</simpara>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsynopsisdiv>
  <refsect1>
    <title>Description</title>
    <para>
      <indexterm>
        <primary>functions</primary>
        <secondary>cairo_set_target_ps</secondary>
      </indexterm>
      <indexterm>
        <primary/>
      </indexterm>
    </para>
  </refsect1>
</refentry>

--- NEW FILE: cairo_set_target_xcb.xml ---
<refentry id="cairo_set_target_xcb">
  <refmeta>
    <refentrytitle>cairo_set_target_xcb</refentrytitle>
    <manvolnum>3</manvolnum>
  </refmeta>
  <refnamediv>
    <refname>cairo_set_target_xcb</refname>
    <refpurpose>set surface for painting operations </refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <programlisting>void
cairo_set_target_xcb (<link linkend="cairo_t">cairo_t</link> *cr, XCBConnection *dpy, DRAWABLE drawable, VISUALTYPE *visual, <link linkend="cairo_format_t">cairo_format_t</link> format);</programlisting>
    <variablelist role="params">
      <varlistentry>
        <term><parameter>cr</parameter> :</term>
        <listitem>
          <simpara>a <link linkend="cairo_t">cairo_t</link></simpara>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><parameter>dpy</parameter> :</term>
        <listitem>
          <simpara>...</simpara>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><parameter>drawable</parameter> :</term>
        <listitem>
          <simpara>an X onscreen or offscreen drawable</simpara>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><parameter>visual</parameter> :</term>
        <listitem>
          <simpara>...</simpara>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><parameter>format</parameter> :</term>
        <listitem>
          <simpara>...</simpara>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsynopsisdiv>
  <refsect1>
    <title>Description</title>
    <para>
      <indexterm>
        <primary>functions</primary>
        <secondary>cairo_set_target_xcb</secondary>
      </indexterm>
      <indexterm>
        <primary/>
      </indexterm>
    </para>
  </refsect1>
</refentry>

--- NEW FILE: cairo_text_extents.xml ---

<refentry id="cairo_text_extents">
  <refmeta>
    <refentrytitle>cairo_text_extents</refentrytitle>
    <manvolnum>3</manvolnum>
  </refmeta>
  <refnamediv>
    <refname>cairo_text_extents</refname>
    <refpurpose>determine extents of a utf8 string</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <programlisting>void cairo_text_extents (<link linkend="cairo_t">cairo_t</link> *ct, const unsigned char *utf8, <link linkend="cairo_text_extents_t">cairo_text_extents_t</link> *extents);</programlisting>
    <variablelist role="params">
      <varlistentry>
        <term><parameter>cr</parameter> :</term>
        <listitem>
          <simpara>a <link linkend="cairo_t">cairo_t</link></simpara>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><parameter>utf8</parameter> :</term>
        <listitem>
          <simpara>utf8 encoded string</simpara>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><parameter>extents</parameter> :</term>
        <listitem>
          <simpara>a <link linkend="cairo_text_extents_t">cairo_text_extents_t</link> structure</simpara>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsynopsisdiv>
  <refsect1>
    <title>Description</title>
    <para>
      <indexterm>
        <primary>functions</primary>
        <secondary>cairo_text_extents</secondary>
      </indexterm>
      <indexterm>
        <primary/>
      </indexterm>
       
    </para>
  </refsect1>
</refentry>

--- NEW FILE: cairo_text_extents_t.xml ---

<refentry id="cairo_text_extents_t">
  <refmeta>
    <refentrytitle>cairo_text_extents_t</refentrytitle>
    <manvolnum>3</manvolnum>
  </refmeta>
  <refnamediv>
    <refname>cairo_text_extents_t</refname>
    <refpurpose>struct to store extents of a string</refpurpose>
  </refnamediv>
  <refsect1>
    <title>Description</title>
    <para><indexterm><primary>types</primary><secondary>cairo_text_extents_t</secondary></indexterm><indexterm><primary/></indexterm>
    <programlisting>
      typedef struct {
      double x_bearing;
      double y_bearing;
      double width;
      double height;
      double x_advance;
      double y_advance;
      } cairo_text_extents_t;
    </programlisting>
    </para>
    <para>
      XXX. not sure what the status is right know.
    </para>
  </refsect1>
</refentry>

Index: cairo_set_target_surface.xml
===================================================================
RCS file: /cvs/cairo/cairo/doc/reference/xml/cairo_set_target_surface.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** a/cairo_set_target_surface.xml	20 Feb 2004 22:23:17 -0000	1.4
--- b/cairo_set_target_surface.xml	26 Feb 2004 22:32:12 -0000	1.5
***************
*** 36,40 ****
          <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 valid at least until another surface was selected or the <link linkend="cairo_t">cairo_t</link> is destroyed.
      </para>
    </refsect1>
--- 36,40 ----
          <primary/>
        </indexterm>
! Selects  <varname>surface</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 valid at least until another surface was selected or the <link linkend="cairo_t">cairo_t</link> is destroyed.
      </para>
    </refsect1>





More information about the cairo-commit mailing list