zengine/doc/html/ZE__ZSound_8h-source.html
2002-11-21 05:40:49 +00:00

85 lines
5.7 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>/home/James/ZEngine-dev/include/ZE_ZSound.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3-rc1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>/home/James/ZEngine-dev/include/ZE_ZSound.h</h1><a href="ZE__ZSound_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*******************************************************************************</span>
00002 <span class="comment"> This file is Part of the ZEngine Library for SDL Game Development.</span>
00003 <span class="comment"> Copyright (C) 2002 ConceptOfZero.net</span>
00004 <span class="comment"></span>
00005 <span class="comment"> Licensed under the BSD License, see licensing.txt.</span>
00006 <span class="comment"></span>
00007 <span class="comment"> The maintainer of this library is James Turk (jturk@conceptofzero.net) </span>
00008 <span class="comment"> and the home of this Library is http://www.conceptofzero.net/</span>
00009 <span class="comment">*******************************************************************************/</span>
00010
00024 <span class="preprocessor">#ifndef __ze_zsound_h__</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define __ze_zsound_h__</span>
00026 <span class="preprocessor"></span>
00027 <span class="preprocessor">#include "<a class="code" href="ZE__ZObject_8h.html">ZE_ZObject.h</a>"</span>
00028
00029 <span class="preprocessor">#ifdef USE_SDL_MIXER</span>
00030 <span class="preprocessor"></span>
00031 <span class="keyword">namespace </span>ZE
00032 {
00033
00039 <span class="keyword">class </span>ZSound : <span class="keyword">public</span> ZObject
00040 {
00041 <span class="keyword">protected</span>:
00043 SoundData <a class="code" href="classZE_1_1ZSound.html#n0">rSound</a>;
00045 <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZSound.html#n1">rChannelID</a>;
00046
00047 <span class="keyword">public</span>:
00049 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZSound.html#p0">LoopInfinite</a>;
00050
00052 <span class="comment">//Opening and Closing//</span>
00054 <span class="comment"></span>
00060 <span class="comment"></span> <a class="code" href="classZE_1_1ZSound.html#a0">ZSound</a>();
00061
00068 <a class="code" href="classZE_1_1ZSound.html#a0">ZSound</a>(string filename);
00069
00075 <a class="code" href="classZE_1_1ZSound.html#a2">~ZSound</a>();
00076
00083 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZSound.html#a3">Open</a>(string filename);
00084
00090 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZSound.html#a4">Release</a>();
00091
00093 <span class="comment">//Play Controls//</span>
00095 <span class="comment"></span>
00104 <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZSound.html#a5">Play</a>(<span class="keywordtype">int</span> loopNum=0, <span class="keywordtype">int</span> fadeTime=0);
00105
00111 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZSound.html#a6">Pause</a>();
00112
00118 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZSound.html#a7">Unpause</a>();
00119
00126 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZSound.html#a8">Stop</a>(<span class="keywordtype">int</span> fadeTime=0);
00127
00134 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZSound.html#a9">SetVolume</a>(<span class="keywordtype">int</span> volume);
00135
00137 <span class="comment">//Accessors//</span>
00139 <span class="comment"></span>
00146 <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZSound.html#a10">IsLoaded</a>();
00147
00154 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZSound.html#a11">IsPlaying</a>();
00155
00162 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZSound.html#a12">IsPaused</a>();
00163
00170 <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZSound.html#a13">GetVolume</a>();
00171 };
00172
00173
00174 }
00175
00176 <span class="preprocessor">#endif //USE_SDL_MIXER</span>
00177 <span class="preprocessor"></span>
00178 <span class="preprocessor">#endif //__ze_zsound_h__</span>
</pre></div><hr><address style="align: right;"><small>Generated on Wed Nov 20 01:18:05 2002 for ZEngine by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.3-rc1 </small></address>
</body>
</html>