deploy: 9f6aac1

GameDevTecnico · Nov 29, 2024 · 1c8a6d4 · 1c8a6d4
1 parent d5eb498
commit 1c8a6d4
Show file tree

Hide file tree

Showing 67 changed files with 2,130 additions and 102 deletions.
diff --git a/annotated.html b/annotated.html
@@ -467,6 +467,11 @@ <h1>Classes</h1>
                   </li>
                   <li>struct <a href="structcubos_1_1engine_1_1Audio.html" class="m-doc">Audio</a> <span class="m-doc"><a href="classcubos_1_1engine_1_1Asset.html" class="m-doc">Asset</a> containing raw <a href="structcubos_1_1engine_1_1Audio.html" class="m-doc">Audio</a> data.</span></li>
                   <li>class <a href="classcubos_1_1engine_1_1AudioBridge.html" class="m-doc">AudioBridge</a> <span class="m-doc">Bridge which loads and saves <a href="structcubos_1_1engine_1_1Audio.html" class="m-doc">Audio</a> assets.</span></li>
+                  <li>struct <a href="structcubos_1_1engine_1_1AudioListener.html" class="m-doc">AudioListener</a> <span class="m-doc">Component which adds an <a href="structcubos_1_1engine_1_1AudioListener.html" class="m-doc">AudioListener</a> to the entitiy.</span></li>
+                  <li>struct <a href="structcubos_1_1engine_1_1AudioPause.html" class="m-doc">AudioPause</a> <span class="m-doc">Component which triggers the pause of an audio source.</span></li>
+                  <li>struct <a href="structcubos_1_1engine_1_1AudioPlay.html" class="m-doc">AudioPlay</a> <span class="m-doc">Component which triggers the play of an audio source.</span></li>
+                  <li>struct <a href="structcubos_1_1engine_1_1AudioSource.html" class="m-doc">AudioSource</a> <span class="m-doc">Component which makes an entity emit sound.</span></li>
+                  <li>struct <a href="structcubos_1_1engine_1_1AudioStop.html" class="m-doc">AudioStop</a> <span class="m-doc">Component which triggers the stop of an audio source.</span></li>
                   <li>struct <a href="structcubos_1_1engine_1_1Bloom.html" class="m-doc">Bloom</a> <span class="m-doc">Component which stores the <a href="structcubos_1_1engine_1_1Bloom.html" class="m-doc">Bloom</a> state for a render target.</span></li>
                   <li>struct <a href="structcubos_1_1engine_1_1BoxCollisionShape.html" class="m-doc">BoxCollisionShape</a> <span class="m-doc">Component which adds a box collision shape to an entity, used with a <a href="structcubos_1_1engine_1_1Collider.html" class="m-doc">Collider</a> component.</span></li>
                   <li>struct <a href="structcubos_1_1engine_1_1Camera.html" class="m-doc">Camera</a> <span class="m-doc">Generic component to hold the projection matrix of a specific camera (either perspective or orthogonal).</span></li>

diff --git a/classcubos_1_1core_1_1al_1_1AudioContext.html b/classcubos_1_1core_1_1al_1_1AudioContext.html
@@ -84,6 +84,10 @@ <h2><a href="#pub-static-methods">Public static functions</a></h2>
         <section id="pub-methods">
           <h2><a href="#pub-methods">Public functions</a></h2>
           <dl class="m-doc">
+            <dt>
+              <span class="m-doc-wrap-bumper">auto <a href="#a6e92494f4a432115aed2c5bc5dfcbcf8" class="m-doc">getMaxListenerCount</a>(</span><span class="m-doc-wrap">) const -&gt; int <span class="m-label m-flat m-warning">pure virtual</span></span>
+            </dt>
+            <dd>Gets the maximum number of listeners supported by the audio context.</dd>
             <dt>
               <span class="m-doc-wrap-bumper">void <a href="#adb45ce63ac2b9fbf9a9b248b0945be25" class="m-doc">enumerateDevices</a>(</span><span class="m-doc-wrap">std::vector&lt;std::string&gt;&amp; devices) <span class="m-label m-flat m-warning">pure virtual</span></span>
             </dt>
@@ -98,6 +102,10 @@ <h2><a href="#pub-methods">Public functions</a></h2>
               size_t dataSize) -&gt; <a href="group__core-al.html#gabf798aa0b180fc8bba2872789bab349e" class="m-doc">Buffer</a> <span class="m-label m-flat m-warning">pure virtual</span></span>
             </dt>
             <dd>Creates a new audio buffer.</dd>
+            <dt>
+              <span class="m-doc-wrap-bumper">auto <a href="#a6a65b5fed5bf7ab4e6fd1e6617a2c928" class="m-doc">getDefaultDevice</a>(</span><span class="m-doc-wrap">) -&gt; std::string <span class="m-label m-flat m-warning">pure virtual</span></span>
+            </dt>
+            <dd>Gets the default audio device.</dd>
           </dl>
         </section>
         <section>
