Skip to content

GitLab

VAWebsite
VAWebsite
Commit a6c414ea authored by Dipl.-Ing. Jonas Stienen's avatar Dipl.-Ing. Jonas Stienen
Browse files
Options

Updating documentation

parent a571393d
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 125971 additions and 2181 deletions

Too many changes to show.

To preserve performance only 1000 of 1000+ files are displayed.
Plain diff Email patch
resources/v2018a/doc/html/VACore.html
View file @ a6c414ea
......@@ -18,7 +18,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Virtual Acoustics (VA) C++ API
&#160;<span id="projectnumber">v2018a</span>
&#160;<span id="projectnumber">v2017d</span>
</div>
<div id="projectbrief">Virtual Acoustics is a real-time auralization framework devoted to Virtual Reality.</div>
</td>
......@@ -41,17 +41,17 @@
<div class="contents">
<div class="textblock"><h1><a class="anchor" id="core_intro_sec"></a>
Introduction</h1>
<p><a class="el" href="namespace_v_a_core.html">VACore</a> provides the entire functionality of real-time auralization and reproduction. It includes scene management and a lot of extra functionality to display and export audio.</p>
<p>The Virtual Acoustics project is free, open source real-time auralization framework. It is distributed under the terms of the Apache License Version 2.0. The official website can be found at <a href="http://www.virtualacoustics.org">http://www.virtualacoustics.org</a></p>
<h1><a class="anchor" id="core_license_sec"></a>
License</h1>
<p>Copyright 2015-2017 Institute of Technical Acoustics (ITA), RWTH Aachen University</p>
<p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use the OpenDAFF software package except in compliance with the License. You may obtain a copy of the License at</p>
<p><a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></p>
<p>Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.</p>
<p>You should also have received a copy of the License with the VA software package.</p>
<h1><a class="anchor" id="core_getting_started_sec"></a>
Getting started</h1>
<p>If you are a C++ developer and you want to integrate VA into your application, the first contact point should be the interface represented by the <a class="el" href="class_i_v_a_interface.html" title="Interface of Virtual Acoustics (VA) ">IVAInterface</a> class in the VABase project. If you are planning to create a new binding for any other programming and/or scripting language, also have a look at VANet and the <a class="el" href="class_i_v_a_net_client.html" title="Networked transparend calls to VA interface view TCP/IP as a client. ">IVANetClient</a> class.</p>
<h1><a class="anchor" id="core_developer_sec"></a>
Developers</h1>
<p>If you want to create your own auralization module, you will have to</p><ul>
<li>implement a rendering module that is compatible with #IVAAudioRenderer</li>
<li>implement a reproduction module that is compatible with #IVAAudioReproduction</li>
</ul>
<p>Also, add a code line that registers your module at the corresponding registry. </p>
<p>If you are a C++ developer and want to integrate VA into your application, the first contact point should be the VABase interface representad by the <a class="el" href="class_i_v_a_interface.html" title="Interface of Virtual Acoustics (VA) ">IVAInterface</a> class. If you are planning to create a binding for any other programming and/or scripting language, also have a look at VANet and the <a class="el" href="class_i_v_a_net_client.html" title="Networked transparend calls to VA interface view TCP/IP as a client. ">IVANetClient</a> class. If you want to </p>
</div></div><!-- contents -->
</DIV>
<DIV STYLE="margin-top: 6em;">
......@@ -59,7 +59,7 @@ Developers</h1>
Virtual Acoustics (VA) | <a href="http://www.virtualacoustics.org">http://www.virtualacoustics.org</a> <br>
Source code licensed under the Apache License, Version 2.0 <br />
C++ API documentation auto generated and licensed under <a href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution License 4.0</a> <br />
&copy 2017-2018 <a href="http://www.akustik.rwth-aachen.de">Institute of Technical Acoustics (ITA)</a> <br /> RWTH Aachen University, Germany.
<a href="http://www.akustik.rwth-aachen.de">Institute of Technical Acoustics (ITA)</a> <br /> RWTH Aachen University, Germany.
</CENTER>
</DIV>
</BODY>
......
resources/v2018a/doc/html/VANet.html
View file @ a6c414ea
......@@ -18,7 +18,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Virtual Acoustics (VA) C++ API
&#160;<span id="projectnumber">v2018a</span>
&#160;<span id="projectnumber">v2017d</span>
</div>
<div id="projectbrief">Virtual Acoustics is a real-time auralization framework devoted to Virtual Reality.</div>
</td>
......@@ -44,8 +44,8 @@ VANet</h1>
<p>VANet provides a transparent network communication of calls to the VA interface. It is useful to control a VA server remotely and is the standard way to communicate with VA for inter-process methods and bindings for other scripting languages.</p>
<h1><a class="anchor" id="vanet_license_sec"></a>
License</h1>
<p>Copyright 2015-2018 Institute of Technical Acoustics (ITA), RWTH Aachen University</p>
<p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use the VA software package except in compliance with the License. You may obtain a copy of the License at</p>
<p>Copyright 2015-2017 Institute of Technical Acoustics (ITA), RWTH Aachen University</p>
<p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use the OpenDAFF software package except in compliance with the License. You may obtain a copy of the License at</p>
<p><a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></p>
<p>Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.</p>
<p>You should also have received a copy of the License with the VA software package.</p>
......@@ -59,7 +59,7 @@ Getting started</h1>
Virtual Acoustics (VA) | <a href="http://www.virtualacoustics.org">http://www.virtualacoustics.org</a> <br>
Source code licensed under the Apache License, Version 2.0 <br />
C++ API documentation auto generated and licensed under <a href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution License 4.0</a> <br />
&copy 2017-2018 <a href="http://www.akustik.rwth-aachen.de">Institute of Technical Acoustics (ITA)</a> <br /> RWTH Aachen University, Germany.
<a href="http://www.akustik.rwth-aachen.de">Institute of Technical Acoustics (ITA)</a> <br /> RWTH Aachen University, Germany.
</CENTER>
</DIV>
</BODY>
......
resources/v2018a/doc/html/_l_i_c_e_n_s_e_8md.html 0 → 100644
View file @ a6c414ea
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Virtual Acoustics (VA) C++ API: C:/dev/VA/VAServer/LICENSE.md File 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="doxygen.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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Virtual Acoustics (VA) C++ API
&#160;<span id="projectnumber">v2017d</span>
</div>
<div id="projectbrief">Virtual Acoustics is a real-time auralization framework devoted to Virtual Reality.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">C:/dev/VA/VAServer/LICENSE.md File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a href="_l_i_c_e_n_s_e_8md_source.html">Go to the source code of this file.</a></p>
</div><!-- contents -->
</DIV>
<DIV STYLE="margin-top: 6em;">
<CENTER>
Virtual Acoustics (VA) | <a href="http://www.virtualacoustics.org">http://www.virtualacoustics.org</a> <br>