zengine/doc/html/ZE__ZSound_8h-source.html

86 lines
6.1 KiB
HTML
Raw Normal View History

2003-04-27 22:15:26 +00:00
<!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>/include/ZE_ZSound.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3-rc2 -->
<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="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>/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 2D game development.</span>
00003 <span class="comment"> Copyright (C) 2002, 2003 James Turk</span>
00004 <span class="comment"></span>
00005 <span class="comment"> Licensed under a BSD-style license.</span>
00006 <span class="comment"></span>
00007 <span class="comment"> The maintainer of this library is James Turk (james@conceptofzero.net) </span>
00008 <span class="comment"> and the home of this Library is http://www.zengine.sourceforge.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__ZEngine_8h.html">ZE_ZEngine.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
<a name="l00039"></a><a class="code" href="classZE_1_1ZSound.html">00039</a> <span class="keyword">class </span><a class="code" href="classZE_1_1ZSound.html">ZSound</a>
00040 {
00041 <span class="keyword">protected</span>:
<a name="l00043"></a><a class="code" href="classZE_1_1ZSound.html#n0">00043</a> <a class="code" href="classZE_1_1ZEngine.html">ZEngine</a>* <a class="code" href="classZE_1_1ZSound.html#n0">rEngine</a>;
<a name="l00045"></a><a class="code" href="classZE_1_1ZSound.html#n1">00045</a> Mix_Chunk* <a class="code" href="classZE_1_1ZSound.html#n1">rSound</a>;
<a name="l00047"></a><a class="code" href="classZE_1_1ZSound.html#n2">00047</a> <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZSound.html#n2">rChannelID</a>;
00048
00049 <span class="keyword">public</span>:
<a name="l00051"></a><a class="code" href="classZE_1_1ZSound.html#p0">00051</a> <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>;
00052
00054 <span class="comment">//Opening and Closing//</span>
00056 <span class="comment"></span>
00062 <span class="comment"></span> <a class="code" href="classZE_1_1ZSound.html#a0">ZSound</a>();
00063
00070 <a class="code" href="classZE_1_1ZSound.html#a0">ZSound</a>(string filename);
00071
00077 <span class="keyword">virtual</span> <a class="code" href="classZE_1_1ZSound.html#a2">~ZSound</a>();
00078
00085 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZSound.html#a3">Open</a>(string filename);
00086
00092 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZSound.html#a4">Release</a>();
00093
00095 <span class="comment">//Play Controls//</span>
00097 <span class="comment"></span>
00106 <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);
00107
00113 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZSound.html#a6">Pause</a>() <span class="keyword">const</span>;
00114
00120 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZSound.html#a7">Unpause</a>() <span class="keyword">const</span>;
00121
00128 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZSound.html#a8">Stop</a>(<span class="keywordtype">int</span> fadeTime=0) <span class="keyword">const</span>;
00129
00136 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZSound.html#a9">SetVolume</a>(<span class="keywordtype">int</span> volume);
00137
00139 <span class="comment">//Accessors//</span>
00141 <span class="comment"></span>
00148 <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZSound.html#a10">IsLoaded</a>() <span class="keyword">const</span>;
00149
00156 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZSound.html#a11">IsPlaying</a>() <span class="keyword">const</span>;
00157
00164 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZSound.html#a12">IsPaused</a>() <span class="keyword">const</span>;
00165
00172 <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZSound.html#a13">Volume</a>() <span class="keyword">const</span>;
00173 };
00174
00175
00176 }
00177
00178 <span class="preprocessor">#endif //USE_SDL_MIXER</span>
00179 <span class="preprocessor"></span>
00180 <span class="preprocessor">#endif //__ze_zsound_h__</span>
2003-04-27 22:15:26 +00:00
</pre></div><hr><address style="align: right;"><small>Generated on Sun Apr 27 18:16:26 2003 for ZEngine by
2003-04-27 22:15:26 +00:00
<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-rc2 </small></address>
</body>
</html>