McSinyx
/
palace
mirror of https://github.com/McSinyx/palace
1
1
Fork 0
Code Issues Releases Activity

Generate documentation for version 0.0.8

This commit is contained in:
Nguyễn Gia Phong 2020-02-07 16:19:19 +07:00
parent 905e9723d7
commit 538b1a4f93
13 changed files with 142 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
doctrees/environment.pickle
View File

Binary file not shown.

BIN
doctrees/reference.doctree
View File

Binary file not shown.

2
html/.buildinfo
View File

@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 1c0a0cfdfac9000b2b6bd5c4e5b87f47
config: 4cc0c27bdc7cedaf2be4fea2666d6a5a
tags: 645f666f9bcd5a90fca523b33c5a78b7

2
html/_static/documentation_options.js
View File

@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '0.0.3',
VERSION: '0.0.8',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',

6
html/genindex.html
View File

@ -5,7 +5,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Index &#8212; palace 0.0.3 documentation</title>
<title>Index &#8212; palace 0.0.8 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@ -169,6 +169,8 @@
<li><a href="reference.html#palace.Source.gain_auto">gain_auto (palace.Source attribute)</a>
</li>
<li><a href="reference.html#palace.Source.gain_range">gain_range (palace.Source attribute)</a>
</li>
<li><a href="reference.html#palace.Source.group">group (palace.Source attribute)</a>
</li>
</ul></td>
</tr></table>
@ -432,7 +434,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2019, 2020 Nguyễn Gia Phong.
&copy;2019, 2020 Nguyễn Gia Phong & contributors.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.3.1</a>

4
html/index.html
View File

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Welcome to palace’s documentation! &#8212; palace 0.0.3 documentation</title>
<title>Welcome to palace’s documentation! &#8212; palace 0.0.8 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@ -104,7 +104,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2019, 2020 Nguyễn Gia Phong.
&copy;2019, 2020 Nguyễn Gia Phong & contributors.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.3.1</a>

BIN
html/objects.inv
View File

Binary file not shown.

4
html/py-modindex.html
View File

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Python Module Index &#8212; palace 0.0.3 documentation</title>
<title>Python Module Index &#8212; palace 0.0.8 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@ -107,7 +107,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2019, 2020 Nguyễn Gia Phong.
&copy;2019, 2020 Nguyễn Gia Phong & contributors.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.3.1</a>

