TorqueEngine
/
Torque2D
mirror of https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Torque2D Reference: Description Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Torque2D Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespace_audio.html">Audio</a></li><li class="navelem"><a class="el" href="struct_audio_1_1_description.html">Description</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="struct_audio_1_1_description-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">Description Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;platformAudio.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:add0c5d891a261a8e83668583abdca4fd" id="r_add0c5d891a261a8e83668583abdca4fd"><td class="memItemLeft" align="right" valign="top">F32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_audio_1_1_description.html#add0c5d891a261a8e83668583abdca4fd">mVolume</a></td></tr>
<tr class="separator:add0c5d891a261a8e83668583abdca4fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd4c0c3484ff6ba4568c365b399d7585" id="r_abd4c0c3484ff6ba4568c365b399d7585"><td class="memItemLeft" align="right" valign="top">S32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_audio_1_1_description.html#abd4c0c3484ff6ba4568c365b399d7585">mVolumeChannel</a></td></tr>
<tr class="separator:abd4c0c3484ff6ba4568c365b399d7585"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a611ffd732b6553714cf17d0b3484503c" id="r_a611ffd732b6553714cf17d0b3484503c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_audio_1_1_description.html#a611ffd732b6553714cf17d0b3484503c">mIsLooping</a></td></tr>
<tr class="separator:a611ffd732b6553714cf17d0b3484503c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32b9369855e2ce890b4eb2df7c433694" id="r_a32b9369855e2ce890b4eb2df7c433694"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_audio_1_1_description.html#a32b9369855e2ce890b4eb2df7c433694">mIsStreaming</a></td></tr>
<tr class="separator:a32b9369855e2ce890b4eb2df7c433694"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61dc1009fd2303fe1f09958fd15f07d0" id="r_a61dc1009fd2303fe1f09958fd15f07d0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_audio_1_1_description.html#a61dc1009fd2303fe1f09958fd15f07d0">mIs3D</a></td></tr>
<tr class="separator:a61dc1009fd2303fe1f09958fd15f07d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f3eda51e7a35af9af42ceb965152f80" id="r_a7f3eda51e7a35af9af42ceb965152f80"><td class="memItemLeft" align="right" valign="top">F32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_audio_1_1_description.html#a7f3eda51e7a35af9af42ceb965152f80">mReferenceDistance</a></td></tr>
<tr class="separator:a7f3eda51e7a35af9af42ceb965152f80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba0de08c1284afeae82c967f3f41236d" id="r_aba0de08c1284afeae82c967f3f41236d"><td class="memItemLeft" align="right" valign="top">F32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_audio_1_1_description.html#aba0de08c1284afeae82c967f3f41236d">mMaxDistance</a></td></tr>
<tr class="separator:aba0de08c1284afeae82c967f3f41236d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a228eea9bde0709b5d1e3068f16e07f88" id="r_a228eea9bde0709b5d1e3068f16e07f88"><td class="memItemLeft" align="right" valign="top">U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_audio_1_1_description.html#a228eea9bde0709b5d1e3068f16e07f88">mConeInsideAngle</a></td></tr>
<tr class="separator:a228eea9bde0709b5d1e3068f16e07f88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3548713f9c9183f42ff058e5deffdb65" id="r_a3548713f9c9183f42ff058e5deffdb65"><td class="memItemLeft" align="right" valign="top">U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_audio_1_1_description.html#a3548713f9c9183f42ff058e5deffdb65">mConeOutsideAngle</a></td></tr>
<tr class="separator:a3548713f9c9183f42ff058e5deffdb65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a04071033427ec869e7fe76d0759b1c" id="r_a0a04071033427ec869e7fe76d0759b1c"><td class="memItemLeft" align="right" valign="top">F32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_audio_1_1_description.html#a0a04071033427ec869e7fe76d0759b1c">mConeOutsideVolume</a></td></tr>
<tr class="separator:a0a04071033427ec869e7fe76d0759b1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abcb0d797f4e71fc0e2ebbe8702493b20" id="r_abcb0d797f4e71fc0e2ebbe8702493b20"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_point3_f.html">Point3F</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_audio_1_1_description.html#abcb0d797f4e71fc0e2ebbe8702493b20">mConeVector</a></td></tr>
<tr class="separator:abcb0d797f4e71fc0e2ebbe8702493b20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4afcedbddf4ff28dccc3c6f2fbc8bec0" id="r_a4afcedbddf4ff28dccc3c6f2fbc8bec0"><td class="memItemLeft" align="right" valign="top">F32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_audio_1_1_description.html#a4afcedbddf4ff28dccc3c6f2fbc8bec0">mEnvironmentLevel</a></td></tr>
<tr class="separator:a4afcedbddf4ff28dccc3c6f2fbc8bec0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a228eea9bde0709b5d1e3068f16e07f88" name="a228eea9bde0709b5d1e3068f16e07f88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a228eea9bde0709b5d1e3068f16e07f88">&#9670;&#160;</a></span>mConeInsideAngle</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">U32 mConeInsideAngle</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a3548713f9c9183f42ff058e5deffdb65" name="a3548713f9c9183f42ff058e5deffdb65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3548713f9c9183f42ff058e5deffdb65">&#9670;&#160;</a></span>mConeOutsideAngle</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">U32 mConeOutsideAngle</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a0a04071033427ec869e7fe76d0759b1c" name="a0a04071033427ec869e7fe76d0759b1c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a04071033427ec869e7fe76d0759b1c">&#9670;&#160;</a></span>mConeOutsideVolume</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">F32 mConeOutsideVolume</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="abcb0d797f4e71fc0e2ebbe8702493b20" name="abcb0d797f4e71fc0e2ebbe8702493b20"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abcb0d797f4e71fc0e2ebbe8702493b20">&#9670;&#160;</a></span>mConeVector</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_point3_f.html">Point3F</a> mConeVector</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a4afcedbddf4ff28dccc3c6f2fbc8bec0" name="a4afcedbddf4ff28dccc3c6f2fbc8bec0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4afcedbddf4ff28dccc3c6f2fbc8bec0">&#9670;&#160;</a></span>mEnvironmentLevel</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">F32 mEnvironmentLevel</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a61dc1009fd2303fe1f09958fd15f07d0" name="a61dc1009fd2303fe1f09958fd15f07d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61dc1009fd2303fe1f09958fd15f07d0">&#9670;&#160;</a></span>mIs3D</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool mIs3D</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a611ffd732b6553714cf17d0b3484503c" name="a611ffd732b6553714cf17d0b3484503c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a611ffd732b6553714cf17d0b3484503c">&#9670;&#160;</a></span>mIsLooping</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool mIsLooping</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a32b9369855e2ce890b4eb2df7c433694" name="a32b9369855e2ce890b4eb2df7c433694"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32b9369855e2ce890b4eb2df7c433694">&#9670;&#160;</a></span>mIsStreaming</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool mIsStreaming</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="aba0de08c1284afeae82c967f3f41236d" name="aba0de08c1284afeae82c967f3f41236d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba0de08c1284afeae82c967f3f41236d">&#9670;&#160;</a></span>mMaxDistance</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">F32 mMaxDistance</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a7f3eda51e7a35af9af42ceb965152f80" name="a7f3eda51e7a35af9af42ceb965152f80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f3eda51e7a35af9af42ceb965152f80">&#9670;&#160;</a></span>mReferenceDistance</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">F32 mReferenceDistance</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="add0c5d891a261a8e83668583abdca4fd" name="add0c5d891a261a8e83668583abdca4fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add0c5d891a261a8e83668583abdca4fd">&#9670;&#160;</a></span>mVolume</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">F32 mVolume</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="abd4c0c3484ff6ba4568c365b399d7585" name="abd4c0c3484ff6ba4568c365b399d7585"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd4c0c3484ff6ba4568c365b399d7585">&#9670;&#160;</a></span>mVolumeChannel</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">S32 mVolumeChannel</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>platform/<b>platformAudio.h</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>