sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-18 09:58:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

WS, docs are already switched to new structure

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@227259 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2007-01-15 02:15:49 +00:00
parent 2341d625d9
commit b513f5dc64
23 changed files with 1168 additions and 1168 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

64
reference/openal/functions/openal-buffer-create.xml
View file

@ -1,36 +1,36 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.openal-buffer-create">
<refnamediv>
<refname>openal_buffer_create</refname>
<refpurpose>
Generate OpenAL buffer
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>openal_buffer_create</methodname>
<void/>
</methodsynopsis>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an <link linkend="openal.resources">Open AL(Buffer)</link> resource on success or
&false; on failure.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_buffer_loadwav</function></member>
<member><function>openal_buffer_data</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.openal-buffer-create">
<refnamediv>
<refname>openal_buffer_create</refname>
<refpurpose>
Generate OpenAL buffer
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>openal_buffer_create</methodname>
<void/>
</methodsynopsis>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an <link linkend="openal.resources">Open AL(Buffer)</link> resource on success or
&false; on failure.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_buffer_loadwav</function></member>
<member><function>openal_buffer_data</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

154
reference/openal/functions/openal-buffer-data.xml
View file

@ -1,81 +1,81 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<refentry id="function.openal-buffer-data">
<refnamediv>
<refname>openal_buffer_data</refname>
<refpurpose>
Load a buffer with data
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_buffer_data</methodname>
<methodparam><type>resource</type><parameter>buffer</parameter></methodparam>
<methodparam><type>int</type><parameter>format</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam><type>int</type><parameter>freq</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>buffer</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Buffer)</link> resource
(previously created by <function>openal_buffer_create</function>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>format</parameter></term>
<listitem>
<para>
Format of <parameter>data</parameter>, one of:
<constant>AL_FORMAT_MONO8</constant>,
<constant>AL_FORMAT_MONO16</constant>,
<constant>AL_FORMAT_STEREO8</constant>&listendand;
<constant>AL_FORMAT_STEREO16</constant>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
Block of binary audio data in the <parameter>format</parameter> and
<parameter>freq</parameter> specified.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>freq</parameter></term>
<listitem>
<para>
Frequency of <parameter>data</parameter> given in Hz.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_buffer_loadwav</function></member>
<member><function>openal_stream</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.4 $ -->
<refentry id="function.openal-buffer-data">
<refnamediv>
<refname>openal_buffer_data</refname>
<refpurpose>
Load a buffer with data
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_buffer_data</methodname>
<methodparam><type>resource</type><parameter>buffer</parameter></methodparam>
<methodparam><type>int</type><parameter>format</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam><type>int</type><parameter>freq</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>buffer</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Buffer)</link> resource
(previously created by <function>openal_buffer_create</function>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>format</parameter></term>
<listitem>
<para>
Format of <parameter>data</parameter>, one of:
<constant>AL_FORMAT_MONO8</constant>,
<constant>AL_FORMAT_MONO16</constant>,
<constant>AL_FORMAT_STEREO8</constant>&listendand;
<constant>AL_FORMAT_STEREO16</constant>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
Block of binary audio data in the <parameter>format</parameter> and
<parameter>freq</parameter> specified.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>freq</parameter></term>
<listitem>
<para>
Frequency of <parameter>data</parameter> given in Hz.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_buffer_loadwav</function></member>
<member><function>openal_stream</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

88
reference/openal/functions/openal-buffer-destroy.xml
View file

@ -1,48 +1,48 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.openal-buffer-destroy">
<refnamediv>
<refname>openal_buffer_destroy</refname>
<refpurpose>
Destroys an OpenAL buffer
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_buffer_destroy</methodname>
<methodparam><type>resource</type><parameter>buffer</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>buffer</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Buffer)</link> resource
(previously created by <function>openal_buffer_create</function>).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_buffer_create</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.openal-buffer-destroy">
<refnamediv>
<refname>openal_buffer_destroy</refname>
<refpurpose>
Destroys an OpenAL buffer
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_buffer_destroy</methodname>
<methodparam><type>resource</type><parameter>buffer</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>buffer</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Buffer)</link> resource
(previously created by <function>openal_buffer_create</function>).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_buffer_create</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

116
reference/openal/functions/openal-buffer-get.xml
View file

