| Safe Haskell | None |
|---|
HGamer3D.Bindings.SFML.ClassSoundSource
- delete :: HG3DClass -> IO ()
- setPitch :: HG3DClass -> Float -> IO ()
- setVolume :: HG3DClass -> Float -> IO ()
- setPosition :: HG3DClass -> Float -> Float -> Float -> IO ()
- setRelativeToListener :: HG3DClass -> Bool -> IO ()
- setMinDistance :: HG3DClass -> Float -> IO ()
- setAttenuation :: HG3DClass -> Float -> IO ()
- getPitch :: HG3DClass -> IO Float
- getVolume :: HG3DClass -> IO Float
- isRelativeToListener :: HG3DClass -> IO Bool
- getMinDistance :: HG3DClass -> IO Float
- getAttenuation :: HG3DClass -> IO Float
- delete'_ :: HG3DClassPtr -> IO ()
- setPitch'_ :: HG3DClassPtr -> CFloat -> IO ()
- setVolume'_ :: HG3DClassPtr -> CFloat -> IO ()
- setPosition'_ :: HG3DClassPtr -> CFloat -> CFloat -> CFloat -> IO ()
- setRelativeToListener'_ :: HG3DClassPtr -> CInt -> IO ()
- setMinDistance'_ :: HG3DClassPtr -> CFloat -> IO ()
- setAttenuation'_ :: HG3DClassPtr -> CFloat -> IO ()
- getPitch'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()
- getVolume'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()
- isRelativeToListener'_ :: HG3DClassPtr -> Ptr CInt -> IO ()
- getMinDistance'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()
- getAttenuation'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()
Documentation
Arguments
| :: HG3DClass | classpointer - pointer of Class instance which is going to be deleted. |
| -> IO () |
Destructor.
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> Float | pitch |
| -> IO () |
Set the volume of the sound. - Details: The volume is a value between 0 (mute) and 100 (full volume). The default value for the volume is 100.
Set the pitch of the sound. - Details: 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.
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> Float | volume |
| -> IO () |
Set the 3D position of the sound in the audio scene. - Details: Only sounds with one channel (mono sounds) can be spatialized. The default position of a sound is (0, 0, 0).
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> Float | x |
| -> Float | y |
| -> Float | z |
| -> IO () |
Make the sound's position relative to the listener or absolute. - Details: 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).
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> Bool | relative |
| -> IO () |
Set the minimum distance of the sound. - Details: 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.
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> Float | distance |
| -> IO () |
Set the attenuation factor of the sound. - Details: 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.
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> Float | attenuation |
| -> IO () |
Get the pitch of the sound. - Details: setPitch
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO Float | return value - Volume of the sound, in the range [0, 100] |
Get the volume of the sound. - Details: setVolume
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO Bool | return value - True if the position is relative, false if it's absolute |
Tell whether the sound's position is relative to the listener or is absolute. - Details: setRelativeToListener
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO Float | return value - Minimum distance of the sound |
Get the minimum distance of the sound. - Details: setMinDistancegetAttenuation
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO Float | return value - Attenuation factor of the sound |
Get the attenuation factor of the sound. - Details: setAttenuationgetMinDistance
delete'_ :: HG3DClassPtr -> IO ()Source
setPitch'_ :: HG3DClassPtr -> CFloat -> IO ()Source
setVolume'_ :: HG3DClassPtr -> CFloat -> IO ()Source
setPosition'_ :: HG3DClassPtr -> CFloat -> CFloat -> CFloat -> IO ()Source
setRelativeToListener'_ :: HG3DClassPtr -> CInt -> IO ()Source
setMinDistance'_ :: HG3DClassPtr -> CFloat -> IO ()Source
setAttenuation'_ :: HG3DClassPtr -> CFloat -> IO ()Source
getPitch'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()Source
getVolume'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()Source
isRelativeToListener'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
getMinDistance'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()Source
getAttenuation'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()Source