orx  stable
Portable Game Engine
orxSoundPointer.h
Go to the documentation of this file.
1 /* Orx - Portable Game Engine
2  *
3  * Copyright (c) 2008-2017 Orx-Project
4  *
5  * This software is provided 'as-is', without any express or implied
6  * warranty. In no event will the authors be held liable for any damages
7  * arising from the use of this software.
8  *
9  * Permission is granted to anyone to use this software for any purpose,
10  * including commercial applications, and to alter it and redistribute it
11  * freely, subject to the following restrictions:
12  *
13  * 1. The origin of this software must not be misrepresented; you must not
14  * claim that you wrote the original software. If you use this software
15  * in a product, an acknowledgment in the product documentation would be
16  * appreciated but is not required.
17  *
18  * 2. Altered source versions must be plainly marked as such, and must not be
19  * misrepresented as being the original software.
20  *
21  * 3. This notice may not be removed or altered from any source
22  * distribution.
23  */
24 
43 #ifndef _orxSOUNDPOINTER_H_
44 #define _orxSOUNDPOINTER_H_
45 
46 
47 #include "orxInclude.h"
48 #include "sound/orxSound.h"
49 #include "object/orxStructure.h"
50 
51 
54 #define orxSOUNDPOINTER_KU32_SOUND_NUMBER 4
55 
56 
58 typedef struct __orxSOUNDPOINTER_t orxSOUNDPOINTER;
59 
60 
63 extern orxDLLAPI void orxFASTCALL orxSoundPointer_Setup();
64 
68 extern orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Init();
69 
72 extern orxDLLAPI void orxFASTCALL orxSoundPointer_Exit();
73 
74 
79 
84 extern orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Delete(orxSOUNDPOINTER *_pstSoundPointer);
85 
90 extern orxDLLAPI void orxFASTCALL orxSoundPointer_Enable(orxSOUNDPOINTER *_pstSoundPointer, orxBOOL _bEnable);
91 
96 extern orxDLLAPI orxBOOL orxFASTCALL orxSoundPointer_IsEnabled(const orxSOUNDPOINTER *_pstSoundPointer);
97 
98 
104 extern orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_SetVolume(orxSOUNDPOINTER *_pstSoundPointer, orxFLOAT _fVolume);
105 
111 extern orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_SetPitch(orxSOUNDPOINTER *_pstSoundPointer, orxFLOAT _fPitch);
112 
113 
118 extern orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Play(orxSOUNDPOINTER *_pstSoundPointer);
119 
124 extern orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Pause(orxSOUNDPOINTER *_pstSoundPointer);
125 
130 extern orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Stop(orxSOUNDPOINTER *_pstSoundPointer);
131 
132 
138 extern orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_AddSound(orxSOUNDPOINTER *_pstSoundPointer, orxSOUND *_pstSound);
139 
145 extern orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveSound(orxSOUNDPOINTER *_pstSoundPointer, orxSOUND *_pstSound);
146 
151 extern orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveAllSounds(orxSOUNDPOINTER *_pstSoundPointer);
152 
158 extern orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_AddSoundFromConfig(orxSOUNDPOINTER *_pstSoundPointer, const orxSTRING _zSoundConfigID);
159 
165 extern orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveSoundFromConfig(orxSOUNDPOINTER *_pstSoundPointer, const orxSTRING _zSoundConfigID);
166 
171 extern orxDLLAPI orxSOUND *orxFASTCALL orxSoundPointer_GetLastAddedSound(const orxSOUNDPOINTER *_pstSoundPointer);
172 
173 #endif /* _orxSOUNDPOINTER_H_ */
174 
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Init()
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_AddSound(orxSOUNDPOINTER *_pstSoundPointer, orxSOUND *_pstSound)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Delete(orxSOUNDPOINTER *_pstSoundPointer)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Pause(orxSOUNDPOINTER *_pstSoundPointer)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveSoundFromConfig(orxSOUNDPOINTER *_pstSoundPointer, const orxSTRING _zSoundConfigID)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveSound(orxSOUNDPOINTER *_pstSoundPointer, orxSOUND *_pstSound)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_SetPitch(orxSOUNDPOINTER *_pstSoundPointer, orxFLOAT _fPitch)
orxDLLAPI void orxFASTCALL orxSoundPointer_Setup()
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Play(orxSOUNDPOINTER *_pstSoundPointer)
orxSTATUS
Definition: orxType.h:243
struct __orxSOUNDPOINTER_t orxSOUNDPOINTER
orxDLLAPI void orxFASTCALL orxSoundPointer_Exit()
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Stop(orxSOUNDPOINTER *_pstSoundPointer)
#define orxDLLAPI
Definition: orxDecl.h:387
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_SetVolume(orxSOUNDPOINTER *_pstSoundPointer, orxFLOAT _fVolume)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveAllSounds(orxSOUNDPOINTER *_pstSoundPointer)
orxDLLAPI void orxFASTCALL orxSoundPointer_Enable(orxSOUNDPOINTER *_pstSoundPointer, orxBOOL _bEnable)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_AddSoundFromConfig(orxSOUNDPOINTER *_pstSoundPointer, const orxSTRING _zSoundConfigID)
orxDLLAPI orxSOUND *orxFASTCALL orxSoundPointer_GetLastAddedSound(const orxSOUNDPOINTER *_pstSoundPointer)
orxDLLAPI orxSOUNDPOINTER *orxFASTCALL orxSoundPointer_Create()
orxDLLAPI orxBOOL orxFASTCALL orxSoundPointer_IsEnabled(const orxSOUNDPOINTER *_pstSoundPointer)
struct __orxSOUND_t orxSOUND
Definition: orxSound.h:76

Generated for orx by doxygen 1.5.6