orx 1.16
Portable Game Engine
Loading...
Searching...
No Matches
orxTimeLine.h
Go to the documentation of this file.
1/* Orx - Portable Game Engine
2 *
3 * Copyright (c) 2008- 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
32
41
42
43#ifndef _orxTIMELINE_H_
44#define _orxTIMELINE_H_
45
46
47#include "orxInclude.h"
48#include "object/orxStructure.h"
49
50
53typedef struct __orxTIMELINE_t orxTIMELINE;
54
55
72
75typedef struct __orxTIMELINE_EVENT_PAYLOAD_t
76{
78 const orxSTRING zTrackName;
79 const orxSTRING zEvent;
80 orxFLOAT fTimeStamp;
81
83
84
87extern orxDLLAPI void orxFASTCALL orxTimeLine_Setup();
88
93
96extern orxDLLAPI void orxFASTCALL orxTimeLine_Exit();
97
102
107extern orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_Delete(orxTIMELINE *_pstTimeLine);
108
113
118extern orxDLLAPI void orxFASTCALL orxTimeLine_Enable(orxTIMELINE *_pstTimeLine, orxBOOL _bEnable);
119
124extern orxDLLAPI orxBOOL orxFASTCALL orxTimeLine_IsEnabled(const orxTIMELINE *_pstTimeLine);
125
131extern orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_AddTrackFromConfig(orxTIMELINE *_pstTimeLine, const orxSTRING _zTrackID);
132
138extern orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_RemoveTrackFromConfig(orxTIMELINE *_pstTimeLine, const orxSTRING _zTrackID);
139
144extern orxDLLAPI orxU32 orxFASTCALL orxTimeLine_GetCount(const orxTIMELINE *_pstTimeLine);
145
150extern orxDLLAPI orxFLOAT orxFASTCALL orxTimeLine_GetTrackDuration(const orxSTRING _zTrackID);
151
152#endif /* _orxTIMELINE_H_ */
153
#define orxDLLAPI
Definition orxDecl.h:381
#define orxTIMELINE(STRUCTURE)
orxTIMELINE_EVENT
Definition orxTimeLine.h:59
orxDLLAPI orxU32 orxFASTCALL orxTimeLine_GetCount(const orxTIMELINE *_pstTimeLine)
orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_AddTrackFromConfig(orxTIMELINE *_pstTimeLine, const orxSTRING _zTrackID)
orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_Delete(orxTIMELINE *_pstTimeLine)
orxDLLAPI void orxFASTCALL orxTimeLine_Enable(orxTIMELINE *_pstTimeLine, orxBOOL _bEnable)
orxDLLAPI void orxFASTCALL orxTimeLine_Exit()
orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_RemoveTrackFromConfig(orxTIMELINE *_pstTimeLine, const orxSTRING _zTrackID)
orxDLLAPI orxFLOAT orxFASTCALL orxTimeLine_GetTrackDuration(const orxSTRING _zTrackID)
orxDLLAPI orxTIMELINE *orxFASTCALL orxTimeLine_Create()
orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_ClearCache()
orxDLLAPI orxBOOL orxFASTCALL orxTimeLine_IsEnabled(const orxTIMELINE *_pstTimeLine)
orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_Init()
orxDLLAPI void orxFASTCALL orxTimeLine_Setup()
struct __orxTIMELINE_t orxTIMELINE
Definition orxTimeLine.h:53
@ orxTIMELINE_EVENT_TRACK_STOP
Definition orxTimeLine.h:61
@ orxTIMELINE_EVENT_TRIGGER
Definition orxTimeLine.h:65
@ orxTIMELINE_EVENT_TRACK_REMOVE
Definition orxTimeLine.h:63
@ orxTIMELINE_EVENT_TRACK_START
Definition orxTimeLine.h:60
@ orxTIMELINE_EVENT_LOOP
Definition orxTimeLine.h:64
@ orxTIMELINE_EVENT_NONE
Definition orxTimeLine.h:69
@ orxTIMELINE_EVENT_TRACK_ADD
Definition orxTimeLine.h:62
@ orxTIMELINE_EVENT_NUMBER
Definition orxTimeLine.h:67
orxSTATUS
Definition orxType.h:270
orxTIMELINE * pstTimeLine
Definition orxTimeLine.h:77
const orxSTRING zTrackName
Definition orxTimeLine.h:78
const orxSTRING zEvent
Definition orxTimeLine.h:79

Generated for orx by doxygen 1.8.11