summaryrefslogtreecommitdiff
path: root/manuals/chickadee/Audio.html
diff options
context:
space:
mode:
Diffstat (limited to 'manuals/chickadee/Audio.html')
-rw-r--r--manuals/chickadee/Audio.html129
1 files changed, 129 insertions, 0 deletions
diff --git a/manuals/chickadee/Audio.html b/manuals/chickadee/Audio.html
new file mode 100644
index 0000000..5540e83
--- /dev/null
+++ b/manuals/chickadee/Audio.html
@@ -0,0 +1,129 @@
+<!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>Audio (The Chickadee Game Toolkit)</title>
+
+<meta name="description" content="Audio (The Chickadee Game Toolkit)">
+<meta name="keywords" content="Audio (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="API-Reference.html#API-Reference" rel="up" title="API Reference">
+<link href="Audio-Files.html#Audio-Files" rel="next" title="Audio Files">
+<link href="Shaders.html#Shaders" rel="prev" title="Shaders">
+<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="Audio"></span><div class="header">
+<p>
+Next: <a href="Scripting.html#Scripting" accesskey="n" rel="next">Scripting</a>, Previous: <a href="Graphics.html#Graphics" accesskey="p" rel="prev">Graphics</a>, Up: <a href="API-Reference.html#API-Reference" accesskey="u" rel="up">API Reference</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="Audio-1"></span><h3 class="section">2.4 Audio</h3>
+
+<p>A game isn&rsquo;t complete without sound. Most games play some cool
+background music to set the mood and have many sound effects to play
+when events happen. The <code>(chickadee audio)</code> module provides a
+robust audio API backed by the OpenAL 3D audio system.
+</p>
+<table class="menu" border="0" cellspacing="0">
+<tr><td align="left" valign="top">&bull; <a href="Audio-Files.html#Audio-Files" accesskey="1">Audio Files</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Not audiophiles.
+</td></tr>
+<tr><td align="left" valign="top">&bull; <a href="Sources.html#Sources" accesskey="2">Sources</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Audio emitters.
+</td></tr>
+<tr><td align="left" valign="top">&bull; <a href="The-Listener.html#The-Listener" accesskey="3">The Listener</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">The player&rsquo;s ears.
+</td></tr>
+<tr><td align="left" valign="top">&bull; <a href="The-Environment.html#The-Environment" accesskey="4">The Environment</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Global sound model settings.
+</td></tr>
+</table>
+
+<p>The basics of playing audio are very simple. Just load an audio file
+in the load hook (or anywhere else once the game loop is running) and
+play it!
+</p>
+<div class="example">
+<pre class="example">(use-modules (chickadee audio))
+
+(define audio #f)
+
+(define (load)
+ (set! audio (load-audio &quot;neat-sound-effect.wav&quot;))
+ (audio-play audio))
+
+(run-game #:load load)
+</pre></div>
+
+<p>For more advanced usage, check out the full API reference in the
+following sections.
+</p>
+
+
+
+</body>
+</html>