openal-device-open.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.openal-device-open" xmlns="http://docbook.org/ns/docbook">
 <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:
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:"~/.phpdoc/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
-->