@ -1,63 +1,63 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.openal-buffer-get">
<refnamediv>
<refname>openal_buffer_get</refname>
<refpurpose>
Retrieve an OpenAL buffer property
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>openal_buffer_get</methodname>
<methodparam><type>resource</type><parameter>buffer</parameter></methodparam>
<methodparam><type>int</type><parameter>property</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>buffer</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Buffer)</link> resource
(previously created by <function>openal_buffer_create</function>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>property</parameter></term>
<listitem>
<para>
Specific property, one of:
<constant>AL_FREQUENCY</constant>,
<constant>AL_BITS</constant>,
<constant>AL_CHANNELS</constant>&listendand;
<constant>AL_SIZE</constant>.
</para>
</listitem>
</varlistentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.openal-buffer-get">
<refnamediv>
<refname>openal_buffer_get</refname>
<refpurpose>
Retrieve an OpenAL buffer property
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>openal_buffer_get</methodname>
<methodparam><type>resource</type><parameter>buffer</parameter></methodparam>
<methodparam><type>int</type><parameter>property</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>buffer</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Buffer)</link> resource
(previously created by <function>openal_buffer_create</function>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>property</parameter></term>
<listitem>
<para>
Specific property, one of:
<constant>AL_FREQUENCY</constant>,
<constant>AL_BITS</constant>,
<constant>AL_CHANNELS</constant>&listendand;
<constant>AL_SIZE</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an integer value appropriate to the <parameter>property</parameter>
requested or &false; on failure.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_buffer_create</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an integer value appropriate to the <parameter>property</parameter>
requested or &false; on failure.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_buffer_create</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

108
reference/openal/functions/openal-buffer-loadwav.xml
View file

@ -1,58 +1,58 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.openal-buffer-loadwav">
<refnamediv>
<refname>openal_buffer_loadwav</refname>
<refpurpose>
Load a .wav file into a buffer
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_buffer_loadwav</methodname>
<methodparam><type>resource</type><parameter>buffer</parameter></methodparam>
<methodparam><type>string</type><parameter>wavfile</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>buffer</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Buffer)</link> resource
(previously created by <function>openal_buffer_create</function>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>wavfile</parameter></term>
<listitem>
<para>
Path to .WAV file on <emphasis>local</emphasis> file system.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_buffer_data</function></member>
<member><function>openal_stream</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.openal-buffer-loadwav">
<refnamediv>
<refname>openal_buffer_loadwav</refname>
<refpurpose>
Load a .wav file into a buffer
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_buffer_loadwav</methodname>
<methodparam><type>resource</type><parameter>buffer</parameter></methodparam>
<methodparam><type>string</type><parameter>wavfile</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>buffer</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Buffer)</link> resource
(previously created by <function>openal_buffer_create</function>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>wavfile</parameter></term>
<listitem>
<para>
Path to .WAV file on <emphasis>local</emphasis> file system.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_buffer_data</function></member>
<member><function>openal_stream</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

92
reference/openal/functions/openal-context-create.xml
View file

@ -1,50 +1,50 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.openal-context-create">
<refnamediv>
<refname>openal_context_create</refname>
<refpurpose>
Create an audio processing context
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>openal_context_create</methodname>
<methodparam><type>resource</type><parameter>device</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>device</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Device)</link> resource
(previously created by <function>openal_device_open</function>).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an <link linkend="openal.resources">Open AL(Context)</link> resource on success or
&false; on failure.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_device_open</function></member>
<member><function>openal_context_destroy</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.openal-context-create">
<refnamediv>
<refname>openal_context_create</refname>
<refpurpose>
Create an audio processing context
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>openal_context_create</methodname>
<methodparam><type>resource</type><parameter>device</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>device</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Device)</link> resource
(previously created by <function>openal_device_open</function>).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an <link linkend="openal.resources">Open AL(Context)</link> resource on success or
&false; on failure.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_device_open</function></member>
<member><function>openal_context_destroy</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

88
reference/openal/functions/openal-context-current.xml
View file

@ -1,48 +1,48 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.openal-context-current">
<refnamediv>
<refname>openal_context_current</refname>
<refpurpose>
Make the specified context current
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_context_current</methodname>
<methodparam><type>resource</type><parameter>context</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Context)</link> resource
(previously created by <function>openal_context_create</function>).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_context_create</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.openal-context-current">
<refnamediv>
<refname>openal_context_current</refname>
<refpurpose>
Make the specified context current
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_context_current</methodname>
<methodparam><type>resource</type><parameter>context</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Context)</link> resource
(previously created by <function>openal_context_create</function>).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_context_create</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

