Kohi Game Engine
ktimeline_system.h File Reference
#include "defines.h"

Go to the source code of this file.

Data Structures

struct  timeline_system_config
 

Macros

#define KTIMELINE_INVALID   INVALID_ID_U16
 

Typedefs

typedef struct timeline_system_config timeline_system_config
 
typedef u16 ktimeline
 

Functions

b8 ktimeline_system_initialize (u64 *memory_requirement, void *memory, void *config)
 Initializes the timeline system using the supplied configuration. NOTE: Call this twice, once to obtain memory requirement (memory = 0) and a second time including allocated memory. More...
 
b8 ktimeline_system_update (void *state, f32 engine_delta_time)
 Updates the job system. Should happen once an update cycle. More...
 
void ktimeline_system_shutdown (void *state)
 Shuts down the timeline system. More...
 
KAPI ktimeline ktimeline_system_create (f32 scale)
 
KAPI void ktimeline_system_destroy (ktimeline timeline)
 
KAPI f32 ktimeline_system_scale_get (ktimeline timeline)
 
KAPI void ktimeline_system_scale_set (ktimeline timeline, f32 scale)
 
KAPI f32 ktimeline_system_total_get (ktimeline timeline)
 
KAPI f32 ktimeline_system_delta_get (ktimeline timeline)
 
KAPI ktimeline ktimeline_system_get_engine (void)
 
KAPI ktimeline ktimeline_system_get_game (void)
 

Macro Definition Documentation

◆ KTIMELINE_INVALID

#define KTIMELINE_INVALID   INVALID_ID_U16

Typedef Documentation

◆ ktimeline

typedef u16 ktimeline

◆ timeline_system_config

Function Documentation

◆ ktimeline_system_create()

KAPI ktimeline ktimeline_system_create ( f32  scale)

◆ ktimeline_system_delta_get()

KAPI f32 ktimeline_system_delta_get ( ktimeline  timeline)

◆ ktimeline_system_destroy()

KAPI void ktimeline_system_destroy ( ktimeline  timeline)

◆ ktimeline_system_get_engine()

KAPI ktimeline ktimeline_system_get_engine ( void  )

◆ ktimeline_system_get_game()

KAPI ktimeline ktimeline_system_get_game ( void  )

◆ ktimeline_system_initialize()

b8 ktimeline_system_initialize ( u64 memory_requirement,
void *  memory,
void *  config 
)

Initializes the timeline system using the supplied configuration. NOTE: Call this twice, once to obtain memory requirement (memory = 0) and a second time including allocated memory.

Parameters
memory_requirementA pointer to hold the memory requirement of this system in bytes.
memoryA memory block to be used to hold the state of this system. Pass 0 on the first call to get memory requirement.
configThe configuration (timeline_system_config) to be used when initializing the system.
Returns
b8 True on success; otherwise false.

◆ ktimeline_system_scale_get()

KAPI f32 ktimeline_system_scale_get ( ktimeline  timeline)

◆ ktimeline_system_scale_set()

KAPI void ktimeline_system_scale_set ( ktimeline  timeline,
f32  scale 
)

◆ ktimeline_system_shutdown()

void ktimeline_system_shutdown ( void *  state)

Shuts down the timeline system.

Parameters
stateA pointer to the system state.

◆ ktimeline_system_total_get()

KAPI f32 ktimeline_system_total_get ( ktimeline  timeline)

◆ ktimeline_system_update()

b8 ktimeline_system_update ( void *  state,
f32  engine_delta_time 
)

Updates the job system. Should happen once an update cycle.