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 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
>
<refentry id="liboil-liboil">
<refmeta>
<refentrytitle>liboil</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBOIL Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>liboil</refname><refpurpose>Miscellaneous functions</refpurpose>
</refnamediv>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
<link linkend="void">void</link> <link linkend="oil-init">oil_init</link> (void);
#define <link linkend="oil-memcpy">oil_memcpy</link> (dest,src,n_bytes)
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
</para>
</refsect1>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="oil-init"/>oil_init ()</title>
<indexterm><primary>oil_init</primary></indexterm><programlisting><link linkend="void">void</link> oil_init (void);</programlisting>
<para>
Initializes liboil. This function must be called before any
other liboil function is used. <parameter>oil_init</parameter> may be called multiple
times.</para>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="oil-memcpy"/>oil_memcpy()</title>
<indexterm><primary>oil_memcpy</primary></indexterm><programlisting>#define oil_memcpy(dest,src,n_bytes)</programlisting>
<para>
Copies data from a source location to destination. Similar to <link linkend="memcpy"><function>memcpy()</function></link>.
</para><variablelist role="params">
<varlistentry><term><parameter>dest</parameter> :</term>
<listitem><simpara>pointer to destination memory
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>src</parameter> :</term>
<listitem><simpara>pointer to source memory
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>n_bytes</parameter> :</term>
<listitem><simpara>number of bytes to copy
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|