88
reference/openal/functions/openal-context-destroy.xml
View file

@ -1,48 +1,48 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.openal-context-destroy">
<refnamediv>
<refname>openal_context_destroy</refname>
<refpurpose>
Destroys a context
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_context_destroy</methodname>
<methodparam><type>resource</type><parameter>context</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Context)</link> resource
(previously created by <function>openal_context_create</function>).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_context_create</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.openal-context-destroy">
<refnamediv>
<refname>openal_context_destroy</refname>
<refpurpose>
Destroys a context
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_context_destroy</methodname>
<methodparam><type>resource</type><parameter>context</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Context)</link> resource
(previously created by <function>openal_context_create</function>).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_context_create</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

92
reference/openal/functions/openal-context-process.xml
View file

@ -1,50 +1,50 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.openal-context-process">
<refnamediv>
<refname>openal_context_process</refname>
<refpurpose>
Process the specified context
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_context_process</methodname>
<methodparam><type>resource</type><parameter>context</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Context)</link> resource
(previously created by <function>openal_context_create</function>).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_context_create</function></member>
<member><function>openal_context_current</function></member>
<member><function>openal_context_suspend</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.openal-context-process">
<refnamediv>
<refname>openal_context_process</refname>
<refpurpose>
Process the specified context
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_context_process</methodname>
<methodparam><type>resource</type><parameter>context</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Context)</link> resource
(previously created by <function>openal_context_create</function>).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_context_create</function></member>
<member><function>openal_context_current</function></member>
<member><function>openal_context_suspend</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

92
reference/openal/functions/openal-context-suspend.xml
View file

@ -1,50 +1,50 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.openal-context-suspend">
<refnamediv>
<refname>openal_context_suspend</refname>
<refpurpose>
Suspend the specified context
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_context_suspend</methodname>
<methodparam><type>resource</type><parameter>context</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Context)</link> resource
(previously created by <function>openal_context_create</function>).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_context_create</function></member>
<member><function>openal_context_current</function></member>
<member><function>openal_context_process</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.openal-context-suspend">
<refnamediv>
<refname>openal_context_suspend</refname>
<refpurpose>
Suspend the specified context
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_context_suspend</methodname>
<methodparam><type>resource</type><parameter>context</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Context)</link> resource
(previously created by <function>openal_context_create</function>).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_context_create</function></member>
<member><function>openal_context_current</function></member>
<member><function>openal_context_process</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

90
reference/openal/functions/openal-device-close.xml
View file

@ -1,49 +1,49 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.openal-device-close">
<refnamediv>
<refname>openal_device_close</refname>
<refpurpose>
Close an OpenAL device
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_device_close</methodname>
<methodparam><type>resource</type><parameter>device</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>device</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Device)</link> resource
(previously created by <function>openal_device_open</function>)
to be closed.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_device_open</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.openal-device-close">
<refnamediv>
<refname>openal_device_close</refname>
<refpurpose>
Close an OpenAL device
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_device_close</methodname>
<methodparam><type>resource</type><parameter>device</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>device</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Device)</link> resource
(previously created by <function>openal_device_open</function>)
to be closed.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_device_open</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

94
reference/openal/functions/openal-device-open.xml
View file

@ -1,51 +1,51 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.openal-device-open">
<refnamediv>
<refname>openal_device_open</refname>
<refpurpose>
Initialize the OpenAL audio layer
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>openal_device_open</methodname>
<methodparam choice="opt"><type>string</type><parameter>device_desc</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>device_desc</parameter></term>
<listitem>
<para>
Open an audio device optionally specified by <parameter>device_desc</parameter>.
If <parameter>device_desc</parameter> is not specified the first available audio
device will be used.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an <link linkend="openal.resources">Open AL(Device)</link> resource on success or
&false; on failure.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_device_close</function></member>
<member><function>openal_context_create</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.openal-device-open">
<refnamediv>
<refname>openal_device_open</refname>
<refpurpose>
Initialize the OpenAL audio layer
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>openal_device_open</methodname>
<methodparam choice="opt"><type>string</type><parameter>device_desc</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>device_desc</parameter></term>
<listitem>
<para>
Open an audio device optionally specified by <parameter>device_desc</parameter>.
If <parameter>device_desc</parameter> is not specified the first available audio
device will be used.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an <link linkend="openal.resources">Open AL(Device)</link> resource on success or
&false; on failure.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_device_close</function></member>
<member><function>openal_context_create</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

