1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
<?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>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
