summaryrefslogtreecommitdiff
path: root/src/sound.cpp
diff options
context:
space:
mode:
authorrubidium <rubidium@openttd.org>2008-04-19 13:05:05 +0000
committerrubidium <rubidium@openttd.org>2008-04-19 13:05:05 +0000
commit081f62701882a4e97b5dff37f51a89965fe9faa5 (patch)
tree63e2bd0279fba7a1ae215dcd1df8b5ad092a0cd4 /src/sound.cpp
parentaf34ce0b5d0dd9e323039850779a1bd79aa7701a (diff)
downloadopenttd-081f62701882a4e97b5dff37f51a89965fe9faa5.tar.xz
(svn r12787) -Documentation: add/fix documentation of some functions. Patch by Alberth.
Diffstat (limited to 'src/sound.cpp')
-rw-r--r--src/sound.cpp9
1 files changed, 8 insertions, 1 deletions
diff --git a/src/sound.cpp b/src/sound.cpp
index c5daccae4..a9c0cb801 100644
--- a/src/sound.cpp
+++ b/src/sound.cpp
@@ -207,6 +207,14 @@ void SndCopyToPool()
}
}
+/**
+ * Decide 'where' (between left and right speaker) to play the sound effect.
+ * @param sound Sound effect to play
+ * @param left Left edge of virtual coordinates where the sound is produced
+ * @param right Right edge of virtual coordinates where the sound is produced
+ * @param top Top edge of virtual coordinates where the sound is produced
+ * @param bottom Bottom edge of virtual coordinates where the sound is produced
+ */
static void SndPlayScreenCoordFx(SoundFx sound, int left, int right, int top, int bottom)
{
Window* const *wz;
@@ -231,7 +239,6 @@ static void SndPlayScreenCoordFx(SoundFx sound, int left, int right, int top, in
return;
}
}
-
}
void SndPlayTileFx(SoundFx sound, TileIndex tile)