updated gfx (categories) and stubs for mixer (still TODO)
[sdlgit/SDL-Site.git] / pages / SDL-Mixer.html-inc
CommitLineData
162a0989 1<div class="pod">
2<!-- INDEX START -->
3<h3 id="TOP">Index</h3>
4
5<ul><li><a href="#NAME">NAME</a></li>
bfdd9c2e 6<li><a href="#CATEGORY">CATEGORY</a></li>
162a0989 7<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
8<li><a href="#METHODS">METHODS</a>
b5d537cc 9<ul><li><a href="#init">init</a></li>
10<li><a href="#quit">quit</a></li>
11<li><a href="#linked_version">linked_version</a></li>
12<li><a href="#open_audio">open_audio</a></li>
13<li><a href="#close_audio">close_audio</a></li>
14<li><a href="#query_spec">query_spec</a></li>
162a0989 15</ul>
16</li>
449a007b 17<li><a href="#AUTHORS">AUTHORS </a></li>
18<li><a href="#SEE_ALSO">SEE ALSO</a>
162a0989 19</li>
20</ul><hr />
21<!-- INDEX END -->
22
23<h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
24<div id="NAME_CONTENT">
b5d537cc 25<p>SDL::Mixer - Sound and music functions</p>
162a0989 26
27</div>
bfdd9c2e 28<h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p>
29<div id="CATEGORY_CONTENT">
30<p>Mixer</p>
31
32</div>
162a0989 33<h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
34<div id="DESCRIPTION_CONTENT">
b5d537cc 35<p>SDL::Mixer allows you to enable sound, alter music volume settings, and lets you play, pause and resume, as well as fading the sound and music
36in and out.</p>
162a0989 37
38</div>
39<h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p>
40<div id="METHODS_CONTENT">
41
42</div>
b5d537cc 43<h2 id="init">init</h2>
44<div id="init_CONTENT">
45<pre> int SDL::Mixer::init(flags)
162a0989 46
47</pre>
b5d537cc 48<p><strong>Note</strong>: Only available for SDL::Mixer &gt;= 1.2.10</p>
162a0989 49
50</div>
b5d537cc 51<h2 id="quit">quit</h2>
52<div id="quit_CONTENT">
53<pre> void SDL::Mixer::quit()
162a0989 54
55</pre>
b5d537cc 56<p><strong>Note</strong>: Only available for SDL::Mixer &gt;= 1.2.10</p>
162a0989 57
58</div>
b5d537cc 59<h2 id="linked_version">linked_version</h2>
60<div id="linked_version_CONTENT">
61<pre> const SDL_version * SDL::Mixer::linked_version ()
162a0989 62
63</pre>
162a0989 64
65</div>
b5d537cc 66<h2 id="open_audio">open_audio</h2>
67<div id="open_audio_CONTENT">
68<pre> int SDL::Mixer::open_audio ( frequency, format, channels, chunksize )
162a0989 69
b5d537cc 70</pre>
162a0989 71
72</div>
b5d537cc 73<h2 id="close_audio">close_audio</h2>
74<div id="close_audio_CONTENT">
75<pre> void SDL::Mixer::close_audio ()
162a0989 76
b5d537cc 77</pre>
162a0989 78
79</div>
b5d537cc 80<h2 id="query_spec">query_spec</h2>
81<div id="query_spec_CONTENT">
82<pre> AV * SDL::Mixer::query_spec ()
83 CODE:
84 int freq, channels, status;
85 Uint16 format;
86 status = Mix_QuerySpec(&amp;freq,&amp;format,&amp;channels);
87 RETVAL = (AV*)sv_2mortal((SV*)newAV());
88 av_push(RETVAL,newSViv(status));
89 av_push(RETVAL,newSViv(freq));
90 av_push(RETVAL,newSViv(format));
91 av_push(RETVAL,newSViv(channels));
92 OUTPUT:
93 RETVAL
162a0989 94
b5d537cc 95</pre>
162a0989 96
97</div>
449a007b 98<h1 id="AUTHORS">AUTHORS </h1><p><a href="#TOP" class="toplink">Top</a></p>
99<div id="AUTHORS_CONTENT">
b5d537cc 100<p>Tobias Leich [FROGGS]</p>
449a007b 101
102</div>
103<h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p>
104<div id="SEE_ALSO_CONTENT">
46beffd8 105<p><a href="http://search.cpan.org/perldoc?perl">perl</a>, <a href="/SDL-Music.html">SDL::Music</a> and <a href="/SDL-Sound.html">SDL::Sound</a>.</p>
449a007b 106
107</div>
162a0989 108</div>