94
reference/openal/functions/openal-listener-get.xml
View file

@ -1,51 +1,51 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<refentry id="function.openal-listener-get">
<refnamediv>
<refname>openal_listener_get</refname>
<refpurpose>
Retrieve a listener property
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>openal_listener_get</methodname>
<methodparam><type>int</type><parameter>property</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>property</parameter></term>
<listitem>
<para>
Property to retrieve, one of:
<constant>AL_GAIN</constant> (float),
<constant>AL_POSITION</constant> (array(float,float,float)),
<constant>AL_VELOCITY</constant> (array(float,float,float))&listendand;
<constant>AL_ORIENTATION</constant> (array(float,float,float)).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a float or array of floats (as appropriate), or &false; on failure.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_listener_set</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.4 $ -->
<refentry id="function.openal-listener-get">
<refnamediv>
<refname>openal_listener_get</refname>
<refpurpose>
Retrieve a listener property
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>openal_listener_get</methodname>
<methodparam><type>int</type><parameter>property</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>property</parameter></term>
<listitem>
<para>
Property to retrieve, one of:
<constant>AL_GAIN</constant> (float),
<constant>AL_POSITION</constant> (array(float,float,float)),
<constant>AL_VELOCITY</constant> (array(float,float,float))&listendand;
<constant>AL_ORIENTATION</constant> (array(float,float,float)).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a float or array of floats (as appropriate), or &false; on failure.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_listener_set</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

112
reference/openal/functions/openal-listener-set.xml
View file

@ -1,60 +1,60 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.openal-listener-set">
<refnamediv>
<refname>openal_listener_set</refname>
<refpurpose>
Set a listener property
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_listener_set</methodname>
<methodparam><type>int</type><parameter>property</parameter></methodparam>
<methodparam><type>mixed</type><parameter>setting</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>property</parameter></term>
<listitem>
<para>
Property to set, one of:
<constant>AL_GAIN</constant> (float),
<constant>AL_POSITION</constant> (array(float,float,float)),
<constant>AL_VELOCITY</constant> (array(float,float,float))&listendand;
<constant>AL_ORIENTATION</constant> (array(float,float,float)).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>setting</parameter></term>
<listitem>
<para>
Value to set, either float, or an array of floats as appropriate.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_listener_get</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.openal-listener-set">
<refnamediv>
<refname>openal_listener_set</refname>
<refpurpose>
Set a listener property
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_listener_set</methodname>
<methodparam><type>int</type><parameter>property</parameter></methodparam>
<methodparam><type>mixed</type><parameter>setting</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>property</parameter></term>
<listitem>
<para>
Property to set, one of:
<constant>AL_GAIN</constant> (float),
<constant>AL_POSITION</constant> (array(float,float,float)),
<constant>AL_VELOCITY</constant> (array(float,float,float))&listendand;
<constant>AL_ORIENTATION</constant> (array(float,float,float)).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>setting</parameter></term>
<listitem>
<para>
Value to set, either float, or an array of floats as appropriate.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_listener_get</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

66
reference/openal/functions/openal-source-create.xml
View file

@ -1,37 +1,37 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.openal-source-create">
<refnamediv>
<refname>openal_source_create</refname>
<refpurpose>
Generate a source resource
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>openal_source_create</methodname>
<void/>
</methodsynopsis>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an <link linkend="openal.resources">Open AL(Source)</link> resource on success or
&false; on failure.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_source_set</function></member>
<member><function>openal_source_play</function></member>
<member><function>openal_source_destroy</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.openal-source-create">
<refnamediv>
<refname>openal_source_create</refname>
<refpurpose>
Generate a source resource
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>openal_source_create</methodname>
<void/>
</methodsynopsis>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an <link linkend="openal.resources">Open AL(Source)</link> resource on success or
&false; on failure.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_source_set</function></member>
<member><function>openal_source_play</function></member>
<member><function>openal_source_destroy</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

88
reference/openal/functions/openal-source-destroy.xml
View file

