This repository has been archived by the owner on Jun 11, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 73
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Geometry: Quad -> Quads, Triangle -> Triangles
- Loading branch information
Showing
4 changed files
with
140 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,129 @@ | ||
<html><head> | ||
<META http-equiv="content-type" content="text/html; charset=utf-8"> | ||
<title>Dgame.Audio.Music</title> | ||
</head><body> | ||
<h1>Dgame.Audio.Music</h1> | ||
<!-- Generated by Ddoc from ..\Audio\Music.d --> | ||
<br><br> | ||
<dl><dt><big><a name="Music"></a>struct <u>Music</u>; | ||
</big></dt> | ||
<dd><u>Music</u> represents the functionality to load and play music files. | ||
<br><br> | ||
<b>Note:</b><br> | ||
<u>Music</u> is designed to load and play <b>larger</b> music files, e.g. background music | ||
If you just want to play short sounds, use Sound. | ||
<br><br> | ||
|
||
Supported formats are .wav, .mp3, .vorbis, .ogg, .midi | ||
|
||
<br><br> | ||
<b>Author:</b><br> | ||
Randy Schuett (rswhite4@googlemail.com)<br><br> | ||
|
||
<dl><dt><big><a name="Music.this"></a>nothrow @nogc this(string <i>filename</i>, ubyte <i>volume</i> = 128); | ||
</big></dt> | ||
<dd>CTor<br><br> | ||
|
||
</dd> | ||
<dt><big><a name="Music.loadFromFile"></a>nothrow @nogc bool <u>loadFromFile</u>(string <i>filename</i>); | ||
</big></dt> | ||
<dd>Load the music file (<i>filename</i>). | ||
Returns if the loading was successful. | ||
If not, an error message is showed which describes what the problem is.<br><br> | ||
|
||
</dd> | ||
<dt><big><a name="Music.setVolume"></a>const nothrow @nogc ubyte <u>setVolume</u>(ubyte <i>volume</i>); | ||
</big></dt> | ||
<dd>Set the <i>volume</i>, max. is 128, min. is 0 | ||
If the value is above 128, the max. will be assumed. | ||
Returns the previous <i>volume</i>.<br><br> | ||
|
||
</dd> | ||
<dt><big><a name="Music.getVolume"></a>const nothrow @nogc ubyte <u>getVolume</u>(); | ||
</big></dt> | ||
<dd>Returns the current volume<br><br> | ||
|
||
</dd> | ||
<dt><big><a name="Music.play"></a>nothrow @nogc void <u>play</u>(byte <i>loops</i> = 1, short <i>delay</i> = -1); | ||
</big></dt> | ||
<dd>Plays the music. | ||
<i>loops</i> describe how often the music shall be played. | ||
A value of -1 indicated, that the music plays forever, | ||
a value of 0 means, that the music plays zero times. | ||
<i>delay</i> is the time in ms to fade in. | ||
Any previous music will be halted.<br><br> | ||
|
||
</dd> | ||
<dt><big><a name="Music.resume"></a>const nothrow @nogc void <u>resume</u>(); | ||
</big></dt> | ||
<dd>Resume the music playback | ||
<br><br> | ||
<b>See:</b><br> | ||
pause | ||
<br><br> | ||
<b>See:</b><br> | ||
stop<br><br> | ||
|
||
</dd> | ||
<dt><big><a name="Music.stop"></a>const nothrow @nogc void <u>stop</u>(); | ||
</big></dt> | ||
<dd>Stop/Halt the music playback | ||
<br><br> | ||
<b>See:</b><br> | ||
resume<br><br> | ||
|
||
</dd> | ||
<dt><big><a name="Music.pause"></a>const nothrow @nogc void <u>pause</u>(); | ||
</big></dt> | ||
<dd>Pause the music playback | ||
<br><br> | ||
<b>See:</b><br> | ||
resume<br><br> | ||
|
||
</dd> | ||
<dt><big><a name="Music.rewind"></a>const nothrow @nogc void <u>rewind</u>(); | ||
</big></dt> | ||
<dd>Rewind the music to the start | ||
<br><br> | ||
<b>Note:</b><br> | ||
This function only works for .ogg, .vorbis, .mp3, .midi<br><br> | ||
|
||
</dd> | ||
<dt><big><a name="Music.fadeOut"></a>nothrow @nogc void <u>fadeOut</u>(ushort <i>ms</i>); | ||
</big></dt> | ||
<dd>Fade out the music. The music will be stopped in <i>ms</i> milliseconds.<br><br> | ||
|
||
</dd> | ||
<dt><big><a name="Music.setPosition"></a>const nothrow @nogc void <u>setPosition</u>(float <i>seconds</i>); | ||
</big></dt> | ||
<dd>Set the position of the currently playing music. | ||
The position takes different meanings for different music sources. | ||
<br><br> | ||
<b>.ogg / .vorbis:</b> | ||
Jumps to position <i>seconds</i> from the beginning of the song. | ||
<b>mp3:</b> | ||
Jumps to position <i>seconds</i> from the current position in the stream. | ||
So you may want to call rewind before. | ||
<b>Does not go in reverse: negative values do nothing.</b> | ||
|
||
<br><br> | ||
<b>Note:</b><br> | ||
This only works for.ogg, .vorbis and .mp3<br><br> | ||
|
||
</dd> | ||
<dt><big><a name="Music.isPlaying"></a>const nothrow @nogc bool <u>isPlaying</u>(); | ||
</big></dt> | ||
<dd>Returns if the music is currently playing<br><br> | ||
|
||
</dd> | ||
<dt><big><a name="Music.isPaused"></a>const nothrow @nogc bool <u>isPaused</u>(); | ||
</big></dt> | ||
<dd>Returns if the music is currently paused<br><br> | ||
|
||
</dd> | ||
</dl> | ||
</dd> | ||
</dl> | ||
|
||
<hr><small>Page generated by <a href="http://dlang.org/ddoc.html">Ddoc</a>. </small> | ||
</body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters