cairo/doc/reference/xml/cairo_set_target_image.xml
2004-02-20 14:23:17 +00:00

58 lines
1.9 KiB
XML

<refentry id="cairo_set_target_image">
<refmeta>
<refentrytitle>cairo_set_target_image</refentrytitle>
<manvolnum>3</manvolnum>
</refmeta>
<refnamediv>
<refname>cairo_set_target_image</refname>
<refpurpose>set image for painting operations </refpurpose>
</refnamediv>
<refsynopsisdiv>
<programlisting>
void cairo_set_target_image (<link linkend="cairo_t">cairo_t</link> *cr,char *data, <link linkend="cairo_format_t">cairo_format_t</link> format, int width, int height, int stride)</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>data</parameter> :</term>
<listitem>
<simpara>pointer to an user-allocated buffer of appropriate size</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>format</parameter> :</term>
<listitem>
<simpara>select color-format of image</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>width, height</parameter></term>
<listitem>
<simpara>width and height describe the visibles image size.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>stride</parameter></term>
<listitem>
<simpara>stride is the actual with of the image and can be larger than with. It is requiered even if stride is equal to with.</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
<indexterm>
<primary>functions</primary>
<secondary>cairo_set_target_image</secondary>
</indexterm>
<indexterm>
<primary/>
</indexterm>
</para>
</refsect1>
</refentry>