cairo/doc/reference/xml/cairo_destroy.xml

38 lines
1.2 KiB
XML

<refentry id="cairo_destroy">
<refmeta>
<refentrytitle>cairo_destroy</refentrytitle>
<manvolnum>3</manvolnum>
</refmeta>
<refnamediv>
<refname>cairo_destroy</refname>
<refpurpose>free a <link linkend="cairo_t">cairo_t</link></refpurpose>
</refnamediv>
<refsynopsisdiv>
<programlisting>
void cairo_destroy (<link linkend="cairo_t">cairo_t</link> *cr)</programlisting>
<variablelist role="params">
<varlistentry>
<term><parameter>cr</parameter> :</term>
<listitem>
<simpara>a <link linkend="cairo_t">cairo_t</link></simpara>
</listitem>
</varlistentry>
</variablelist>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
<indexterm>
<primary>functions</primary>
<secondary>cairo_destroy</secondary>
</indexterm>
<indexterm>
<primary/>
</indexterm>
Decreases the reference of a a <link linkend="cairo_t">cairo_t</link>. If the refcount drops to zero, all associated resources will be freed.
</para>
<para>
Saved states on the stack which were not restored with <link linkend="cairo_restore">cairo_restore</link> will be destroyed, too.
</para>
</refsect1>
</refentry>