orx  stable
Portable Game Engine
orxTimeLine.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 _orxTIMELINE_H_
44 #define _orxTIMELINE_H_
45 
46 
47 #include "orxInclude.h"
48 #include "object/orxStructure.h"
49 
50 
53 typedef struct __orxTIMELINE_t orxTIMELINE;
54 
55 
58 typedef enum __orxTIMELINE_EVENT_t
59 {
68 
69  orxTIMELINE_EVENT_NONE = orxENUM_NONE
70 
72 
75 typedef struct __orxTIMELINE_EVENT_PAYLOAD_t
76 {
78  const orxSTRING zTrackName;
79  const orxSTRING zEvent;
80  orxFLOAT fTimeStamp;
83 
84 
87 extern orxDLLAPI void orxFASTCALL orxTimeLine_Setup();
88 
92 extern orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_Init();
93 
96 extern orxDLLAPI void orxFASTCALL orxTimeLine_Exit();
97 
101 extern orxDLLAPI orxTIMELINE *orxFASTCALL orxTimeLine_Create();
102 
107 extern orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_Delete(orxTIMELINE *_pstTimeLine);
108 
112 extern orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_ClearCache();
113 
118 extern orxDLLAPI void orxFASTCALL orxTimeLine_Enable(orxTIMELINE *_pstTimeLine, orxBOOL _bEnable);
119 
124 extern orxDLLAPI orxBOOL orxFASTCALL orxTimeLine_IsEnabled(const orxTIMELINE *_pstTimeLine);
125 
131 extern orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_AddTrackFromConfig(orxTIMELINE *_pstTimeLine, const orxSTRING _zTrackID);
132 
138 extern orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_RemoveTrackFromConfig(orxTIMELINE *_pstTimeLine, const orxSTRING _zTrackID);
139 
144 extern orxDLLAPI orxFLOAT orxFASTCALL orxTimeLine_GetTrackDuration(const orxSTRING _zTrackID);
145 
146 #endif /* _orxTIMELINE_H_ */
147 
struct __orxTIMELINE_t orxTIMELINE
Definition: orxTimeLine.h:53
orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_AddTrackFromConfig(orxTIMELINE *_pstTimeLine, const orxSTRING _zTrackID)
orxTIMELINE_EVENT
Definition: orxTimeLine.h:58
orxTIMELINE * pstTimeLine
Definition: orxTimeLine.h:77
orxDLLAPI void orxFASTCALL orxTimeLine_Setup()
orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_ClearCache()
orxDLLAPI void orxFASTCALL orxTimeLine_Exit()
orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_RemoveTrackFromConfig(orxTIMELINE *_pstTimeLine, const orxSTRING _zTrackID)
const orxSTRING zEvent
Definition: orxTimeLine.h:79
orxSTATUS
Definition: orxType.h:243
const orxSTRING zTrackName
Definition: orxTimeLine.h:78
orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_Delete(orxTIMELINE *_pstTimeLine)
#define orxDLLAPI
Definition: orxDecl.h:387
orxDLLAPI void orxFASTCALL orxTimeLine_Enable(orxTIMELINE *_pstTimeLine, orxBOOL _bEnable)
orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_Init()
orxDLLAPI orxFLOAT orxFASTCALL orxTimeLine_GetTrackDuration(const orxSTRING _zTrackID)
orxDLLAPI orxBOOL orxFASTCALL orxTimeLine_IsEnabled(const orxTIMELINE *_pstTimeLine)
orxDLLAPI orxTIMELINE *orxFASTCALL orxTimeLine_Create()

Generated for orx by doxygen 1.5.6