Skip to content

Commit

Permalink
Deploy preview for PR 1282 🛫
Browse files Browse the repository at this point in the history
  • Loading branch information
@joaomanita
joaomanita committed Oct 19, 2024
1 parent 41f2b04 commit d4348ae
Show file tree
Hide file tree
Showing 57 changed files with 3,740 additions and 1,207 deletions.
16 changes: 5 additions & 11 deletions preview/pr-1282/annotated.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,13 @@ <h1>Classes</h1>
<li class="m-doc-collapsible collapsed">
<a href="#" onclick="return toggle(this)">namespace</a> <a href="namespacecubos_1_1core_1_1al_1_1impl.html" class="m-doc">impl</a> <span class="m-doc">Namespace to store the abstract types implemented by the audio device implementations.</span>
<ul class="m-doc">
<li>class <a href="classcubos_1_1core_1_1al_1_1impl_1_1AudioDevice.html" class="m-doc">AudioDevice</a> <span class="m-doc">Audio device interface used to wrap low-level audio rendering APIs.</span></li>
<li>class <a href="classcubos_1_1core_1_1al_1_1impl_1_1Buffer.html" class="m-doc">Buffer</a> <span class="m-doc">Abstract audio buffer.</span></li>
<li>class <a href="classcubos_1_1core_1_1al_1_1impl_1_1Source.html" class="m-doc">Source</a> <span class="m-doc">Abstract audio source.</span></li>
</ul>
</li>
<li>class <a href="classcubos_1_1core_1_1al_1_1AudioDevice.html" class="m-doc">AudioDevice</a> <span class="m-doc">Audio device interface used to wrap low-level audio rendering APIs.</span></li>
<li>class <a href="classcubos_1_1core_1_1al_1_1AudioContext.html" class="m-doc">AudioContext</a> <span class="m-doc">Audio context that contains audio devices;.</span></li>
<li>class <a href="classcubos_1_1core_1_1al_1_1MiniaudioContext.html" class="m-doc">MiniaudioContext</a> <span class="m-doc">Audio device implementation using miniaudio.</span></li>
</ul>
</li>
<li class="m-doc-collapsible collapsed">
Expand Down Expand Up @@ -403,6 +405,7 @@ <h1>Classes</h1>
<li class="m-doc-collapsible collapsed">
<a href="#" onclick="return toggle(this)">namespace</a> <a href="namespacecubos_1_1core_1_1thread.html" class="m-doc">thread</a> <span class="m-doc"><a href="group__core-thread.html" class="m-doc">Threading</a> module.</span>
<ul class="m-doc">
<li>class <a href="classcubos_1_1core_1_1thread_1_1Process.html" class="m-doc">Process</a> <span class="m-label m-flat m-warning">final</span> <span class="m-doc">Provides a cross-platform way to spawn child processes.</span></li>
<li class="m-doc-collapsible collapsed">
<a href="#" onclick="return toggle(this)">class</a> <a href="classcubos_1_1core_1_1thread_1_1Task.html" class="m-doc">Task</a> <span class="m-label m-flat m-warning">final</span> <span class="m-doc">Provides a mechanism to access the results of asynchronous operations.</span>
<ul class="m-doc">
Expand All @@ -412,16 +415,6 @@ <h1>Classes</h1>
<li>class <a href="classcubos_1_1core_1_1thread_1_1ThreadPool.html" class="m-doc">ThreadPool</a> <span class="m-label m-flat m-warning">final</span> <span class="m-doc">Manages a pool of threads, to which tasks can be submitted.</span></li>
</ul>
</li>
<li class="m-doc-collapsible collapsed">
<a href="#" onclick="return toggle(this)">class</a> <a href="classcubos_1_1core_1_1Logger.html" class="m-doc">Logger</a> <span class="m-label m-flat m-warning">final</span> <span class="m-doc">Singleton which holds the logging state.</span>
<ul class="m-doc">
<li>struct <a href="structcubos_1_1core_1_1Logger_1_1Entry.html" class="m-doc">Entry</a> <span class="m-doc">Data created by a call to log.</span></li>
<li>struct <a href="structcubos_1_1core_1_1Logger_1_1Location.html" class="m-doc">Location</a> <span class="m-doc">Identifies a location in the code.</span></li>
<li>struct <a href="structcubos_1_1core_1_1Logger_1_1Timestamp.html" class="m-doc">Timestamp</a> <span class="m-doc">A timestamp used to identify when a logging message was written.</span></li>
</ul>
</li>
<li>class <a href="classcubos_1_1core_1_1Metrics.html" class="m-doc">Metrics</a> <span class="m-doc">Singleton class that manages a collection of metrics.</span></li>
<li>class <a href="classcubos_1_1core_1_1ScopeProfiler.html" class="m-doc">ScopeProfiler</a> <span class="m-doc">Utility to measure the execution time of a scope.</span></li>
</ul>
</li>
<li class="m-doc-collapsible collapsed">
Expand Down Expand Up @@ -591,6 +584,7 @@ <h1>Classes</h1>
<a href="#" onclick="return toggle(this)">namespace</a> <a href="namespacetesseratos.html" class="m-doc">tesseratos</a> <span class="m-doc"><a href="group__tesseratos.html" class="m-doc">Tesseratos</a> namespace.</span>
<ul class="m-doc">
<li>struct <a href="structtesseratos_1_1AssetSelectedEvent.html" class="m-doc">AssetSelectedEvent</a> <span class="m-doc">Event sent when an asset is selected.</span></li>
<li>class <a href="classtesseratos_1_1ProjectManager.html" class="m-doc">ProjectManager</a> <span class="m-doc">System argument which can be used to manage the currently loaded project.</span></li>
</ul>
</li>
</ul>
Expand Down
31 changes: 15 additions & 16 deletions preview/pr-1282/audio__device_8hpp.html → preview/pr-1282/audio__context_8hpp.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>core/al/audio_device.hpp file | Cubos Docs</title>
<title>core/al/audio_context.hpp file | Cubos Docs</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
<link rel="stylesheet" href="m-dark+documentation.compiled.css" />
<link rel="icon" href="Favicon.png" type="image/png" />
Expand Down Expand Up @@ -46,9 +46,9 @@
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
<h1>
<span class="m-breadcrumb"><a href="dir_6c897dd97bedf3914ee8a4d9f7f6549c.html">core</a>/</span><span class="m-breadcrumb"><a href="dir_f6f65ff657bd34b22e5078310628f4e7.html">al</a>/</span>audio_device.hpp <span class="m-thin">file</span>
<span class="m-breadcrumb"><a href="dir_6c897dd97bedf3914ee8a4d9f7f6549c.html">core</a>/</span><span class="m-breadcrumb"><a href="dir_f6f65ff657bd34b22e5078310628f4e7.html">al</a>/</span>audio_context.hpp <span class="m-thin">file</span>
</h1>
<p>Class <a href="classcubos_1_1core_1_1al_1_1AudioDevice.html" class="m-doc">cubos::<wbr />core::<wbr />al::<wbr />AudioDevice</a> and related types.</p>
<p>Class <a href="classcubos_1_1core_1_1al_1_1AudioContext.html" class="m-doc">cubos::<wbr />core::<wbr />al::<wbr />AudioContext</a> and related types.</p>
<nav class="m-block m-default">
<h3>Contents</h3>
<ul>
Expand All @@ -57,7 +57,6 @@ <h3>Contents</h3>
<ul>
<li><a href="#namespaces">Namespaces</a></li>
<li><a href="#nested-classes">Classes</a></li>
<li><a href="#enum-members">Enums</a></li>
<li><a href="#typedef-members">Typedefs</a></li>
</ul>
</li>
Expand All @@ -80,9 +79,9 @@ <h2><a href="#namespaces">Namespaces</a></h2>
<h2><a href="#nested-classes">Classes</a></h2>
<dl class="m-doc">
<dt>
class <a href="classcubos_1_1core_1_1al_1_1AudioDevice.html" class="m-doc">cubos::core::al::AudioDevice</a>
class <a href="classcubos_1_1core_1_1al_1_1AudioContext.html" class="m-doc">cubos::core::al::AudioContext</a>
</dt>
<dd>Audio device interface used to wrap low-level audio rendering APIs.</dd>
<dd>Audio context that contains audio devices;.</dd>
<dt>
class <a href="classcubos_1_1core_1_1al_1_1impl_1_1Buffer.html" class="m-doc">cubos::core::al::impl::Buffer</a>
</dt>
Expand All @@ -91,18 +90,10 @@ <h2><a href="#nested-classes">Classes</a></h2>
class <a href="classcubos_1_1core_1_1al_1_1impl_1_1Source.html" class="m-doc">cubos::core::al::impl::Source</a>
</dt>
<dd>Abstract audio source.</dd>
</dl>
</section>
<section id="enum-members">
<h2><a href="#enum-members">Enums</a></h2>
<dl class="m-doc">
<dt>
<span class="m-doc-wrap-bumper">enum class <a href="namespacecubos_1_1core_1_1al.html#a4d801c5155ac7b63ffb25b4eadc201b3" class="m-doc">Format</a> { </span><span class="m-doc-wrap"><a href="#a4d801c5155ac7b63ffb25b4eadc201b3abc5c44624758954f1a4af1e009f5cf6e" class="m-doc">Mono8</a>,
<a href="#a4d801c5155ac7b63ffb25b4eadc201b3aab2f4f7e4448e8c91c89774787a1cc2c" class="m-doc">Mono16</a>,
<a href="#a4d801c5155ac7b63ffb25b4eadc201b3ac6b222ce6dafa010da034571a80c21f3" class="m-doc">Stereo8</a>,
<a href="#a4d801c5155ac7b63ffb25b4eadc201b3a851cd6283aaf71edd18bb2fcda2505f4" class="m-doc">Stereo16</a> }</span>
class <a href="classcubos_1_1core_1_1al_1_1impl_1_1AudioDevice.html" class="m-doc">cubos::core::al::impl::AudioDevice</a>
</dt>
<dd>Possible audio formats.</dd>
<dd>Audio device interface used to wrap low-level audio rendering APIs.</dd>
</dl>
</section>
<section id="typedef-members">
Expand All @@ -116,6 +107,14 @@ <h2><a href="#typedef-members">Typedefs</a></h2>
using <a href="group__core-al.html#ga0cc30a9a62066f32d33e96e39c60d3bf" class="m-doc">Source</a> = std::shared_ptr&lt;impl::Source&gt;
</dt>
<dd>Handle to an audio source.</dd>
<dt>
using <a href="group__core-al.html#ga8484e4c0384c146bb8772b75f475f77d" class="m-doc">Listener</a> = std::shared_ptr&lt;impl::Listener&gt;
</dt>
<dd>Handle to an audio listener.</dd>
<dt>
using <a href="group__core-al.html#gac457570e93f052ef01c4a84fdeee8df2" class="m-doc">AudioDevice</a> = std::shared_ptr&lt;impl::AudioDevice&gt;
</dt>
<dd>Handle to an audio device.</dd>
</dl>
</section>
</div>
Expand Down
Loading

0 comments on commit d4348ae

Please sign in to comment.