TSoundEffect.h

Engine/source/Verve/Torque/TSoundEffect.h

More...

Namespaces:

Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Verve
 4// Copyright (C) 2014 - Violent Tulip
 5//
 6// Permission is hereby granted, free of charge, to any person obtaining a copy
 7// of this software and associated documentation files (the "Software"), to
 8// deal in the Software without restriction, including without limitation the
 9// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10// sell copies of the Software, and to permit persons to whom the Software is
11// furnished to do so, subject to the following conditions:
12//
13// The above copyright notice and this permission notice shall be included in
14// all copies or substantial portions of the Software.
15//
16// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22// IN THE SOFTWARE.
23//-----------------------------------------------------------------------------
24#ifndef _VT_TORQUE_SOUNDEFFECT_H_
25#define _VT_TORQUE_SOUNDEFFECT_H_
26
27#ifndef _SFXPROFILE_H_
28#include "sfx/sfxProfile.h"
29#endif
30
31#ifndef _SFXSOUND_H_
32#include "sfx/sfxSound.h"
33#endif
34
35#ifndef _VT_TORQUE_SCENEOBJECT_H_
36#include "Verve/Torque/TSceneObject.h"
37#endif
38
39namespace VTorque
40{
41    typedef SFXProfile     SoundEffectType;
42    typedef SFXSound       SoundSourceType;
43
44    bool                   isSoundLooping( SoundEffectType *pSoundProfile );
45    S32                    getSoundDuration( SoundEffectType *pSoundProfile );
46
47    SoundSourceType       *playSound( SoundEffectType *pSoundProfile, const U32 &pPosition, const F32 &pPitch );
48    SoundSourceType       *playSound( SoundEffectType *pSoundProfile, SceneObjectType *pObject, const U32 &pPosition, const F32 &pPitch );
49
50    void                   playSound( SoundSourceType *pSource );
51    void                   pauseSound( SoundSourceType *pSource );
52    void                   stopSound( SoundSourceType *pSource );
53
54    void                   setSoundPosition( SoundSourceType *pSource, const U32 &pPosition );
55    void                   setSoundPitch( SoundSourceType *pSource, const F32 &pPitch );
56};
57
58#endif // _VT_TORQUE_SOUNDEFFECT_H_
59