NS/main/source/includes/fmodapi375linux/documentation/HTML/FSOUND_3D_SetAttributes.html
Ari Timonen 4f13237895 Update line endings
Change CRLF to LF in repo.
2018-04-22 18:55:55 +03:00

102 lines
3.8 KiB
HTML

<HTML>
<HEAD>
<META NAME="GENERATOR" Content="SOURCEDOC.EXE">
<META HTTP-EQUIV="Content-Type" content="text/html; charset=iso-8859-1">
<TITLE>FSOUND_3D_SetAttributes</TITLE>
<STYLE>
#flush {margin-left: -10p; margin-right: -0p}
#buttonbar {color: white}
</STYLE>
</HEAD>
<BODY TOPMARGIN=0 BGPROPERTIES="FIXED" BGCOLOR="white">
<FONT FACE="ARIAL">
<SPAN ID="flush">
<A NAME="SEE ALSO">
<TABLE WIDTH="100%" COLS=2 BORDER=0 BGCOLOR="#000000">
<TR ALIGN=RIGHT>
<TD ALIGN=LEFT>
<IMG SRC="banner03.gif" WIDTH="88" HEIGHT="31" BORDER=0>
</TD>
<TD ALIGN=RIGHT VALIGN=TOP>
<FONT FACE="ARIAL" SIZE="2">
<A ID=buttonbar HREF="FSOUND_3D_Listener_SetCurrent.html">
<IMG SRC="u_prev.gif" WIDTH="71" HEIGHT="16" BORDER=0 ALT="Previous Topic">
</A>
<A ID=buttonbar HREF="FSOUND.html">
<IMG SRC="u_index.gif" WIDTH="47" HEIGHT="16" BORDER=0 ALT="Index">
</A>
<A ID=buttonbar HREF="FSOUND_3D_SetDistanceFactor.html">
<IMG SRC="u_next.gif" WIDTH="48" HEIGHT="16" BORDER=0 ALT="Next Topic">
</A>
</FONT></TD><TD WIDTH=15></TD>
</TR>
</TABLE>
</A>
</SPAN>
<A HREF="FSOUND.html#Functions"><H5>[API function]</A></H5>
<H2><A NAME="FSOUND_3D_SetAttributes">FSOUND_3D_SetAttributes</A></H2>
This updates the position and velocity of a 3d sound playing on a channel.<BR>
<P>
<B>signed char F_API </B><B> </B><B>FSOUND_3D_SetAttributes</B><B>(</B><BR>
<B>int </B><B> </B><I>channel</I><B>,</B><BR>
<B>const F_FLOAT_API *</B><I>pos</I><B>,</B><BR>
<B>const F_FLOAT_API *</B><I>vel</I><BR>
<B>);</B><BR>
<H3>Parameters</H3>
<TABLE>
<TR VALIGN=top><TD><I>channel</I></TD>
<TD>Channel you want to apply 3d positioning to.<BR>
</TD><TR VALIGN=top><TD><I>pos</I></TD>
<TD>Pointer to a position vector (xyz float triplet) of the emitter in world space, measured in distance units.<BR>
This can be NULL to ignore it.<BR>
</TD><TR VALIGN=top><TD><I>vel</I></TD>
<TD>Pointer to a velocity vector (xyz float triplet), of the emitter measured in distance units PER SECOND.<BR>
This can be NULL to ignore it.<BR>
</TD></TABLE>
<H3>Return Value</H3>
On success, TRUE is returned.<BR>
On failure, FALSE is returned.<BR>
<H3>Remarks</H3>
FSOUND treats +X as right, +Y as up, and +Z as forwards.<BR>
---------<BR>
A 'distance unit' is specified by FSOUND_3D_SetDistanceFactor. By default this is set to meters which is a distance scale of 1.0. <BR>
See FSOUND_3D_SetDistanceFactor for more on this.<BR>
---------<BR>
FSOUND vectors expect 3 floats representing x y and z in that order. I.e. a typical definition<BR>
of a vector is<BR>
typedef struct<BR>
{<BR>
float x;<BR>
float y;<BR>
float z;<BR>
} VECTOR;<BR>
or simply an array of 3 floats.<BR>
___________________<BR>
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube<BR>
<H3>See Also</H3>
<A HREF="FSOUND_3D_GetAttributes.html">FSOUND_3D_GetAttributes</A>
,
<A HREF="FSOUND_3D_GetMinMaxDistance.html">FSOUND_3D_GetMinMaxDistance</A>
,
<A HREF="FSOUND_3D_Listener_GetAttributes.html">FSOUND_3D_Listener_GetAttributes</A>
,
<A HREF="FSOUND_3D_Listener_SetAttributes.html">FSOUND_3D_Listener_SetAttributes</A>
,
<A HREF="FSOUND_3D_Listener_SetCurrent.html">FSOUND_3D_Listener_SetCurrent</A>
,
<A HREF="FSOUND_3D_SetAttributes.html">FSOUND_3D_SetAttributes</A>
,
<A HREF="FSOUND_3D_SetDistanceFactor.html">FSOUND_3D_SetDistanceFactor</A>
,
<A HREF="FSOUND_3D_SetMinMaxDistance.html">FSOUND_3D_SetMinMaxDistance</A>
,
<A HREF="FSOUND_3D_SetRolloffFactor.html">FSOUND_3D_SetRolloffFactor</A>
,
<A HREF="FSOUND_Sample_SetMinMaxDistance.html">FSOUND_Sample_SetMinMaxDistance</A>
,
<A HREF="FSOUND_Update.html">FSOUND_Update</A>
<HR><BR><FONT SIZE="-2">This document copyright &copy;Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.</FONT><BR>
<FONT SIZE="-2">Generated Thu Dec 15 17:31:27 2005
by SourceDoc v0.10, the automated source code documenter.</FONT><BR>
</BODY>
</HTML>