php-doc-en/reference/openal/functions/openal-source-set.xml
Hannes Magnusson c030e2adf7 Upgrade to DocBook5:
- All id attributes are now xml:id
 - Add docbook namespace to all root elements
 - Replace <ulink /> with <link xlink:href />
 - Minor markup fixes here and there


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238160 c90b9560-bf6c-de11-be94-00142212c4b1
2007-06-20 22:25:43 +00:00

105 lines
3.3 KiB
XML

<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.openal-source-set" xmlns="http://docbook.org/ns/docbook">
<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:
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
-->