Add chickade 0.5.0 stuff.

author: David Thompson <dthompson@vistahigherlearning.com> 2020-04-08 17:10:29 -0400
committer: David Thompson <dthompson@vistahigherlearning.com> 2020-04-08 17:10:29 -0400
commit: e7d470e954d0a17ab1b2fe0065f46f78475272f9 (patch)
tree: ca4d9c00789f41dbbdbac33151824812dad879f7 /manuals/chickadee/Sources.html
parent: b660cbb5287f7cdcb6cebaba72afe8fc7d512616 (diff)
1 files changed, 336 insertions, 0 deletions
diff --git a/manuals/chickadee/Sources.html b/manuals/chickadee/Sources.html
new file mode 100644
index 0000000..82917a2
--- /dev/null
+++ b/manuals/chickadee/Sources.html
@@ -0,0 +1,336 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<!-- Copyright (C) 2017-2020  David Thompson davet@gnu.org
+
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.3
+or any later version published by the Free Software Foundation;
+with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
+A copy of the license is included in the section entitled "GNU
+Free Documentation License".
+
+A copy of the license is also available from the Free Software
+Foundation Web site at http://www.gnu.org/licenses/fdl.html.
+
+
+* Chickadee: (chickadee).     Game programming toolkit for Guile.
+
+The document was typeset with
+http://www.texinfo.org/ (GNU Texinfo).
+ -->
+<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Sources (The Chickadee Game Toolkit)</title>
+
+<meta name="description" content="Sources (The Chickadee Game Toolkit)">
+<meta name="keywords" content="Sources (The Chickadee Game Toolkit)">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="makeinfo">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Audio.html#Audio" rel="up" title="Audio">
+<link href="The-Listener.html#The-Listener" rel="next" title="The Listener">
+<link href="Audio-Files.html#Audio-Files" rel="prev" title="Audio Files">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.indentedblock {margin-right: 0em}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+kbd {font-style: oblique}
+pre.display {font-family: inherit}
+pre.format {font-family: inherit}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+span.nolinebreak {white-space: nowrap}
+span.roman {font-family: initial; font-weight: normal}
+span.sansserif {font-family: sans-serif; font-weight: normal}
+ul.no-bullet {list-style: none}
+@media (min-width: 1140px) {
+    body {
+        margin-left: 14rem;
+        margin-right: 4rem;
+        max-width: 52rem;
+    }
+}
+
+@media (min-width: 800px) and (max-width: 1140px) {
+    body {
+        margin-left: 6rem;
+        margin-right: 4rem;
+        max-width: 52rem;
+    }
+}
+
+@media (max-width: 800px) {
+    body {
+        margin: 1rem;
+    }
+}
+
+-->
+</style>
+<link rel="stylesheet" type="text/css" href="https://dthompson.us/css/dthompson.css">
+
+
+</head>
+
+<body lang="en">
+<span id="Sources"></span><div class="header">
+<p>
+Next: <a href="The-Listener.html#The-Listener" accesskey="n" rel="next">The Listener</a>, Previous: <a href="Audio-Files.html#Audio-Files" accesskey="p" rel="prev">Audio Files</a>, Up: <a href="Audio.html#Audio" accesskey="u" rel="up">Audio</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
+</div>
+<hr>
+<span id="Sources-1"></span><h4 class="subsection">2.4.2 Sources</h4>
+
+<p>While the <code>audio-play</code> procedure provides a quick and convenient
+way to play audio, it has some limitations.  What if the audio is a
+long piece of music that might need to be paused or stopped later?
+What if the audio should be looped?  What if the volume or pitch needs
+to be altered?  For manipulating audio in these ways, a &ldquo;source&rdquo; is
+required.  Sources can be thought of like a boombox: They sit
+somewhere in the room and play sound.  The pause or stop buttons can
+be pressed; it can be moved somewhere else; the volume knob can be
+adjusted; the CD can be changed.
+</p>
+<p>Sources are a great fit for handling background music, among other
+things.  For quick, one-off sound effects, <code>audio-play</code> is a
+better fit.
+</p>
+<dl>
+<dt id="index-make_002dsource">Procedure: <strong>make-source</strong> <em>audio loop? [#:pitch 1.0] [#:volume 1.0]                    [#:min-volume 0.0] [#:max-volume 1.0] [#:max-distance]                    [#:reference-distance 0.0] [#:rolloff-factor 1.0]                    [#:cone-outer-volume 0.0] [#:cone-inner-angle 0.0]                    [#:cone-outer-angle]                    [#:position <code>(vec3 0.0 0.0 0.0)</code>]                    [#:velocity <code>(vec3 0.0 0.0 0.0)</code>]                    [#:direction <code>(vec3 0.0 0.0 0.0)</code>]                    [#:relative? <code>#f</code>]</em></dt>
+<dd>
+<p>Return a new audio source.  <var>audio</var> is the audio data to use when
+playing.  <var>loop?</var> specifies whether or not to loop the audio
+during playback.
+</p>
+<p>Refer to <code>audio-play</code> (see <a href="Audio-Files.html#Audio-Files">Audio Files</a>) for information about
+the optional keyword arguments.
+</p></dd></dl>
+
+<dl>
+<dt id="index-source_003f">Procedure: <strong>source?</strong> <em>obj</em></dt>
+<dd><p>Return <code>#t</code> if <var>obj</var> is an audio source object.
+</p></dd></dl>
+
+<dl>
+<dt id="index-streaming_002dsource_003f">Procedure: <strong>streaming-source?</strong> <em>source</em></dt>
+<dd><p>Return <code>#t</code> if <var>source</var> contains streaming audio.
+</p></dd></dl>
+
+<dl>
+<dt id="index-static_002dsource_003f">Procedure: <strong>static-source?</strong> <em>source</em></dt>
+<dd><p>Return <code>#t</code> if <var>source</var> contains static audio.
+</p></dd></dl>
+
+<dl>
+<dt id="index-source_002dplaying_003f">Procedure: <strong>source-playing?</strong> <em>source</em></dt>
+<dd><p>Return <code>#t</code> if <var>source</var> is currently playing.
+</p></dd></dl>
+
+<dl>
+<dt id="index-source_002dpaused_003f">Procedure: <strong>source-paused?</strong> <em>source</em></dt>
+<dd><p>Return <code>#t</code> if <var>source</var> is currently paused.
+</p></dd></dl>
+
+<dl>
+<dt id="index-source_002dstopped_003f">Procedure: <strong>source-stopped?</strong> <em>source</em></dt>
+<dd><p>Return <code>#t</code> if <var>source</var> is currently stopped.
+</p></dd></dl>
+
+<dl>
+<dt id="index-source_002dpitch">Procedure: <strong>source-pitch</strong> <em>source</em></dt>
+<dd><p>Return the pitch multiplier of <var>source</var>.
+</p></dd></dl>
+
+<dl>
+<dt id="index-source_002dvolume">Procedure: <strong>source-volume</strong> <em>source</em></dt>
+<dd><p>Return the volume multiplier of <var>source</var>.
+</p></dd></dl>
+
+<dl>
+<dt id="index-source_002dmin_002dvolume">Procedure: <strong>source-min-volume</strong> <em>source</em></dt>
+<dd><p>Return the minimum volume of <var>source</var>.
+</p></dd></dl>
+
+<dl>
+<dt id="index-source_002dmax_002dvolume">Procedure: <strong>source-max-volume</strong> <em>source</em></dt>
+<dd><p>Return the maximum volume of <var>source</var>.
+</p></dd></dl>
+
+<dl>
+<dt id="index-source_002dmax_002ddistance">Procedure: <strong>source-max-distance</strong> <em>source</em></dt>
+<dd><p>Return the maximum distance of <var>source</var>.
+</p></dd></dl>
+
+<dl>
+<dt id="index-source_002dreference_002ddistance">Procedure: <strong>source-reference-distance</strong> <em>source</em></dt>
+<dd><p>Return the reference distance of <var>source</var>.
+</p></dd></dl>
+
+<dl>
+<dt id="index-source_002drolloff_002dfactor">Procedure: <strong>source-rolloff-factor</strong> <em>source</em></dt>
+<dd><p>Return the rolloff factor of <var>source</var>.
+</p></dd></dl>
+
+<dl>
+<dt id="index-source_002dcone_002douter_002dvolume">Procedure: <strong>source-cone-outer-volume</strong> <em>source</em></dt>
+<dd><p>Return the volume of <var>source</var> when outside the oriented cone.
+</p></dd></dl>
+
+<dl>
+<dt id="index-source_002dcone_002dinner_002dangle">Procedure: <strong>source-cone-inner-angle</strong> <em>source</em></dt>
+<dd><p>Return the inner angle of the sound cone of <var>source</var> in radians.
+</p></dd></dl>
+
+<dl>
+<dt id="index-source_002dcone_002douter_002dangle">Procedure: <strong>source-cone-outer-angle</strong> <em>source</em></dt>
+<dd><p>Return the outer angle of the sound cone of <var>source</var> in radians.
+</p></dd></dl>
+
+<dl>
+<dt id="index-source_002dposition">Procedure: <strong>source-position</strong> <em>source</em></dt>
+<dd><p>Return the position of <var>source</var> as a 3D vector.
+</p></dd></dl>
+
+<dl>
+<dt id="index-source_002dvelocity">Procedure: <strong>source-velocity</strong> <em>source</em></dt>
+<dd><p>Return the velocity of <var>source</var> as a 3D vector.
+</p></dd></dl>
+
+<dl>
+<dt id="index-source_002ddirection">Procedure: <strong>source-direction</strong> <em>source</em></dt>
+<dd><p>Return the direction of <var>source</var> as a 3D vector.
+</p></dd></dl>
+
+<dl>
+<dt id="index-source_002drelative_003f">Procedure: <strong>source-relative?</strong> <em>source</em></dt>
+<dd><p>Return <code>#t</code> if the position of <var>source</var> is relative to the
+listener&rsquo;s position.
+</p></dd></dl>
+
+<dl>
+<dt id="index-source_002dplay">Procedure: <strong>source-play</strong> <em>source</em></dt>
+<dd><p>Begin/resume playback of <var>source</var>.
+</p></dd></dl>
+
+<dl>
+<dt id="index-source_002dpause">Procedure: <strong>source-pause</strong> <em>source</em></dt>
+<dd><p>Pause playback of <var>source</var>.
+</p></dd></dl>
+
+<dl>
+<dt id="index-source_002dtoggle">Procedure: <strong>source-toggle</strong> <em>source</em></dt>
+<dd><p>Play <var>source</var> if it is currently paused or pause <var>source</var> if
+it is currently playing.
+</p></dd></dl>
+
+<dl>
+<dt id="index-source_002dstop">Procedure: <strong>source-stop</strong> <em>[source]</em></dt>
+<dd><p>Stop playing <var>source</var> or, if no source is specified, stop playing
+<em>all</em> sources.
+</p></dd></dl>
+
+<dl>
+<dt id="index-source_002drewind">Procedure: <strong>source-rewind</strong> <em>source</em></dt>
+<dd><p>Rewind <var>source</var> to the beginning of the audio stream.
+</p></dd></dl>
+
+<dl>
+<dt id="index-set_002dsource_002daudio_0021">Procedure: <strong>set-source-audio!</strong> <em>source audio</em></dt>
+<dd><p>Set the playback stream for <var>source</var> to <var>audio</var>.
+</p></dd></dl>
+
+<dl>
+<dt id="index-set_002dsource_002dloop_0021">Procedure: <strong>set-source-loop!</strong> <em>source loop?</em></dt>
+<dd><p>Configure whether or not <var>source</var> should loop the audio stream.
+</p></dd></dl>
+
+<dl>
+<dt id="index-set_002dsource_002dpitch_0021">Procedure: <strong>set-source-pitch!</strong> <em>source pitch</em></dt>
+<dd><p>Set the pitch multiplier of <var>source</var> to <var>pitch</var>
+</p></dd></dl>
+
+<dl>
+<dt id="index-set_002dsource_002dvolume_0021">Procedure: <strong>set-source-volume!</strong> <em>source volume</em></dt>
+<dd><p>Set the volume of <var>source</var> to <var>volume</var>.  A value of 1.0 is
+100% volume.
+</p></dd></dl>
+
+<dl>
+<dt id="index-set_002dsource_002dmin_002dvolume_0021">Procedure: <strong>set-source-min-volume!</strong> <em>source volume</em></dt>
+<dd><p>Set the minimum volume of <var>source</var> to <var>volume</var>.
+</p></dd></dl>
+
+<dl>
+<dt id="index-set_002dsource_002dmax_002dvolume_0021">Procedure: <strong>set-source-max-volume!</strong> <em>source volume</em></dt>
+<dd><p>Set the maximum volume of <var>source</var> to <var>volume</var>.
+</p></dd></dl>
+
+<dl>
+<dt id="index-set_002dsource_002dmax_002ddistance_0021">Procedure: <strong>set-source-max-distance!</strong> <em>source distance</em></dt>
+<dd><p>Set the distance where there will no longer be any attenuation of
+<var>source</var> to <var>distance</var>.
+</p></dd></dl>
+
+<dl>
+<dt id="index-set_002dsource_002dreference_002ddistance_0021">Procedure: <strong>set-source-reference-distance!</strong> <em>source distance</em></dt>
+<dd><p>Set the reference distance of <var>source</var> to <var>distance</var>.
+</p></dd></dl>
+
+<dl>
+<dt id="index-set_002dsource_002drolloff_002dfactor_0021">Procedure: <strong>set-source-rolloff-factor!</strong> <em>source factor</em></dt>
+<dd><p>Set the rolloff factor for <var>source</var> to <var>factor</var>.
+</p></dd></dl>
+
+<dl>
+<dt id="index-set_002dsource_002dcone_002douter_002dvolume_0021">Procedure: <strong>set-source-cone-outer-volume!</strong> <em>source volume</em></dt>
+<dd><p>Set the volume for <var>source</var> when outside the sound cone to <var>volume</var>.
+</p></dd></dl>
+
+<dl>
+<dt id="index-set_002dsource_002dcone_002dinner_002dangle_0021">Procedure: <strong>set-source-cone-inner-angle!</strong> <em>source angle</em></dt>
+<dd><p>Set the inner angle of the sound cone of <var>source</var> to <var>angle</var> radians.
+</p></dd></dl>
+
+<dl>
+<dt id="index-set_002dsource_002dcone_002douter_002dangle_0021">Procedure: <strong>set-source-cone-outer-angle!</strong> <em>source angle</em></dt>
+<dd><p>Set the outer angle of the sound cone of <var>source</var> to <var>angle</var> radians.
+</p></dd></dl>
+
+<dl>
+<dt id="index-set_002dsource_002dposition_0021">Procedure: <strong>set-source-position!</strong> <em>source position</em></dt>
+<dd><p>Set the position of <var>source</var> to the 3D vector <var>position</var>.
+</p></dd></dl>
+
+<dl>
+<dt id="index-set_002dsource_002dvelocity_0021">Procedure: <strong>set-source-velocity!</strong> <em>source velocity</em></dt>
+<dd><p>Set the velocity of <var>source</var> to the 3D vector <var>velocity</var>.
+</p></dd></dl>
+
+<dl>
+<dt id="index-set_002dsource_002ddirection_0021">Procedure: <strong>set-source-direction!</strong> <em>source direction</em></dt>
+<dd><p>Set the velocity of <var>source</var> to the 3D vector <var>direction</var>.
+</p></dd></dl>
+
+<dl>
+<dt id="index-set_002dsource_002drelative_0021">Procedure: <strong>set-source-relative!</strong> <em>source relative?</em></dt>
+<dd><p>If <var>relative?</var> is <code>#t</code>, the position of <var>source</var> is
+interpreted as relative to the listener&rsquo;s position.  Otherwise, the
+position of <var>source</var> is in absolute coordinates.
+</p></dd></dl>
+
+<hr>
+<div class="header">
+<p>
+Next: <a href="The-Listener.html#The-Listener" accesskey="n" rel="next">The Listener</a>, Previous: <a href="Audio-Files.html#Audio-Files" accesskey="p" rel="prev">Audio Files</a>, Up: <a href="Audio.html#Audio" accesskey="u" rel="up">Audio</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
+</div>
+
+
+
+</body>
+</html>
author	David Thompson <dthompson@vistahigherlearning.com>	2020-04-08 17:10:29 -0400
committer	David Thompson <dthompson@vistahigherlearning.com>	2020-04-08 17:10:29 -0400
commit	e7d470e954d0a17ab1b2fe0065f46f78475272f9 (patch)
tree	ca4d9c00789f41dbbdbac33151824812dad879f7 /manuals/chickadee/Sources.html
parent	b660cbb5287f7cdcb6cebaba72afe8fc7d512616 (diff)