<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
  <refentry id="function.openal-source-get">
   <refnamediv>
    <refname>openal_source_get</refname>
    <refpurpose>
     Retrieve an OpenAL source property
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <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>
    &reftitle.parameters;
    <variablelist>
     <varlistentry>
      <term><parameter>source</parameter></term>
      <listitem>
       <simpara>
        An <link linkend="openal.resources">Open AL(Source)</link> resource
        (previously created by <function>openal_source_create</function>).
       </simpara>
      </listitem>
     </varlistentry>
     <varlistentry>
      <term><parameter>property</parameter></term>
      <listitem>
       <simpara>
        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)).
       </simpara>
      </listitem>
     </varlistentry>
    </variablelist>
   </refsect1>
   <refsect1>
    &reftitle.returnvalues;
    <simpara>
     Returns the type associated with the property being retreived
     or &false; on failure.
    </simpara>
   </refsect1>
   <refsect1>
    &reftitle.seealso;
    <simpara>
     <function>openal_source_create</function>,
     <function>openal_source_set</function>&listendand;
     <function>openal_source_play</function>
    </simpara>
   </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
-->