orx  stable
Portable Game Engine
orxFXPointer.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 _orxFXPOINTER_H_
44 #define _orxFXPOINTER_H_
45 
46 
47 #include "orxInclude.h"
48 #include "object/orxFX.h"
49 #include "object/orxStructure.h"
50 
51 
54 #define orxFXPOINTER_KU32_FX_NUMBER 8
55 
56 
58 typedef struct __orxFXPOINTER_t orxFXPOINTER;
59 
60 
63 extern orxDLLAPI void orxFASTCALL orxFXPointer_Setup();
64 
68 extern orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_Init();
69 
72 extern orxDLLAPI void orxFASTCALL orxFXPointer_Exit();
73 
74 
78 extern orxDLLAPI orxFXPOINTER *orxFASTCALL orxFXPointer_Create();
79 
84 extern orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_Delete(orxFXPOINTER *_pstFXPointer);
85 
90 extern orxDLLAPI void orxFASTCALL orxFXPointer_Enable(orxFXPOINTER *_pstFXPointer, orxBOOL _bEnable);
91 
96 extern orxDLLAPI orxBOOL orxFASTCALL orxFXPointer_IsEnabled(const orxFXPOINTER *_pstFXPointer);
97 
98 
104 extern orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddFX(orxFXPOINTER *_pstFXPointer, orxFX *_pstFX);
105 
112 extern orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddDelayedFX(orxFXPOINTER *_pstFXPointer, orxFX *_pstFX, orxFLOAT _fDelay);
113 
119 extern orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_RemoveFX(orxFXPOINTER *_pstFXPointer, orxFX *_pstFX);
120 
126 extern orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddFXFromConfig(orxFXPOINTER *_pstFXPointer, const orxSTRING _zFXConfigID);
127 
133 extern orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddUniqueFXFromConfig(orxFXPOINTER *_pstFXPointer, const orxSTRING _zFXConfigID);
134 
141 extern orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddDelayedFXFromConfig(orxFXPOINTER *_pstFXPointer, const orxSTRING _zFXConfigID, orxFLOAT _fDelay);
142 
149 extern orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddUniqueDelayedFXFromConfig(orxFXPOINTER *_pstFXPointer, const orxSTRING _zFXConfigID, orxFLOAT _fDelay);
150 
156 extern orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_RemoveFXFromConfig(orxFXPOINTER *_pstFXPointer, const orxSTRING _zFXConfigID);
157 
158 
164 extern orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_Synchronize(orxFXPOINTER *_pstFXPointer, const orxFXPOINTER *_pstModel);
165 
166 
171 extern orxDLLAPI orxFLOAT orxFASTCALL orxFXPointer_GetTime(const orxFXPOINTER *_pstFXPointer);
172 
178 extern orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_SetTime(orxFXPOINTER *_pstFXPointer, orxFLOAT _fTime);
179 
180 #endif /* _orxFXPointer_H_ */
181 
struct __orxFXPOINTER_t orxFXPOINTER
Definition: orxFXPointer.h:58
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_Init()
orxDLLAPI void orxFASTCALL orxFXPointer_Enable(orxFXPOINTER *_pstFXPointer, orxBOOL _bEnable)
orxDLLAPI void orxFASTCALL orxFXPointer_Setup()
struct __orxFX_t orxFX
Definition: orxFX.h:79
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_Delete(orxFXPOINTER *_pstFXPointer)
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddUniqueFXFromConfig(orxFXPOINTER *_pstFXPointer, const orxSTRING _zFXConfigID)
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_SetTime(orxFXPOINTER *_pstFXPointer, orxFLOAT _fTime)
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_RemoveFX(orxFXPOINTER *_pstFXPointer, orxFX *_pstFX)
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddDelayedFX(orxFXPOINTER *_pstFXPointer, orxFX *_pstFX, orxFLOAT _fDelay)
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddFX(orxFXPOINTER *_pstFXPointer, orxFX *_pstFX)
orxSTATUS
Definition: orxType.h:243
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddDelayedFXFromConfig(orxFXPOINTER *_pstFXPointer, const orxSTRING _zFXConfigID, orxFLOAT _fDelay)
orxDLLAPI orxFXPOINTER *orxFASTCALL orxFXPointer_Create()
orxDLLAPI orxFLOAT orxFASTCALL orxFXPointer_GetTime(const orxFXPOINTER *_pstFXPointer)
orxDLLAPI void orxFASTCALL orxFXPointer_Exit()
orxDLLAPI orxBOOL orxFASTCALL orxFXPointer_IsEnabled(const orxFXPOINTER *_pstFXPointer)
#define orxDLLAPI
Definition: orxDecl.h:387
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddUniqueDelayedFXFromConfig(orxFXPOINTER *_pstFXPointer, const orxSTRING _zFXConfigID, orxFLOAT _fDelay)
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_RemoveFXFromConfig(orxFXPOINTER *_pstFXPointer, const orxSTRING _zFXConfigID)
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_Synchronize(orxFXPOINTER *_pstFXPointer, const orxFXPOINTER *_pstModel)
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddFXFromConfig(orxFXPOINTER *_pstFXPointer, const orxSTRING _zFXConfigID)

Generated for orx by doxygen 1.5.6