zengine/doc/html/ZE__ZMusic_8h-source.html

87 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_ZMusic.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
2003-07-05 00:40:44 +00:00
<!-- Generated by Doxygen 1.3 -->
2003-04-27 22:15:26 +00:00
<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_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 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
2003-07-05 00:40:44 +00:00
00020 <span class="preprocessor">#ifndef __ze_zmusic_h__</span>
00021 <span class="preprocessor"></span><span class="preprocessor">#define __ze_zmusic_h__</span>
00022 <span class="preprocessor"></span>
00023 <span class="preprocessor">#include "<a class="code" href="ZE__ZEngine_8h.html">ZE_ZEngine.h</a>"</span>
00024
00025 <span class="preprocessor">#ifdef USE_SDL_MIXER</span>
2003-04-27 22:15:26 +00:00
00026 <span class="preprocessor"></span>
2003-07-05 00:40:44 +00:00
00027 <span class="keyword">namespace </span>ZE
00028 {
00029
<a name="l00035"></a><a class="code" href="classZE_1_1ZMusic.html">00035</a> <span class="keyword">class </span><a class="code" href="classZE_1_1ZMusic.html">ZMusic</a>
00036 {
00037 <span class="keyword">protected</span>:
<a name="l00039"></a><a class="code" href="classZE_1_1ZMusic.html#n0">00039</a> <a class="code" href="classZE_1_1ZEngine.html">ZEngine</a>* <a class="code" href="classZE_1_1ZMusic.html#n0">rEngine</a>;
<a name="l00041"></a><a class="code" href="classZE_1_1ZMusic.html#n1">00041</a> Mix_Music *<a class="code" href="classZE_1_1ZMusic.html#n1">rMusic</a>;
00042
00043 <span class="keyword">public</span>:
<a name="l00045"></a><a class="code" href="classZE_1_1ZMusic.html#p0">00045</a> <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>;
2003-04-27 22:15:26 +00:00
00046
2003-07-05 00:40:44 +00:00
00048 <span class="comment">//Opening and Closing//</span>
00050 <span class="comment"></span>
00056 <a class="code" href="classZE_1_1ZMusic.html#a0">ZMusic</a>();
00057
00064 <a class="code" href="classZE_1_1ZMusic.html#a0">ZMusic</a>(std::string filename);
00065
00071 <span class="keyword">virtual</span> <a class="code" href="classZE_1_1ZMusic.html#a2">~ZMusic</a>();
00072
00079 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZMusic.html#a3">Open</a>(std::string filename);
00080
00086 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZMusic.html#a4">Release</a>();
00087
00089 <span class="comment">//Play Controls//</span>
00091 <span class="comment"></span>
00100 <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) <span class="keyword">const</span>;
00101
00107 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZMusic.html#a6">Pause</a>() <span class="keyword">const</span>;
00108
00114 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZMusic.html#a7">Unpause</a>() <span class="keyword">const</span>;
00115
00121 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZMusic.html#a8">Rewind</a>() <span class="keyword">const</span>;
00122
00129 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZMusic.html#a9">Stop</a>(<span class="keywordtype">int</span> fadeTime=0) <span class="keyword">const</span>;
00130
00137 <span class="keywordtype">void</span> <a class="code" href="classZE_1_1ZMusic.html#a10">SetVolume</a>(<span class="keywordtype">int</span> volume);
00138
00140 <span class="comment">//Accessors//</span>
00142 <span class="comment"></span>
00149 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZMusic.html#a11">IsLoaded</a>() <span class="keyword">const</span>;
00150
00157 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZMusic.html#a12">IsPlaying</a>() <span class="keyword">const</span>;
00158
00165 <span class="keywordtype">bool</span> <a class="code" href="classZE_1_1ZMusic.html#a13">IsPaused</a>() <span class="keyword">const</span>;
00166
00173 <span class="keywordtype">int</span> <a class="code" href="classZE_1_1ZMusic.html#a14">Volume</a>() <span class="keyword">const</span>;
00174 };
00175
00176
00177 }
00178
00179 <span class="preprocessor">#endif //USE_SDL_MIXER</span>
00180 <span class="preprocessor"></span>
00181 <span class="preprocessor">#endif //__ze_zmusic_h__</span>
</pre></div><hr><address style="align: right;"><small>Generated on Sun Jun 29 14:13:51 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
2003-07-05 00:40:44 +00:00
width=110 height=53></a>1.3 </small></address>
2003-04-27 22:15:26 +00:00
</body>
</html>