summaryrefslogtreecommitdiff
path: root/doc/reference/xml/cairo_set_target_image.xml
blob: b96a5fbdcd21a3e10987596ff88723e68d597650 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
<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>