zengine/doc/html/ZE__ZMusic_8h-source.html

86 lines
5.7 KiB
HTML
Raw Normal View History

2002-11-21 05:40:49 +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>/home/James/ZEngine-dev/include/ZE_ZMusic.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_ZMusic.h</h1><a href="ZE__ZMusic_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_zmusic_h__</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define __ze_zmusic_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>ZMusic : <span class="keyword">public</span> ZObject
00040 {
00041 <span class="keyword">protected</span>:
00043 MusicData <a class="code" href="classZE_1_1ZMusic.html#n0">rMusic</a>;
00044
00045 <span class="keyword">public</span>:
00047 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZMusic.html#p0">LoopInfinite</a>;
00048
00050 <span class="comment">//Opening and Closing//</span>
00052 <span class="comment"></span>
00058 <span class="comment"></span> <a class="code" href="classZE_1_1ZMusic.html#a0">ZMusic</a>();
00059
00066 <a class="code" href="classZE_1_1ZMusic.html#a0">ZMusic</a>(string filename);
00067
00073 <a class="code" href="classZE_1_1ZMusic.html#a2">~ZMusic</a>();
00074
00081 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZMusic.html#a3">Open</a>(string filename);
00082
00088 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZMusic.html#a4">Release</a>();
00089
00091 <span class="comment">//Play Controls//</span>
00093 <span class="comment"></span>
00102 <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZMusic.html#a5">Play</a>(<span class="keywordtype">int</span> loopNum=0, <span class="keywordtype">int</span> fadeTime=0);
00103
00109 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZMusic.html#a6">Pause</a>();
00110
00116 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZMusic.html#a7">Unpause</a>();
00117
00123 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZMusic.html#a8">Rewind</a>();
00124
00131 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZMusic.html#a9">Stop</a>(<span class="keywordtype">int</span> fadeTime=0);
00132
00139 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZMusic.html#a10">SetVolume</a>(<span class="keywordtype">int</span> volume);
00140
00142 <span class="comment">//Accessors//</span>
00144 <span class="comment"></span>
00151 <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZMusic.html#a11">IsLoaded</a>();
00152
00159 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZMusic.html#a12">IsPlaying</a>();
00160
00167 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZMusic.html#a13">IsPaused</a>();
00168
00175 <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZMusic.html#a14">GetVolume</a>();
00176 };
00177
00178
00179 }
00180
00181 <span class="preprocessor">#endif //USE_SDL_MIXER</span>
00182 <span class="preprocessor"></span>
00183 <span class="preprocessor">#endif //__ze_zmusic_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>