@ -1,48 +1,48 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<refentry id="function.openal-source-destroy">
<refnamediv>
<refname>openal_source_destroy</refname>
<refpurpose>
Destroy a source resource
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_source_destroy</methodname>
<methodparam><type>resource</type><parameter>source</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Source)</link> resource
(previously created by <function>openal_source_create</function>).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_source_create</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.4 $ -->
<refentry id="function.openal-source-destroy">
<refnamediv>
<refname>openal_source_destroy</refname>
<refpurpose>
Destroy a source resource
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_source_destroy</methodname>
<methodparam><type>resource</type><parameter>source</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Source)</link> resource
(previously created by <function>openal_source_create</function>).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_source_create</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

142
reference/openal/functions/openal-source-get.xml
View file

@ -1,75 +1,75 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<refentry id="function.openal-source-get">
<refnamediv>
<refname>openal_source_get</refname>
<refpurpose>
Retrieve an OpenAL source property
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>openal_source_get</methodname>
<methodparam><type>resource</type><parameter>source</parameter></methodparam>
<methodparam><type>int</type><parameter>property</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Source)</link> resource
(previously created by <function>openal_source_create</function>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>property</parameter></term>
<listitem>
<para>
Property to get, one of:
<constant>AL_SOURCE_RELATIVE</constant> (int),
<constant>AL_SOURCE_STATE</constant> (int),
<constant>AL_PITCH</constant> (float),
<constant>AL_GAIN</constant> (float),
<constant>AL_MIN_GAIN</constant> (float),
<constant>AL_MAX_GAIN</constant> (float),
<constant>AL_MAX_DISTANCE</constant> (float),
<constant>AL_ROLLOFF_FACTOR</constant> (float),
<constant>AL_CONE_OUTER_GAIN</constant> (float),
<constant>AL_CONE_INNER_ANGLE</constant> (float),
<constant>AL_CONE_OUTER_ANGLE</constant> (float),
<constant>AL_REFERENCE_DISTANCE</constant> (float),
<constant>AL_POSITION</constant> (array(float,float,float)),
<constant>AL_VELOCITY</constant> (array(float,float,float)),
<constant>AL_DIRECTION</constant> (array(float,float,float)).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the type associated with the property being retrieved
or &false; on failure.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_source_create</function></member>
<member><function>openal_source_set</function></member>
<member><function>openal_source_play</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.4 $ -->
<refentry id="function.openal-source-get">
<refnamediv>
<refname>openal_source_get</refname>
<refpurpose>
Retrieve an OpenAL source property
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>openal_source_get</methodname>
<methodparam><type>resource</type><parameter>source</parameter></methodparam>
<methodparam><type>int</type><parameter>property</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Source)</link> resource
(previously created by <function>openal_source_create</function>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>property</parameter></term>
<listitem>
<para>
Property to get, one of:
<constant>AL_SOURCE_RELATIVE</constant> (int),
<constant>AL_SOURCE_STATE</constant> (int),
<constant>AL_PITCH</constant> (float),
<constant>AL_GAIN</constant> (float),
<constant>AL_MIN_GAIN</constant> (float),
<constant>AL_MAX_GAIN</constant> (float),
<constant>AL_MAX_DISTANCE</constant> (float),
<constant>AL_ROLLOFF_FACTOR</constant> (float),
<constant>AL_CONE_OUTER_GAIN</constant> (float),
<constant>AL_CONE_INNER_ANGLE</constant> (float),
<constant>AL_CONE_OUTER_ANGLE</constant> (float),
<constant>AL_REFERENCE_DISTANCE</constant> (float),
<constant>AL_POSITION</constant> (array(float,float,float)),
<constant>AL_VELOCITY</constant> (array(float,float,float)),
<constant>AL_DIRECTION</constant> (array(float,float,float)).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the type associated with the property being retrieved
or &false; on failure.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_source_create</function></member>
<member><function>openal_source_set</function></member>
<member><function>openal_source_play</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

92
reference/openal/functions/openal-source-pause.xml
View file

@ -1,50 +1,50 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.openal-source-pause">
<refnamediv>
<refname>openal_source_pause</refname>
<refpurpose>
Pause the source
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_source_pause</methodname>
<methodparam><type>resource</type><parameter>source</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Source)</link> resource
(previously created by <function>openal_source_create</function>).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_source_stop</function></member>
<member><function>openal_source_play</function></member>
<member><function>openal_source_rewind</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.openal-source-pause">
<refnamediv>
<refname>openal_source_pause</refname>
<refpurpose>
Pause the source
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_source_pause</methodname>
<methodparam><type>resource</type><parameter>source</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Source)</link> resource
(previously created by <function>openal_source_create</function>).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_source_stop</function></member>
<member><function>openal_source_play</function></member>
<member><function>openal_source_rewind</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

