summaryrefslogtreecommitdiff
path: root/doc/reference/xml/cairo_set_pattern.xml
blob: 14d0678dfe41ad258e3d028f1ce851accc9a414c (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
<refentry id="cairo_set_pattern">
  <refmeta>
    <refentrytitle>cairo_set_pattern</refentrytitle>
    <manvolnum>3</manvolnum>
  </refmeta>
  <refnamediv>
    <refname>cairo_set_pattern</refname>
    <refpurpose>select a surface as fill pattern</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <programlisting>
void cairo_set_pattern (<link linkend="cairo_t">cairo_t</link> *cr, <link linkend="cairo_surface_t">cairo_surface_t</link> *pattern)</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>pattern</parameter> :</term>
        <listitem>
          <simpara>a surface</simpara>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsynopsisdiv>
  <refsect1>
    <title>Description</title>
    <para>
      <indexterm>
        <primary>functions</primary>
        <secondary>cairo_set_pattern</secondary>
      </indexterm>
      <indexterm>
        <primary/>
      </indexterm>
      This function selects <varname>pattern</varname> as pattern for fill operations. If the repeat flag is set via <link linkend="cairo_surface_set_repeat">cairo_surface_set_repeat</link>, the pattern will be tiled, otherwise just drawn once.
    </para>
  </refsect1>
</refentry>