171
html/reference.html
View File

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Reference &#8212; palace 0.0.3 documentation</title>
<title>Reference &#8212; palace 0.0.8 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@ -129,8 +129,8 @@ cannot be opened.</p>
<p class="rubric">Notes</p>
<p>This starts relative to the device being opened, and does not
increment while there are no contexts nor while processing
is paused. Currently, this may not exactly match the rate
that sources play at. In the future it may utilize an OpenAL
is paused. Currently, this may not exactly match the rate
that sources play at. In the future it may utilize an OpenAL
extension to retrieve the audio device’s real clock.</p>
</dd></dl>
@ -421,12 +421,24 @@ foggy air and lower values simulating dryer air; default to 0.</p>
<dt id="palace.Source.cone_angles">
<code class="sig-name descname">cone_angles</code><a class="headerlink" href="#palace.Source.cone_angles" title="Permalink to this definition"></a></dt>
<dd><p>Cone inner and outer angles in degrees.</p>
<p>The inner angle is the area within which the listener will
hear the source with no extra attenuation, while the listener
being outside of the outer angle will hear the source attenuated
according to the outer cone gains. The area follows the facing
direction, so for example an inner angle of 180 means the entire
front face of the source is in the inner cone.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>inner</strong> (<em>float</em>) – The area within which the listener will hear the source
without extra attenuation, default to 360.</p></li>
<li><p><strong>outer</strong> (<em>float</em>) – The area outside of which the listener will hear the source
attenuated according to <cite>outer_cone_gains</cite>, default to 360.</p></li>
</ul>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p><strong>ValueError</strong> – If set to a value where <cite>inner</cite> is greater than <cite>outer</cite>
or either of them is outside of the [0, 360] interval.</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>The areas follow the facing direction, so for example
an inner angle of 180 means the entire front face of
the source is in the inner cone.</p>
</dd></dl>
<dl class="method">
@ -438,37 +450,54 @@ front face of the source is in the inner cone.</p>
<dl class="attribute">
<dt id="palace.Source.distance_range">
<code class="sig-name descname">distance_range</code><a class="headerlink" href="#palace.Source.distance_range" title="Permalink to this definition"></a></dt>
<dd><p>Reference and maximum distance the source will use for
the current distance model. For Clamped distance models,
the source’s calculated distance is clamped to the specified
range before applying distance-related attenuation.</p>
<p>For all distance models, the reference distance is the distance
at which the source’s volume will not have any extra attenuation
(an effective gain multiplier of 1).</p>
<dd><p>Reference and maximum distance for current distance model.</p>
<p>For Clamped distance models, the source’s calculated
distance is clamped to the specified range before applying
distance-related attenuation.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>refdist</strong> (<em>float</em>) – The distance at which the source’s volume will not have
any extra attenuation (an effective gain multiplier of 1),
default to 0.</p></li>
<li><p><strong>maxdist</strong> (<em>float</em>) – The maximum distance, default to FLT_MAX, which is the
maximum value of a single-precision floating-point variable
(2**128 - 2**104).</p></li>
</ul>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p><strong>ValueError</strong> – If set to a value where <cite>refdist</cite> is greater than <cite>maxdist</cite>
or either of them is outside of the [0, FLT_MAX] interval.</p>
</dd>
</dl>
</dd></dl>
<dl class="attribute">
<dt id="palace.Source.doppler_factor">
<code class="sig-name descname">doppler_factor</code><a class="headerlink" href="#palace.Source.doppler_factor" title="Permalink to this definition"></a></dt>
<dd><p>The doppler factor for the doppler effect’s pitch shift.
This effectively scales the source and listener velocities
<dd><p>The doppler factor for the doppler effect’s pitch shift.</p>
<p>This effectively scales the source and listener velocities
for the doppler calculation.</p>
<dl class="field-list simple">
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p><strong>ValueError</strong> – If set to a value outside of the [0, 1] interval.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="palace.Source.fade_out_to_stop">
<code class="sig-name descname">fade_out_to_stop</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">double gain: float</em>, <em class="sig-param">ms: int</em><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#palace.Source.fade_out_to_stop" title="Permalink to this definition"></a></dt>
<dd><p>Fade the source to <cite>gain</cite> over <cite>ms</cite> milliseconds,
at which point playback will stop. <cite>gain</cite> is in addition to
the base gain, and must be greater than 0 and less than 1.
<cite>ms</cite> must also be positive</p>
<p>The fading is logarithmic. As a result, the initial drop-off may
happen faster than expected but the fading is more perceptually
consistant over the given duration. It will take just as much
time to go from -6 dB to -12 dB as it will to go from -40 dB
to -46 dB, for example.</p>
<dd><p>Fade the source to <cite>gain</cite> over <cite>ms</cite> milliseconds.</p>
<p><cite>gain</cite> is in addition to the base gain and must be within
the [0, 1] interval. <cite>ms</cite> must be positive.</p>
<p>The fading is logarithmic. As a result, the initial drop-off
may happen faster than expected but the fading is more
perceptually consistant over the given duration. It will take
just as much time to go from -6 dB to -12 dB as it will to go
from -40 dB to -46 dB, for example.</p>
<p>Pending playback from a future buffer is not immediately
canceled, but the fade timer starts with this call. If the
canceled, but the fade timer starts with this call. If the
future buffer then becomes ready, it will start mid-fade.
Pending playback will be canceled if the fade out completes
before the future buffer becomes ready.</p>
@ -481,6 +510,11 @@ for the fading to be smooth.</p>
<dt id="palace.Source.gain">
<code class="sig-name descname">gain</code><a class="headerlink" href="#palace.Source.gain" title="Permalink to this definition"></a></dt>
<dd><p>Base linear volume gain, default to 1.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p><strong>ValueError</strong> – If set to a negative value.</p>
</dd>
</dl>
</dd></dl>
<dl class="attribute">
@ -494,10 +528,40 @@ automatically adjusted. The default is <cite>True</cite> for all.</p>
<dl class="attribute">
<dt id="palace.Source.gain_range">
<code class="sig-name descname">gain_range</code><a class="headerlink" href="#palace.Source.gain_range" title="Permalink to this definition"></a></dt>
<dd><p>Minimum and maximum gain. The source’s gain is clamped
to this range after distance attenuation and cone attenuation
are applied to the gain base, although before the filter
gain adjustements.</p>
<dd><p>The range which the source’s gain is clamped to after
distance and cone attenuation are applied to the gain base,
although before the filter gain adjustements.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>mingain</strong> (<em>float</em>) – Minimum gain, default to 0.</p></li>
<li><p><strong>maxgain</strong> (<em>float</em>) – Maximum gain, default to 1.</p></li>
</ul>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p><strong>ValueError</strong> – If set to a value where <cite>mingain</cite> is greater than <cite>maxgain</cite>
or either of them is outside of the [0, 1] interval.</p>
</dd>
</dl>
</dd></dl>
<dl class="attribute">
<dt id="palace.Source.group">
<code class="sig-name descname">group</code><a class="headerlink" href="#palace.Source.group" title="Permalink to this definition"></a></dt>
<dd><p>Parent group of this source.</p>
<p>The parent group influences all sources that belong to it.
A source may only be the child of one <cite>SourceGroup</cite> at a time,
although that source group may belong to another source group.</p>
<p>This is <cite>None</cite> when the source does not belong to any group.
On the other hand, setting it to <cite>None</cite> removes the source
from its current group.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="#palace.SourceGroup" title="palace.SourceGroup"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SourceGroup</span></code></a></dt><dd><p>A group of <cite>Source</cite> references</p>
</dd>
</dl>
</div>
</dd></dl>
<dl class="attribute">
@ -533,7 +597,7 @@ this will be the offset based on the decoder’s read position.</p>
<dl class="attribute">
<dt id="palace.Source.offset_seconds">
<code class="sig-name descname">offset_seconds</code><a class="headerlink" href="#palace.Source.offset_seconds" title="Permalink to this definition"></a></dt>
<dd><p>Source offset in seconds. For streaming sources
<dd><p>Source offset in seconds. For streaming sources
this will be the offset based on the decoder’s read position.</p>
</dd></dl>
@ -555,12 +619,16 @@ outside of the source’s outer cone area.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>gain</strong> (<em>float</em>) – Linear gain applying to all frequencies.</p></li>
<li><p><strong>gain</strong> (<em>float</em>) – Linear gain applying to all frequencies, default to 1.</p></li>
<li><p><strong>gainhf</strong> (<em>float</em>) – Linear gainhf applying extra attenuation to high frequencies
creating a low-pass effect. It has no effect without the
<cite>ALC_EXT_EFX</cite> extension.</p></li>
creating a low-pass effect, default to 1. It has no effect
without the <cite>ALC_EXT_EFX</cite> extension.</p></li>
</ul>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p><strong>ValueError</strong> – If either of the gains is set to a value
outside of the [0, 1] interval.</p>
</dd>
</dl>
</dd></dl>
@ -586,6 +654,11 @@ creating a low-pass effect. It has no effect without the
<dt id="palace.Source.pitch">
<code class="sig-name descname">pitch</code><a class="headerlink" href="#palace.Source.pitch" title="Permalink to this definition"></a></dt>
<dd><p>Linear pitch shift base, default to 1.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p><strong>ValueError</strong> – If set to a nonpositive value.</p>
</dd>
</dl>
</dd></dl>
<dl class="attribute">
@ -618,9 +691,13 @@ are available and higher priority sources are played.</p>
<dl class="attribute">
<dt id="palace.Source.radius">
<code class="sig-name descname">radius</code><a class="headerlink" href="#palace.Source.radius" title="Permalink to this definition"></a></dt>
<dd><p>Radius of the source. This causes the source to behave
as if every point within the spherical area emits sound.</p>
<dd><p>Radius of the source, as if it is a sound-emitting sphere.</p>
<p>This has no effect without the <cite>AL_EXT_SOURCE_RADIUS</cite> extension.</p>
<dl class="field-list simple">
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p><strong>ValueError</strong> – If set to a negative value.</p>
</dd>
</dl>
</dd></dl>
<dl class="attribute">
@ -633,11 +710,10 @@ are relative to the listener.</p>
<dl class="attribute">
<dt id="palace.Source.resampler_index">
<code class="sig-name descname">resampler_index</code><a class="headerlink" href="#palace.Source.resampler_index" title="Permalink to this definition"></a></dt>
<dd><p>Index of the resampler to use for this source.
The index is from the resamplers returned by
<cite>Context.get_available_resamplers</cite>, and must be nonnegative.</p>
<p>This has no effect without
the <cite>AL_SOFT_source_resampler</cite> extension.</p>
<dd><p>Index of the resampler to use for this source.</p>
<p>The index must be nonnegative, from the resamplers returned
by <cite>Context.get_available_resamplers</cite>, and has no effect
without the <cite>AL_SOFT_source_resampler</cite> extension.</p>
</dd></dl>
<dl class="method">
@ -652,6 +728,11 @@ the <cite>AL_SOFT_source_resampler</cite> extension.</p>
<dd><p>Rolloff factor and room factor for the direct and send paths.</p>
<p>This is effectively a distance scaling relative to
the reference distance.</p>
<dl class="field-list simple">
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p><strong>ValueError</strong> – If either of rolloff factors is set to a negative value.</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>To disable distance attenuation for send paths,
set room factor to 0. The reverb engine will, by default,
@ -674,7 +755,7 @@ the <cite>AL_SOFT_source_spatialize</cite> extension.</p>
<dt id="palace.Source.stereo_angles">
<code class="sig-name descname">stereo_angles</code><a class="headerlink" href="#palace.Source.stereo_angles" title="Permalink to this definition"></a></dt>
<dd><p>Left and right channel angles, in radians, when playing
a stereo buffer or stream. The angles go counter-clockwise,
a stereo buffer or stream. The angles go counter-clockwise,
with 0 being in front and positive values going left.</p>
<p>This has no effect without the <cite>AL_EXT_STEREO_ANGLES</cite> extension.</p>
</dd></dl>
@ -914,7 +995,7 @@ a new one will be created.</p></li>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2019, 2020 Nguyễn Gia Phong.
&copy;2019, 2020 Nguyễn Gia Phong & contributors.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.3.1</a>

4
html/search.html
View File

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Search &#8212; palace 0.0.3 documentation</title>
<title>Search &#8212; palace 0.0.8 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -100,7 +100,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2019, 2020 Nguyễn Gia Phong.
&copy;2019, 2020 Nguyễn Gia Phong & contributors.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.3.1</a>

2
html/searchindex.js
View File

File diff suppressed because one or more lines are too long

0
source/_static/.empty Normal file
View File

6
source/conf.py
View File

@ -18,11 +18,11 @@
# -- Project information -----------------------------------------------------
project = 'palace'
copyright = '2019, 2020 Nguyễn Gia Phong'
author = 'Nguyễn Gia Phong'
copyright = '2019, 2020 Nguyễn Gia Phong & contributors'
author = 'Nguyễn Gia Phong & contributors'
# The full version, including alpha/beta/rc tags
release = '0.0.3'
release = '0.0.8'
# -- General configuration ---------------------------------------------------