92
reference/openal/functions/openal-source-play.xml
View file

@ -1,50 +1,50 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.openal-source-play">
<refnamediv>
<refname>openal_source_play</refname>
<refpurpose>
Start playing the source
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_source_play</methodname>
<methodparam><type>resource</type><parameter>source</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Source)</link> resource
(previously created by <function>openal_source_create</function>).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_source_stop</function></member>
<member><function>openal_source_pause</function></member>
<member><function>openal_source_rewind</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.openal-source-play">
<refnamediv>
<refname>openal_source_play</refname>
<refpurpose>
Start playing the source
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_source_play</methodname>
<methodparam><type>resource</type><parameter>source</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Source)</link> resource
(previously created by <function>openal_source_create</function>).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_source_stop</function></member>
<member><function>openal_source_pause</function></member>
<member><function>openal_source_rewind</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

92
reference/openal/functions/openal-source-rewind.xml
View file

@ -1,50 +1,50 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.openal-source-rewind">
<refnamediv>
<refname>openal_source_rewind</refname>
<refpurpose>
Rewind the source
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_source_rewind</methodname>
<methodparam><type>resource</type><parameter>source</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Source)</link> resource
(previously created by <function>openal_source_create</function>).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_source_stop</function></member>
<member><function>openal_source_pause</function></member>
<member><function>openal_source_play</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.openal-source-rewind">
<refnamediv>
<refname>openal_source_rewind</refname>
<refpurpose>
Rewind the source
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_source_rewind</methodname>
<methodparam><type>resource</type><parameter>source</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Source)</link> resource
(previously created by <function>openal_source_create</function>).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_source_stop</function></member>
<member><function>openal_source_pause</function></member>
<member><function>openal_source_play</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

166
reference/openal/functions/openal-source-set.xml
View file

@ -1,87 +1,87 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.openal-source-set">
<refnamediv>
<refname>openal_source_set</refname>
<refpurpose>
Set source property
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_source_set</methodname>
<methodparam><type>resource</type><parameter>source</parameter></methodparam>
<methodparam><type>int</type><parameter>property</parameter></methodparam>
<methodparam><type>mixed</type><parameter>setting</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Source)</link> resource
(previously created by <function>openal_source_create</function>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>property</parameter></term>
<listitem>
<para>
Property to set, one of:
<constant>AL_BUFFER</constant> (OpenAL(Source)),
<constant>AL_LOOPING</constant> (bool),
<constant>AL_SOURCE_RELATIVE</constant> (int),
<constant>AL_SOURCE_STATE</constant> (int),
<constant>AL_PITCH</constant> (float),
<constant>AL_GAIN</constant> (float),
<constant>AL_MIN_GAIN</constant> (float),
<constant>AL_MAX_GAIN</constant> (float),
<constant>AL_MAX_DISTANCE</constant> (float),
<constant>AL_ROLLOFF_FACTOR</constant> (float),
<constant>AL_CONE_OUTER_GAIN</constant> (float),
<constant>AL_CONE_INNER_ANGLE</constant> (float),
<constant>AL_CONE_OUTER_ANGLE</constant> (float),
<constant>AL_REFERENCE_DISTANCE</constant> (float),
<constant>AL_POSITION</constant> (array(float,float,float)),
<constant>AL_VELOCITY</constant> (array(float,float,float)),
<constant>AL_DIRECTION</constant> (array(float,float,float)).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>setting</parameter></term>
<listitem>
<para>
Value to assign to specified <parameter>property</parameter>.
Refer to the description of <parameter>property</parameter>
for a description of the value(s) expected.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_source_create</function></member>
<member><function>openal_source_get</function></member>
<member><function>openal_source_play</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.openal-source-set">
<refnamediv>
<refname>openal_source_set</refname>
<refpurpose>
Set source property
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_source_set</methodname>
<methodparam><type>resource</type><parameter>source</parameter></methodparam>
<methodparam><type>int</type><parameter>property</parameter></methodparam>
<methodparam><type>mixed</type><parameter>setting</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Source)</link> resource
(previously created by <function>openal_source_create</function>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>property</parameter></term>
<listitem>
<para>
Property to set, one of:
<constant>AL_BUFFER</constant> (OpenAL(Source)),
<constant>AL_LOOPING</constant> (bool),
<constant>AL_SOURCE_RELATIVE</constant> (int),
<constant>AL_SOURCE_STATE</constant> (int),
<constant>AL_PITCH</constant> (float),
<constant>AL_GAIN</constant> (float),
<constant>AL_MIN_GAIN</constant> (float),
<constant>AL_MAX_GAIN</constant> (float),
<constant>AL_MAX_DISTANCE</constant> (float),
<constant>AL_ROLLOFF_FACTOR</constant> (float),
<constant>AL_CONE_OUTER_GAIN</constant> (float),
<constant>AL_CONE_INNER_ANGLE</constant> (float),
<constant>AL_CONE_OUTER_ANGLE</constant> (float),
<constant>AL_REFERENCE_DISTANCE</constant> (float),
<constant>AL_POSITION</constant> (array(float,float,float)),
<constant>AL_VELOCITY</constant> (array(float,float,float)),
<constant>AL_DIRECTION</constant> (array(float,float,float)).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>setting</parameter></term>
<listitem>
<para>
Value to assign to specified <parameter>property</parameter>.
Refer to the description of <parameter>property</parameter>
for a description of the value(s) expected.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_source_create</function></member>
<member><function>openal_source_get</function></member>
<member><function>openal_source_play</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

92
reference/openal/functions/openal-source-stop.xml
View file

@ -1,50 +1,50 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.openal-source-stop">
<refnamediv>
<refname>openal_source_stop</refname>
<refpurpose>
Stop playing the source
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_source_stop</methodname>
<methodparam><type>resource</type><parameter>source</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Source)</link> resource
(previously created by <function>openal_source_create</function>).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_source_play</function></member>
<member><function>openal_source_pause</function></member>
<member><function>openal_source_rewind</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.openal-source-stop">
<refnamediv>
<refname>openal_source_stop</refname>
<refpurpose>
Stop playing the source
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openal_source_stop</methodname>
<methodparam><type>resource</type><parameter>source</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Source)</link> resource
(previously created by <function>openal_source_create</function>).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_source_play</function></member>
<member><function>openal_source_pause</function></member>
<member><function>openal_source_rewind</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

