HGamer3D.Bindings.SFML.ClassSound

Documentation

new

Arguments

:: IO HG3DClass

Default constructor.

delete

Arguments

:: HG3DClass

classpointer - pointer of Class instance which is going to be deleted.

-> IO ()

Start or resume playing the sound. - Details: This function starts the stream 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.

Destructor.

play

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO ()

Pause the sound. - Details: This function pauses the sound if it was playing, otherwise (sound already paused or stopped) it has no effect.

pause

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO ()

Stop playing the sound. - Details: 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()

stop

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO ()

Set the source buffer containing the audio data to play. - Details: It is important to note that the sound buffer is not copied, thus the sf::SoundBuffer

setBuffer

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> HG3DClass

buffer

-> IO ()

Set whether or not the sound should loop after reaching the end. - Details: If set, the sound will restart from beginning after reaching the end and so on, until it is stopped or setLoop(false) is called. The default looping state for sound is false.

setLoop

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Bool

loop

-> IO ()

Tell whether or not the sound is in loop mode. - Details: setLoop

getLoop

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Bool

return value - True if the sound is looping, false otherwise

resetBuffer

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO ()

Reset the internal buffer of the sound. - Details: This function is for internal use only, you don't have to use it. It is called by the sf::SoundBuffer

new'_ :: HG3DClassPtr -> IO ()

delete'_ :: HG3DClassPtr -> IO ()

play'_ :: HG3DClassPtr -> IO ()

pause'_ :: HG3DClassPtr -> IO ()

stop'_ :: HG3DClassPtr -> IO ()

setBuffer'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()

setLoop'_ :: HG3DClassPtr -> CInt -> IO ()

getLoop'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

resetBuffer'_ :: HG3DClassPtr -> IO ()