Commit | Line | Data |
d49f81db |
1 | <div class="pod"> |
2 | <!-- INDEX START --> |
3 | <h3 id="TOP">Index</h3> |
4 | |
5 | <ul><li><a href="#NAME">NAME</a></li> |
b5d537cc |
6 | <li><a href="#CATEGORY">CATEGORY</a></li> |
7 | <li><a href="#DESCRIPTION">DESCRIPTION</a></li> |
8 | <li><a href="#METHODS">METHODS</a> |
9 | <ul><li><a href="#PerlMixMusicHook">PerlMixMusicHook</a></li> |
10 | <li><a href="#mix_audio">mix_audio</a></li> |
11 | <li><a href="#load_WAV">load_WAV</a></li> |
12 | <li><a href="#load_MUS">load_MUS</a></li> |
13 | <li><a href="#free_music">free_music</a></li> |
14 | <li><a href="#hook_music">hook_music</a></li> |
15 | <li><a href="#hook_music_finished">hook_music_finished</a></li> |
16 | <li><a href="#get_music_hook_data">get_music_hook_data</a></li> |
17 | <li><a href="#play_music">play_music</a></li> |
18 | <li><a href="#fade_in_music">fade_in_music</a></li> |
19 | <li><a href="#volume_music">volume_music</a></li> |
20 | <li><a href="#halt_music">halt_music</a></li> |
21 | <li><a href="#fade_out_music">fade_out_music</a></li> |
22 | <li><a href="#fading_music">fading_music</a></li> |
23 | <li><a href="#pause_music">pause_music</a></li> |
24 | <li><a href="#resume_music">resume_music</a></li> |
25 | <li><a href="#rewind_music">rewind_music</a></li> |
26 | <li><a href="#paused_music">paused_music</a></li> |
27 | <li><a href="#playing_music">playing_music</a> |
28 | </li> |
29 | </ul> |
d49f81db |
30 | </li> |
31 | </ul><hr /> |
32 | <!-- INDEX END --> |
33 | |
34 | <h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p> |
35 | <div id="NAME_CONTENT"> |
36 | <p>SDL::Mixer::Music -- SDL_Mixer music functions and bindings</p> |
37 | |
38 | </div> |
39 | <h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p> |
40 | <div id="CATEGORY_CONTENT"> |
b5d537cc |
41 | <p>Mixer</p> |
42 | |
43 | </div> |
44 | <h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p> |
45 | <div id="DESCRIPTION_CONTENT"> |
46 | |
47 | </div> |
48 | <h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
49 | <div id="METHODS_CONTENT"> |
50 | |
51 | </div> |
52 | <h2 id="PerlMixMusicHook">PerlMixMusicHook</h2> |
53 | <div id="PerlMixMusicHook_CONTENT"> |
54 | |
55 | </div> |
56 | <h2 id="mix_audio">mix_audio</h2> |
57 | <div id="mix_audio_CONTENT"> |
58 | <p>Same as SDL::Audio::mix()</p> |
59 | |
60 | </div> |
61 | <h2 id="load_WAV">load_WAV</h2> |
62 | <div id="load_WAV_CONTENT"> |
63 | <p>has to be implemented</p> |
64 | |
65 | </div> |
66 | <h2 id="load_MUS">load_MUS</h2> |
67 | <div id="load_MUS_CONTENT"> |
071b4b10 |
68 | <pre> my $music = SDL::Mixer::Music::load_MUS( $file ); |
69 | |
70 | </pre> |
71 | <p><code>load_MUS</code> loads a music file into a <code>SDL::Music::MixMusic</code> structure. This can be passed to <a href="http://search.cpan.org/perldoc?play_music">play_music</a>.</p> |
b5d537cc |
72 | |
73 | </div> |
74 | <h2 id="free_music">free_music</h2> |
75 | <div id="free_music_CONTENT"> |
76 | |
77 | </div> |
78 | <h2 id="hook_music">hook_music</h2> |
79 | <div id="hook_music_CONTENT"> |
80 | |
81 | </div> |
82 | <h2 id="hook_music_finished">hook_music_finished</h2> |
83 | <div id="hook_music_finished_CONTENT"> |
84 | |
85 | </div> |
86 | <h2 id="get_music_hook_data">get_music_hook_data</h2> |
87 | <div id="get_music_hook_data_CONTENT"> |
88 | |
89 | </div> |
90 | <h2 id="play_music">play_music</h2> |
91 | <div id="play_music_CONTENT"> |
071b4b10 |
92 | <pre> my $play_music = SDL::Mixer::Music::play_music( $mix_music, $repeats ); |
93 | |
94 | </pre> |
95 | <p><code>play_music</code> plays a given <code>SDL::Mixer::MixMusic</code>. |
96 | Passing -1 to <code>$repeats</code> will loop the music infinitely. </p> |
97 | <p>Example:</p> |
98 | <pre> my $music = SDL::Mixer::Music::load_MUS( 'music.mp3' ); |
99 | |
100 | unless(SDL::Mixer::Music::play_music($sample_music, -1)) |
101 | { |
102 | print("Something went wrong!\n"); |
103 | } |
104 | |
105 | |
106 | |
107 | |
108 | </pre> |
b5d537cc |
109 | |
110 | </div> |
111 | <h2 id="fade_in_music">fade_in_music</h2> |
112 | <div id="fade_in_music_CONTENT"> |
113 | |
114 | </div> |
115 | <h2 id="volume_music">volume_music</h2> |
116 | <div id="volume_music_CONTENT"> |
117 | |
118 | </div> |
119 | <h2 id="halt_music">halt_music</h2> |
120 | <div id="halt_music_CONTENT"> |
071b4b10 |
121 | <pre> SDL::Mixer::Music::halt_music(); |
122 | |
123 | </pre> |
124 | <p>Halts the music.</p> |
b5d537cc |
125 | |
126 | </div> |
127 | <h2 id="fade_out_music">fade_out_music</h2> |
128 | <div id="fade_out_music_CONTENT"> |
129 | |
130 | </div> |
131 | <h2 id="fading_music">fading_music</h2> |
132 | <div id="fading_music_CONTENT"> |
071b4b10 |
133 | <pre> my $fading_music = SDL::Mixer::Channels::fading_music(); |
134 | |
135 | </pre> |
136 | <p>Returns one of the following:</p> |
137 | <ul> |
138 | <li>MIX_NO_FADING </li> |
139 | <li>MIX_FADING_OUT </li> |
140 | <li>MIX_FADING_IN</li> |
141 | </ul> |
142 | |
b5d537cc |
143 | |
144 | </div> |
145 | <h2 id="pause_music">pause_music</h2> |
146 | <div id="pause_music_CONTENT"> |
071b4b10 |
147 | <pre> SDL::Mixer::Music::pause_music(); |
148 | |
149 | </pre> |
150 | <p>Pauses the music.</p> |
b5d537cc |
151 | |
152 | </div> |
153 | <h2 id="resume_music">resume_music</h2> |
154 | <div id="resume_music_CONTENT"> |
071b4b10 |
155 | <pre> |
156 | |
157 | |
158 | SDL::Mixer::Music::resume_music(); |
159 | |
160 | </pre> |
161 | <p>Resumes the music.</p> |
b5d537cc |
162 | |
163 | </div> |
164 | <h2 id="rewind_music">rewind_music</h2> |
165 | <div id="rewind_music_CONTENT"> |
071b4b10 |
166 | <pre> |
167 | |
168 | |
169 | SDL::Mixer::Music::rewind_music(); |
170 | |
171 | </pre> |
172 | <p>Rewinds the music.</p> |
b5d537cc |
173 | |
174 | </div> |
175 | <h2 id="paused_music">paused_music</h2> |
176 | <div id="paused_music_CONTENT"> |
071b4b10 |
177 | <pre> my $paused = SDL::Mixer::Music::paused_music(); |
178 | |
179 | </pre> |
180 | <p>Returns <code>1</code> if the music is paused, otherwise <code>0</code>.</p> |
b5d537cc |
181 | |
182 | </div> |
183 | <h2 id="playing_music">playing_music</h2> |
184 | <div id="playing_music_CONTENT"> |
071b4b10 |
185 | <pre> my $playing_music = SDL::Mixer::Music::playing_music(); |
186 | |
187 | </pre> |
188 | <p>Returns <code>1</code> if the music is playing sound, otherwise <code>0</code>. It does'nt check if the music is paused.</p> |
d49f81db |
189 | |
190 | </div> |
191 | </div> |