timeline_system.h File Reference

#include "identifiers/khandle.h"
#include "defines.h"

Go to the source code of this file.

Data Structures
struct	timeline_system_config

Typedefs
typedef struct timeline_system_config	timeline_system_config

Functions
b8	timeline_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	timeline_system_update (void *state, f32 engine_delta_time)
	Updates the job system. Should happen once an update cycle. More...
void	timeline_system_shutdown (void *state)
	Shuts down the timeline system. More...
KAPI khandle	timeline_system_create (f32 scale)
KAPI void	timeline_system_destroy (khandle timeline)
KAPI f32	timeline_system_scale_get (khandle timeline)
KAPI void	timeline_system_scale_set (khandle timeline, f32 scale)
KAPI f32	timeline_system_total_get (khandle timeline)
KAPI f32	timeline_system_delta_get (khandle timeline)
KAPI khandle	timeline_system_get_engine (void)
KAPI khandle	timeline_system_get_game (void)

Typedef Documentation

timeline_system_config

typedef struct timeline_system_config timeline_system_config

Function Documentation

timeline_system_create()

KAPI khandle timeline_system_create

(

f32

scale

)

timeline_system_delta_get()

KAPI f32 timeline_system_delta_get

(

khandle

timeline

)

timeline_system_destroy()

KAPI void timeline_system_destroy

(

khandle

timeline

)

timeline_system_get_engine()

KAPI khandle timeline_system_get_engine

(

void

)

timeline_system_get_game()

KAPI khandle timeline_system_get_game

(

void

)

timeline_system_initialize()

b8 timeline_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_requirement	A pointer to hold the memory requirement of this system in bytes.
memory	A memory block to be used to hold the state of this system. Pass 0 on the first call to get memory requirement.
config	The configuration (timeline_system_config) to be used when initializing the system.

Returns

b8 True on success; otherwise false.

timeline_system_scale_get()

KAPI f32 timeline_system_scale_get

(

khandle

timeline

)

timeline_system_scale_set()

KAPI void timeline_system_scale_set	(	khandle	timeline,
		f32	scale
	)

timeline_system_shutdown()

void timeline_system_shutdown

(

void *

state

)

Shuts down the timeline system.

Parameters

state

A pointer to the system state.

timeline_system_total_get()

KAPI f32 timeline_system_total_get

(

khandle

timeline

)

timeline_system_update()

b8 timeline_system_update	(	void *	state,
		f32	engine_delta_time
	)

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