134
reference/openal/functions/openal-stream.xml
View file

@ -1,71 +1,71 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.openal-stream">
<refnamediv>
<refname>openal_stream</refname>
<refpurpose>
Begin streaming on a source
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>openal_stream</methodname>
<methodparam><type>resource</type><parameter>source</parameter></methodparam>
<methodparam><type>int</type><parameter>format</parameter></methodparam>
<methodparam><type>int</type><parameter>rate</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Source)</link> resource
(previously created by <function>openal_source_create</function>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>format</parameter></term>
<listitem>
<para>
Format of <parameter>data</parameter>, one of:
<constant>AL_FORMAT_MONO8</constant>,
<constant>AL_FORMAT_MONO16</constant>,
<constant>AL_FORMAT_STEREO8</constant>&listendand;
<constant>AL_FORMAT_STEREO16</constant>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>rate</parameter></term>
<listitem>
<para>
Frequency of data to stream given in Hz.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a stream resource on success, or &false; on failure.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_source_create</function></member>
<member><function>fwrite</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry id="function.openal-stream">
<refnamediv>
<refname>openal_stream</refname>
<refpurpose>
Begin streaming on a source
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>openal_stream</methodname>
<methodparam><type>resource</type><parameter>source</parameter></methodparam>
<methodparam><type>int</type><parameter>format</parameter></methodparam>
<methodparam><type>int</type><parameter>rate</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
An <link linkend="openal.resources">Open AL(Source)</link> resource
(previously created by <function>openal_source_create</function>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>format</parameter></term>
<listitem>
<para>
Format of <parameter>data</parameter>, one of:
<constant>AL_FORMAT_MONO8</constant>,
<constant>AL_FORMAT_MONO16</constant>,
<constant>AL_FORMAT_STEREO8</constant>&listendand;
<constant>AL_FORMAT_STEREO16</constant>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>rate</parameter></term>
<listitem>
<para>
Frequency of data to stream given in Hz.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a stream resource on success, or &false; on failure.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openal_source_create</function></member>
<member><function>fwrite</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables: