mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
Add roles for refsect1 sections and fix see also structure
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@178980 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour
parent
e5e38c67dc
commit
b1ebbda590
23 changed files with 355 additions and 311 deletions
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.openal-buffer-create">
|
||||
<refnamediv>
|
||||
<refname>openal_buffer_create</refname>
|
||||
|
|
@ -7,28 +7,29 @@
|
|||
Generate OpenAL buffer
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>resource</type><methodname>openal_buffer_create</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<simpara>
|
||||
<para>
|
||||
Returns an <link linkend="openal.resources">Open AL(Buffer)</link> resource on success or
|
||||
&false; on failure.
|
||||
</simpara>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simpara>
|
||||
<function>openal_buffer_loadwav</function>&listendand;
|
||||
<function>openal_buffer_data</function>
|
||||
</simpara>
|
||||
<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
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.openal-buffer-data">
|
||||
<refnamediv>
|
||||
<refname>openal_buffer_data</refname>
|
||||
|
|
@ -7,8 +7,8 @@
|
|||
Load a buffer with data
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>openal_buffer_data</methodname>
|
||||
<methodparam><type>resource</type><parameter>buffer</parameter></methodparam>
|
||||
|
|
@ -17,61 +17,63 @@
|
|||
<methodparam><type>int</type><parameter>freq</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>buffer</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
An <link linkend="openal.resources">Open AL(Buffer)</link> resource
|
||||
(previously created by <function>openal_buffer_create</function>).
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>format</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<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>
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>data</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
Block of binary audio data in the <parameter>format</parameter> and
|
||||
<parameter>freq</parameter> specified.
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>frew</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
Frequency of <parameter>data</parameter> given in Hz.
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simpara>
|
||||
<function>openal_buffer_loadwav</function>&listendand;
|
||||
<function>openal_stream</function>
|
||||
</simpara>
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>openal_buffer_loadwav</function></member>
|
||||
<member><function>openal_stream</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.openal-buffer-destroy">
|
||||
<refnamediv>
|
||||
<refname>openal_buffer_destroy</refname>
|
||||
|
|
@ -7,38 +7,40 @@
|
|||
Destroys an OpenAL buffer
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<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>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>buffer</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
An <link linkend="openal.resources">Open AL(Buffer)</link> resource
|
||||
(previously created by <function>openal_buffer_create</function>).
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simpara>
|
||||
<function>openal_buffer_create</function>
|
||||
</simpara>
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>openal_buffer_create</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.openal-buffer-get">
|
||||
<refnamediv>
|
||||
<refname>openal_buffer_get</refname>
|
||||
|
|
@ -7,53 +7,55 @@
|
|||
Retrieve an OpenAL buffer property
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<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>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>buffer</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
An <link linkend="openal.resources">Open AL(Buffer)</link> resource
|
||||
(previously created by <function>openal_buffer_create</function>).
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>property</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
Specific property, one of:
|
||||
<constant>AL_FREQUENCY</constant>,
|
||||
<constant>AL_BITS</constant>,
|
||||
<constant>AL_CHANNELS</constant>&listendand;
|
||||
<constant>AL_SIZE</constant>.
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<simpara>
|
||||
<para>
|
||||
Returns an integer value appropriate to the <parameter>property</parameter>
|
||||
requested or &false; on failure.
|
||||
</simpara>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simpara>
|
||||
<function>openal_buffer_create</function>
|
||||
</simpara>
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>openal_buffer_create</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.openal-buffer-loadwav">
|
||||
<refnamediv>
|
||||
<refname>openal_buffer_loadwav</refname>
|
||||
|
|
@ -7,48 +7,50 @@
|
|||
Load a .wav file into a buffer
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<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>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>buffer</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
An <link linkend="openal.resources">Open AL(Buffer)</link> resource
|
||||
(previously created by <function>openal_buffer_create</function>).
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>wavfile</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
Path to .WAV file on <emphasis>local</emphasis> file system.
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simpara>
|
||||
<function>openal_buffer_data</function>&listendand;
|
||||
<function>openal_stream</function>
|
||||
</simpara>
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>openal_buffer_data</function></member>
|
||||
<member><function>openal_stream</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.openal-context-create">
|
||||
<refnamediv>
|
||||
<refname>openal_context_create</refname>
|
||||
|
|
@ -7,42 +7,43 @@
|
|||
Create an audio processing context
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<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>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>device</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
An <link linkend="openal.resources">Open AL(Device)</link> resource
|
||||
(previously created by <function>openal_device_open</function>).
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<simpara>
|
||||
<para>
|
||||
Returns an <link linkend="openal.resources">Open AL(Context)</link> resource on success or
|
||||
&false; on failure.
|
||||
</simpara>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simpara>
|
||||
<function>openal_device_open</function>&listendand;
|
||||
<function>openal_context_destroy</function>
|
||||
</simpara>
|
||||
<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
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.openal-context-current">
|
||||
<refnamediv>
|
||||
<refname>openal_context_current</refname>
|
||||
|
|
@ -7,38 +7,40 @@
|
|||
Make the specified context current
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<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>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>context</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
An <link linkend="openal.resources">Open AL(Context)</link> resource
|
||||
(previously created by <function>openal_context_create</function>).
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simpara>
|
||||
<function>openal_context_create</function>
|
||||
</simpara>
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>openal_context_create</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.openal-context-destroy">
|
||||
<refnamediv>
|
||||
<refname>openal_context_destroy</refname>
|
||||
|
|
@ -7,38 +7,40 @@
|
|||
Destroys a context
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<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>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>context</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
An <link linkend="openal.resources">Open AL(Context)</link> resource
|
||||
(previously created by <function>openal_context_create</function>).
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simpara>
|
||||
<function>openal_context_create</function>
|
||||
</simpara>
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>openal_context_create</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.openal-context-process">
|
||||
<refnamediv>
|
||||
<refname>openal_context_process</refname>
|
||||
|
|
@ -7,40 +7,42 @@
|
|||
Process the specified context
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<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>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>context</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
An <link linkend="openal.resources">Open AL(Context)</link> resource
|
||||
(previously created by <function>openal_context_create</function>).
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simpara>
|
||||
<function>openal_context_create</function>,
|
||||
<function>openal_context_current</function>&listendand;
|
||||
<function>openal_context_suspend</function>
|
||||
</simpara>
|
||||
<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>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.openal-context-suspend">
|
||||
<refnamediv>
|
||||
<refname>openal_context_suspend</refname>
|
||||
|
|
@ -7,40 +7,42 @@
|
|||
Suspend the specified context
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<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>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>context</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
An <link linkend="openal.resources">Open AL(Context)</link> resource
|
||||
(previously created by <function>openal_context_create</function>).
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simpara>
|
||||
<function>openal_context_create</function>,
|
||||
<function>openal_context_current</function>&listendand;
|
||||
<function>openal_context_process</function>
|
||||
</simpara>
|
||||
<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>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.openal-device-close">
|
||||
<refnamediv>
|
||||
<refname>openal_device_close</refname>
|
||||
|
|
@ -7,39 +7,41 @@
|
|||
Close an OpenAL device
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<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>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>device</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
An <link linkend="openal.resources">Open AL(Device)</link> resource
|
||||
(previously created by <function>openal_device_open</function>)
|
||||
to be closed.
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simpara>
|
||||
<function>openal_device_open</function>
|
||||
</simpara>
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>openal_device_open</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.openal-device-open">
|
||||
<refnamediv>
|
||||
<refname>openal_device_open</refname>
|
||||
|
|
@ -7,41 +7,43 @@
|
|||
Initialize the OpenAL audio layer
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<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>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>device_desc</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<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.
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<simpara>
|
||||
<para>
|
||||
Returns an <link linkend="openal.resources">Open AL(Device)</link> resource on success or
|
||||
&false; on failure.
|
||||
</simpara>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simpara>
|
||||
<function>openal_device_close</function>&listendand;
|
||||
<function>openal_context_create</function>
|
||||
</simpara>
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>openal_device_close</function></member>
|
||||
<member><function>openal_context_create</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.openal-listener-get">
|
||||
<refnamediv>
|
||||
<refname>openal_listener_get</refname>
|
||||
|
|
@ -7,41 +7,43 @@
|
|||
Retrieve a listener property
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<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>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>property</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
Property to retreive, 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)).
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<simpara>
|
||||
<para>
|
||||
Returns a float or array of floats (as appropriate), or &false; on failure.
|
||||
</simpara>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simpara>
|
||||
<function>openal_listener_set</function>
|
||||
</simpara>
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>openal_listener_set</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.openal-listener-set">
|
||||
<refnamediv>
|
||||
<refname>openal_listener_set</refname>
|
||||
|
|
@ -7,50 +7,52 @@
|
|||
Set a listener property
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<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>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>property</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<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)).
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>setting</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
Value to set, either float, or an array of floats as appropriate.
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simpara>
|
||||
<function>openal_listener_get</function>
|
||||
</simpara>
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>openal_listener_get</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.openal-source-create">
|
||||
<refnamediv>
|
||||
<refname>openal_source_create</refname>
|
||||
|
|
@ -7,27 +7,29 @@
|
|||
Generate a source resource
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>resource</type><methodname>openal_source_create</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<simpara>
|
||||
<para>
|
||||
Returns an <link linkend="openal.resources">Open AL(Source)</link> resource on success or
|
||||
&false; on failure.
|
||||
</simpara>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simpara>
|
||||
<function>openal_source_set</function>,
|
||||
<function>openal_source_play</function>&listendand;
|
||||
<function>openal_source_destroy</function>
|
||||
</simpara>
|
||||
<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>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.openal-source-destroy">
|
||||
<refnamediv>
|
||||
<refname>openal_source_destroy</refname>
|
||||
|
|
@ -7,38 +7,40 @@
|
|||
Destroy a source resource
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>resource</type><methodname>openal_source_destroy</methodname>
|
||||
<methodparam><type>resource</type><parameter>source</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>source</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
An <link linkend="openal.resources">Open AL(Source)</link> resource
|
||||
(previously created by <function>openal_source_create</function>).
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simpara>
|
||||
<function>openal_source_create</function>
|
||||
</simpara>
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>openal_source_create</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.openal-source-get">
|
||||
<refnamediv>
|
||||
<refname>openal_source_get</refname>
|
||||
|
|
@ -7,30 +7,30 @@
|
|||
Retrieve an OpenAL source property
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<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>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>source</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
An <link linkend="openal.resources">Open AL(Source)</link> resource
|
||||
(previously created by <function>openal_source_create</function>).
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>property</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
Property to get, one of:
|
||||
<constant>AL_SOURCE_RELATIVE</constant> (int),
|
||||
<constant>AL_SOURCE_STATE</constant> (int),
|
||||
|
|
@ -47,25 +47,27 @@
|
|||
<constant>AL_POSITION</constant> (array(float,float,float)),
|
||||
<constant>AL_VELOCITY</constant> (array(float,float,float)),
|
||||
<constant>AL_DIRECTION</constant> (array(float,float,float)).
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<simpara>
|
||||
<para>
|
||||
Returns the type associated with the property being retreived
|
||||
or &false; on failure.
|
||||
</simpara>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simpara>
|
||||
<function>openal_source_create</function>,
|
||||
<function>openal_source_set</function>&listendand;
|
||||
<function>openal_source_play</function>
|
||||
</simpara>
|
||||
<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>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.openal-source-pause">
|
||||
<refnamediv>
|
||||
<refname>openal_source_pause</refname>
|
||||
|
|
@ -7,40 +7,42 @@
|
|||
Pause the source
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<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>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>source</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
An <link linkend="openal.resources">Open AL(Source)</link> resource
|
||||
(previously created by <function>openal_source_create</function>).
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simpara>
|
||||
<function>openal_source_stop</function>,
|
||||
<function>openal_source_play</function>&listendand;
|
||||
<function>openal_source_rewind</function>
|
||||
</simpara>
|
||||
<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>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.openal-source-play">
|
||||
<refnamediv>
|
||||
<refname>openal_source_play</refname>
|
||||
|
|
@ -7,40 +7,42 @@
|
|||
Start playing the source
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<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>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>source</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
An <link linkend="openal.resources">Open AL(Source)</link> resource
|
||||
(previously created by <function>openal_source_create</function>).
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simpara>
|
||||
<function>openal_source_stop</function>,
|
||||
<function>openal_source_pause</function>&listendand;
|
||||
<function>openal_source_rewind</function>
|
||||
</simpara>
|
||||
<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>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.openal-source-rewind">
|
||||
<refnamediv>
|
||||
<refname>openal_source_rewind</refname>
|
||||
|
|
@ -7,40 +7,42 @@
|
|||
Rewind the source
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<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>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>source</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
An <link linkend="openal.resources">Open AL(Source)</link> resource
|
||||
(previously created by <function>openal_source_create</function>).
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simpara>
|
||||
<function>openal_source_stop</function>,
|
||||
<function>openal_source_pause</function>&listendand;
|
||||
<function>openal_source_play</function>
|
||||
</simpara>
|
||||
<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>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.openal-source-set">
|
||||
<refnamediv>
|
||||
<refname>openal_source_set</refname>
|
||||
|
|
@ -7,8 +7,8 @@
|
|||
Set source property
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>openal_source_set</methodname>
|
||||
<methodparam><type>resource</type><parameter>source</parameter></methodparam>
|
||||
|
|
@ -16,22 +16,22 @@
|
|||
<methodparam><type>mixed</type><parameter>setting</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>source</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
An <link linkend="openal.resources">Open AL(Source)</link> resource
|
||||
(previously created by <function>openal_source_create</function>).
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>property</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
Property to set, one of:
|
||||
<constant>AL_BUFFER</constant> (OpenAL(Source)),
|
||||
<constant>AL_LOOPING</constant> (bool),
|
||||
|
|
@ -50,34 +50,36 @@
|
|||
<constant>AL_POSITION</constant> (array(float,float,float)),
|
||||
<constant>AL_VELOCITY</constant> (array(float,float,float)),
|
||||
<constant>AL_DIRECTION</constant> (array(float,float,float)).
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>setting</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<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.
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simpara>
|
||||
<function>openal_source_create</function>,
|
||||
<function>openal_source_get</function>&listendand;
|
||||
<function>openal_source_play</function>
|
||||
</simpara>
|
||||
<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>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.openal-source-stop">
|
||||
<refnamediv>
|
||||
<refname>openal_source_stop</refname>
|
||||
|
|
@ -7,40 +7,42 @@
|
|||
Stop playing the source
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<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>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>source</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
An <link linkend="openal.resources">Open AL(Source)</link> resource
|
||||
(previously created by <function>openal_source_create</function>).
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simpara>
|
||||
<function>openal_source_play</function>,
|
||||
<function>openal_source_pause</function>&listendand;
|
||||
<function>openal_source_rewind</function>
|
||||
</simpara>
|
||||
<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>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.openal-stream">
|
||||
<refnamediv>
|
||||
<refname>openal_stream</refname>
|
||||
|
|
@ -7,8 +7,8 @@
|
|||
Begin streaming on a source
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>resource</type><methodname>openal_stream</methodname>
|
||||
<methodparam><type>resource</type><parameter>source</parameter></methodparam>
|
||||
|
|
@ -16,52 +16,54 @@
|
|||
<methodparam><type>int</type><parameter>rate</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>source</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
An <link linkend="openal.resources">Open AL(Source)</link> resource
|
||||
(previously created by <function>openal_source_create</function>).
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>format</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<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>
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>rate</parameter></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
<para>
|
||||
Frequency of data to stream given in Hz.
|
||||
</simpara>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<simpara>
|
||||
<para>
|
||||
Returns a stream resource on success, or &false; on failure.
|
||||
</simpara>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simpara>
|
||||
<function>openal_source_create</function>&listendand;
|
||||
<function>fwrite</function>
|
||||
</simpara>
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>openal_source_create</function></member>
|
||||
<member><function>fwrite</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue