Safe Haskell | None |
---|---|
Language | Haskell98 |
- module SFML.Utils
- musicFromFile :: FilePath -> IO (Either SFException Music)
- musicFromMemory :: Ptr a -> Int -> IO (Either SFException Music)
- musicFromStream :: InputStream -> IO (Either SFException Music)
- destroy :: SFResource a => a -> IO ()
- setLoop :: SFSound a => a -> Bool -> IO ()
- getLoop :: SFSound a => a -> IO Bool
- getDuration :: SFSoundBuffer a => a -> IO Time
- play :: SFSound a => a -> IO ()
- pause :: SFSound a => a -> IO ()
- stop :: SFSound a => a -> IO ()
- getChannelCount :: SFSoundBuffer a => a -> IO Int
- getSampleRate :: SFSampled a => a -> IO Int
- getStatus :: SFSound a => a -> IO SoundStatus
- getPlayingOffset :: SFSound a => a -> IO Time
- setPitch :: SFSound a => a -> Float -> IO ()
- setVolume :: SFSound a => a -> Float -> IO ()
- setPosition :: SFSound a => a -> Vec3f -> IO ()
- setRelativeToListener :: SFSound a => a -> Bool -> IO ()
- setMinDistance :: SFSound a => a -> Float -> IO ()
- setAttenuation :: SFSound a => a -> Float -> IO ()
- setPlayingOffset :: SFSound a => a -> Time -> IO ()
- getPitch :: SFSound a => a -> IO Float
- getVolume :: SFSound a => a -> IO Float
- getPosition :: SFSound a => a -> IO Vec3f
- isRelativeToListener :: SFSound a => a -> IO Bool
- getMinDistance :: SFSound a => a -> IO Float
- getAttenuation :: SFSound a => a -> IO Float
Documentation
module SFML.Utils
musicFromFile :: FilePath -> IO (Either SFException Music) Source
Create a new music and load it from a file.
This function doesn't start playing the music (call
play
to do so).
Here is a complete list of all the supported audio formats: ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64.
:: Ptr a | Pointer to the file data in memory |
-> Int | Size of the data to load, in bytes |
-> IO (Either SFException Music) |
Create a new music and load it from a file in memory.
This function doesn't start playing the music (call
play
to do so).
Here is a complete list of all the supported audio formats: ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64.
musicFromStream :: InputStream -> IO (Either SFException Music) Source
Create a new music and load it from a custom stream.
This function doesn't start playing the music (call
play
to do so).
Here is a complete list of all the supported audio formats: ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64.
destroy :: SFResource a => a -> IO () Source
Destroy the given SFML resource.
getDuration :: SFSoundBuffer a => a -> IO Time Source
Get the total duration of a sound buffer.
play :: SFSound a => a -> IO () Source
Start or resume playing a sound.
This function starts the sound if it was stopped, resumes it if it was paused, and restarts it from beginning if it was it already playing.
This function uses its own thread so that it doesn't block the rest of the program while the sound is played.
pause :: SFSound a => a -> IO () Source
Pause a sound.
This function pauses the sound if it was playing, otherwise (sound already paused or stopped) it has no effect.
stop :: SFSound a => a -> IO () Source
Stop playing a sound.
This function stops the sound if it was playing or paused, and does nothing if it was already stopped.
It also resets the playing position (unlike pause
).
getChannelCount :: SFSoundBuffer a => a -> IO Int Source
Get the number of channels used by a sound buffer.
If the sound is mono then the number of channels will be 1, 2 for stereo, etc.
getSampleRate :: SFSampled a => a -> IO Int Source
Get the sample rate of a sound buffer.
The sample rate is the number of samples played per second. The higher, the better the quality (for example, 44100 samples/s is CD quality).
getStatus :: SFSound a => a -> IO SoundStatus Source
Get the current status of a sound (stopped, paused, playing).
getPlayingOffset :: SFSound a => a -> IO Time Source
Get the current playing position of a sound.
setPitch :: SFSound a => a -> Float -> IO () Source
Set the pitch of a sound.
The pitch represents the perceived fundamental frequency of a sound; thus you can make a sound more acute or grave by changing its pitch. A side effect of changing the pitch is to modify the playing speed of the sound as well.
The default value for the pitch is 1.
setVolume :: SFSound a => a -> Float -> IO () Source
Set the volume of a sound.
The volume is a value between 0 (mute) and 100 (full volume).
The default value for the volume is 100.
setPosition :: SFSound a => a -> Vec3f -> IO () Source
Set the 3D position of a sound in the audio scene.
Only sounds with one channel (mono sounds) can be spatialized.
The default position of a sound is (0, 0, 0).
setRelativeToListener :: SFSound a => a -> Bool -> IO () Source
Make the sound's position relative to the listener or absolute.
Making a sound relative to the listener will ensure that it will always be played the same way regardless the position of the listener. This can be useful for non-spatialized sounds, sounds that are produced by the listener, or sounds attached to it.
The default value is false (position is absolute).
setMinDistance :: SFSound a => a -> Float -> IO () Source
Set the minimum distance of a sound.
The minimum distance of a sound is the maximum distance at which it is heard at its maximum volume. Further than the minimum distance, it will start to fade out according to its attenuation factor. A value of 0 (inside the head of the listener) is an invalid value and is forbidden.
The default value of the minimum distance is 1.
setAttenuation :: SFSound a => a -> Float -> IO () Source
Set the attenuation factor of a sound.
The attenuation is a multiplicative factor which makes the sound more or less loud according to its distance from the listener. An attenuation of 0 will produce a non-attenuated sound, i.e. its volume will always be the same whether it is heard from near or from far. On the other hand, an attenuation value such as 100 will make the sound fade out very quickly as it gets further from the listener.
The default value of the attenuation is 1.
setPlayingOffset :: SFSound a => a -> Time -> IO () Source
Change the current playing position of a sound.
The playing position can be changed when the sound is either paused or playing.
getPosition :: SFSound a => a -> IO Vec3f Source
Get the 3D position of a sound in the audio scene.
isRelativeToListener :: SFSound a => a -> IO Bool Source
Tell whether a sound's position is relative to the listener or is absolute.
getMinDistance :: SFSound a => a -> IO Float Source
Get the minimum distance of a sound.
getAttenuation :: SFSound a => a -> IO Float Source
Get the attenuation factor of a sound.