@@ -116,6 +124,20 @@ <h3>
               </tfoot>
             </table>
           </div></section>
+          <section class="m-doc-details" id="a6e92494f4a432115aed2c5bc5dfcbcf8"><div>
+            <h3>
+              <span class="m-doc-wrap-bumper">int cubos::<wbr />core::<wbr />al::<wbr />AudioContext::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a6e92494f4a432115aed2c5bc5dfcbcf8" class="m-doc-self">getMaxListenerCount</a>(</span><span class="m-doc-wrap">) const <span class="m-label m-warning">pure virtual</span></span></span>
+            </h3>
+            <p>Gets the maximum number of listeners supported by the audio context.</p>
+            <table class="m-table m-fullwidth m-flat">
+              <tfoot>
+                <tr>
+                  <th style="width: 1%">Returns</th>
+                  <td>Maximum number of listeners.</td>
+                </tr>
+              </tfoot>
+            </table>
+          </div></section>
           <section class="m-doc-details" id="adb45ce63ac2b9fbf9a9b248b0945be25"><div>
             <h3>
               <span class="m-doc-wrap-bumper">void cubos::<wbr />core::<wbr />al::<wbr />AudioContext::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#adb45ce63ac2b9fbf9a9b248b0945be25" class="m-doc-self">enumerateDevices</a>(</span><span class="m-doc-wrap">std::vector&lt;std::string&gt;&amp; devices) <span class="m-label m-warning">pure virtual</span></span></span>
@@ -189,6 +211,20 @@ <h3>
               </tfoot>
             </table>
           </div></section>
+          <section class="m-doc-details" id="a6a65b5fed5bf7ab4e6fd1e6617a2c928"><div>
+            <h3>
+              <span class="m-doc-wrap-bumper">std::string cubos::<wbr />core::<wbr />al::<wbr />AudioContext::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a6a65b5fed5bf7ab4e6fd1e6617a2c928" class="m-doc-self">getDefaultDevice</a>(</span><span class="m-doc-wrap">) <span class="m-label m-warning">pure virtual</span></span></span>
+            </h3>
+            <p>Gets the default audio device.</p>
+            <table class="m-table m-fullwidth m-flat">
+              <tfoot>
+                <tr>
+                  <th style="width: 1%">Returns</th>
+                  <td>Name of the default audio device.</td>
+                </tr>
+              </tfoot>
+            </table>
+          </div></section>
         </section>
       </div>
     </div>

diff --git a/classcubos_1_1core_1_1al_1_1MiniaudioContext.html b/classcubos_1_1core_1_1al_1_1MiniaudioContext.html
@@ -87,6 +87,14 @@ <h2><a href="#pub-methods">Public functions</a></h2>
               <span class="m-doc-wrap-bumper">void <a href="#aef15b7952f0ca81af4037c045362fff0" class="m-doc">enumerateDevices</a>(</span><span class="m-doc-wrap">std::vector&lt;std::string&gt;&amp; devices) <span class="m-label m-flat m-warning">override</span></span>
             </dt>
             <dd>Enumerates the available devices.</dd>
+            <dt>
+              <span class="m-doc-wrap-bumper">auto <a href="#aff208673bff009202971af2cac4e50ce" class="m-doc">getMaxListenerCount</a>(</span><span class="m-doc-wrap">) const -&gt; int <span class="m-label m-flat m-warning">override</span></span>
+            </dt>
+            <dd>Gets the maximum number of listeners supported by the audio context.</dd>
+            <dt>
+              <span class="m-doc-wrap-bumper">auto <a href="#ab015edf158ece28802af6fb7de3c7134" class="m-doc">getDefaultDevice</a>(</span><span class="m-doc-wrap">) -&gt; std::string <span class="m-label m-flat m-warning">override</span></span>
+            </dt>
+            <dd>Gets the default audio device.</dd>
           </dl>
         </section>
         <section>
@@ -164,6 +172,34 @@ <h3>
               </tbody>
             </table>
           </div></section>
+          <section class="m-doc-details" id="aff208673bff009202971af2cac4e50ce"><div>
+            <h3>
+              <span class="m-doc-wrap-bumper">int cubos::<wbr />core::<wbr />al::<wbr />MiniaudioContext::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aff208673bff009202971af2cac4e50ce" class="m-doc-self">getMaxListenerCount</a>(</span><span class="m-doc-wrap">) const <span class="m-label m-warning">override</span></span></span>
+            </h3>
+            <p>Gets the maximum number of listeners supported by the audio context.</p>
+            <table class="m-table m-fullwidth m-flat">
+              <tfoot>
+                <tr>
+                  <th style="width: 1%">Returns</th>
+                  <td>Maximum number of listeners.</td>
+                </tr>
+              </tfoot>
+            </table>
+          </div></section>
+          <section class="m-doc-details" id="ab015edf158ece28802af6fb7de3c7134"><div>
+            <h3>
+              <span class="m-doc-wrap-bumper">std::string cubos::<wbr />core::<wbr />al::<wbr />MiniaudioContext::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ab015edf158ece28802af6fb7de3c7134" class="m-doc-self">getDefaultDevice</a>(</span><span class="m-doc-wrap">) <span class="m-label m-warning">override</span></span></span>
+            </h3>
+            <p>Gets the default audio device.</p>
+            <table class="m-table m-fullwidth m-flat">
+              <tfoot>
+                <tr>
+                  <th style="width: 1%">Returns</th>
+                  <td>Name of the default audio device.</td>
+                </tr>
+              </tfoot>
+            </table>
+          </div></section>
         </section>
       </div>
     </div>

diff --git a/classcubos_1_1core_1_1al_1_1impl_1_1AudioDevice.html b/classcubos_1_1core_1_1al_1_1impl_1_1AudioDevice.html
@@ -81,7 +81,7 @@ <h2><a href="#pub-methods">Public functions</a></h2>
             <dt>
               <span class="m-doc-wrap-bumper">auto <a href="#a9ce71588ad64246b8112ff7093af38f8" class="m-doc">listener</a>(</span><span class="m-doc-wrap">size_t index) -&gt; std::shared_ptr&lt;<a href="classcubos_1_1core_1_1al_1_1impl_1_1Listener.html" class="m-doc">impl::<wbr />Listener</a>&gt; <span class="m-label m-flat m-warning">pure virtual</span></span>
             </dt>
-            <dd>Creates a new audio listener.</dd>
+            <dd>Gets the listener with the specific index.</dd>
           </dl>
         </section>
         <section>
@@ -104,12 +104,21 @@ <h3>
             <h3>
               <span class="m-doc-wrap-bumper">std::shared_ptr&lt;<a href="classcubos_1_1core_1_1al_1_1impl_1_1Listener.html" class="m-doc">impl::<wbr />Listener</a>&gt; cubos::<wbr />core::<wbr />al::<wbr />impl::<wbr />AudioDevice::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a9ce71588ad64246b8112ff7093af38f8" class="m-doc-self">listener</a>(</span><span class="m-doc-wrap">size_t index) <span class="m-label m-warning">pure virtual</span></span></span>
             </h3>
-            <p>Creates a new audio listener.</p>
+            <p>Gets the listener with the specific index.</p>
             <table class="m-table m-fullwidth m-flat">
+              <thead>
+                <tr><th colspan="2">Parameters</th></tr>
+              </thead>
+              <tbody>
+                <tr>
+                  <td style="width: 1%">index</td>
+                  <td>Index of the listener.</td>
+                </tr>
+              </tbody>
               <tfoot>
                 <tr>
-                  <th style="width: 1%">Returns</th>
-                  <td>Handle of the new listener.</td>
+                  <th>Returns</th>
+                  <td>Handle of the listener.</td>
                 </tr>
               </tfoot>
             </table>

diff --git a/classcubos_1_1core_1_1al_1_1impl_1_1Source.html b/classcubos_1_1core_1_1al_1_1impl_1_1Source.html
@@ -114,6 +114,14 @@ <h2><a href="#pub-methods">Public functions</a></h2>
               <span class="m-doc-wrap-bumper">void <a href="#ab83ed9423ffbe173aa09044143189629" class="m-doc-self">play</a>(</span><span class="m-doc-wrap">) <span class="m-label m-flat m-warning">pure virtual</span></span>
             </dt>
             <dd>Plays the source.</dd>
+            <dt id="aa0126081a11410dc05a09564504cc6f1">
+              <span class="m-doc-wrap-bumper">void <a href="#aa0126081a11410dc05a09564504cc6f1" class="m-doc-self">stop</a>(</span><span class="m-doc-wrap">) <span class="m-label m-flat m-warning">pure virtual</span></span>
+            </dt>
+            <dd>Stops the source, restarting buffer to position 0.</dd>
+            <dt id="ae78100cab8d7cb4bc986dc319e9b2134">
+              <span class="m-doc-wrap-bumper">void <a href="#ae78100cab8d7cb4bc986dc319e9b2134" class="m-doc-self">pause</a>(</span><span class="m-doc-wrap">) <span class="m-label m-flat m-warning">pure virtual</span></span>
+            </dt>
+            <dd>Pauses the source, allowing to be played from the moment it was paused.</dd>
           </dl>
         </section>
         <section>

diff --git a/classcubos_1_1engine_1_1AnyAsset.html b/classcubos_1_1engine_1_1AnyAsset.html
@@ -95,6 +95,11 @@ <h2><a href="#derived-classes">Derived classes</a></h2>
               class <a href="classcubos_1_1engine_1_1Asset.html" class="m-doc">Asset</a>
             </dt>
             <dd>Handle to an asset of a specific type.</dd>
+            <dt>
+              <div class="m-doc-template">template&lt;typename T&gt;</div>
+              class <a href="classcubos_1_1engine_1_1Asset.html" class="m-doc">Asset</a>
+            </dt>
+            <dd>Handle to an asset of a specific type.</dd>
           </dl>
         </section>
         <section id="pub-types">