tween.h

#include <modkit/tween.h>25 functions · 5 structs · 1 unions · 1 enums · 10 typedefs · 2 macros

Explicit-clock typed tweens and composable timelines.

Functions

mk_tween_appendfunction

mk_result mk_tween_append(mk_tween_world_t *world, mk_tween_t tween, const mk_tween_track_desc *track)

Append after the timeline cursor and advance it by duration.

Parameter	Type	Description
world	mk_tween_world_t *	Value for world.
tween	mk_tween_t	Value for tween.
track	const mk_tween_track_desc *	Value for track.

Returns MK_SUCCESS or an error result.

mk_tween_append_delayfunction

mk_result mk_tween_append_delay(mk_tween_world_t *world, mk_tween_t tween, float duration)

Perform the tween append delay operation.

Parameter	Type	Description
world	mk_tween_world_t *	Value for world.
tween	mk_tween_t	Value for tween.
duration	float	Value for duration.

Returns MK_SUCCESS or an error result.

mk_tween_append_timelinefunction

mk_result mk_tween_append_timeline(mk_tween_world_t *world, mk_tween_t tween, mk_tween_t nested)

Perform the tween append timeline operation.

Parameter	Type	Description
world	mk_tween_world_t *	Value for world.
tween	mk_tween_t	Value for tween.
nested	mk_tween_t	Value for nested.

Returns MK_SUCCESS or an error result.

mk_tween_completefunction

bool mk_tween_complete(const mk_tween_world_t *world, mk_tween_t tween)

Perform the tween complete operation.

Parameter	Type	Description
world	const mk_tween_world_t *	Value for world.
tween	mk_tween_t	Value for tween.

Returns True when the operation succeeds.

mk_tween_createfunction

mk_tween_t mk_tween_create(mk_tween_world_t *world, const mk_tween_desc *desc)

Create tween.

Parameter	Type	Description
world	mk_tween_world_t *	Value for world.
desc	const mk_tween_desc *	Configuration descriptor.

Returns The resulting handle or value.

mk_tween_destroyfunction

void mk_tween_destroy(mk_tween_world_t *world, mk_tween_t tween)

Destroy the tween.

Parameter	Type	Description
world	mk_tween_world_t *	Value for world.
tween	mk_tween_t	Value for tween.

mk_tween_durationfunction

float mk_tween_duration(const mk_tween_world_t *world, mk_tween_t tween)

Perform the tween duration operation.

Parameter	Type	Description
world	const mk_tween_world_t *	Value for world.
tween	mk_tween_t	Value for tween.

Returns The resulting value.

mk_tween_insertfunction

mk_result mk_tween_insert(mk_tween_world_t *world, mk_tween_t tween, float at, const mk_tween_track_desc *track)

Insert at an absolute timeline time.

Parameter	Type	Description
world	mk_tween_world_t *	Value for world.
tween	mk_tween_t	Value for tween.
at	float	Value for at.
track	const mk_tween_track_desc *	Value for track.

Returns MK_SUCCESS or an error result.

mk_tween_insert_callbackfunction

mk_result mk_tween_insert_callback(mk_tween_world_t *world, mk_tween_t tween, float at, mk_tween_callback_fn callback, void *user_data)

Perform the tween insert callback operation.

Parameter	Type	Description
world	mk_tween_world_t *	Value for world.
tween	mk_tween_t	Value for tween.
at	float	Value for at.
callback	mk_tween_callback_fn	Completion callback.
user_data	void *	Caller-provided context.

Returns MK_SUCCESS or an error result.

mk_tween_insert_timelinefunction

mk_result mk_tween_insert_timeline(mk_tween_world_t *world, mk_tween_t tween, float at, mk_tween_t nested)

Perform the tween insert timeline operation.

Parameter	Type	Description
world	mk_tween_world_t *	Value for world.
tween	mk_tween_t	Value for tween.
at	float	Value for at.
nested	mk_tween_t	Value for nested.

Returns MK_SUCCESS or an error result.

mk_tween_joinfunction

mk_result mk_tween_join(mk_tween_world_t *world, mk_tween_t tween, const mk_tween_track_desc *track)

Start at the most recently appended item's start time (parallel join).

Parameter	Type	Description
world	mk_tween_world_t *	Value for world.
tween	mk_tween_t	Value for tween.
track	const mk_tween_track_desc *	Value for track.

Returns MK_SUCCESS or an error result.

mk_tween_pausefunction

void mk_tween_pause(mk_tween_world_t *world, mk_tween_t tween)

Pause the tween.

Parameter	Type	Description
world	mk_tween_world_t *	Value for world.
tween	mk_tween_t	Value for tween.

mk_tween_playfunction

void mk_tween_play(mk_tween_world_t *world, mk_tween_t tween)

Play tween.

Parameter	Type	Description
world	mk_tween_world_t *	Value for world.
tween	mk_tween_t	Value for tween.

mk_tween_restartfunction

void mk_tween_restart(mk_tween_world_t *world, mk_tween_t tween)

Perform the tween restart operation.

Parameter	Type	Description
world	mk_tween_world_t *	Value for world.
tween	mk_tween_t	Value for tween.

mk_tween_seekfunction

void mk_tween_seek(mk_tween_world_t *world, mk_tween_t tween, float time)

Seek tween.

Parameter	Type	Description
world	mk_tween_world_t *	Value for world.
tween	mk_tween_t	Value for tween.
time	float	Value for time.

mk_tween_set_cancel_callbackfunction

void mk_tween_set_cancel_callback(mk_tween_world_t *world, mk_tween_t tween, mk_tween_callback_fn callback, void *user_data)

Set cancel callback on the tween.

Parameter	Type	Description
world	mk_tween_world_t *	Value for world.
tween	mk_tween_t	Value for tween.
callback	mk_tween_callback_fn	Completion callback.
user_data	void *	Caller-provided context.

mk_tween_set_completion_callbackfunction

void mk_tween_set_completion_callback(mk_tween_world_t *world, mk_tween_t tween, mk_tween_callback_fn callback, void *user_data)

Set completion callback on the tween.

Parameter	Type	Description
world	mk_tween_world_t *	Value for world.
tween	mk_tween_t	Value for tween.
callback	mk_tween_callback_fn	Completion callback.
user_data	void *	Caller-provided context.

mk_tween_set_loopsfunction

void mk_tween_set_loops(mk_tween_world_t *world, mk_tween_t tween, uint32_t repeat_count, bool yoyo)

Set loops on the tween.

Parameter	Type	Description
world	mk_tween_world_t *	Value for world.
tween	mk_tween_t	Value for tween.
repeat_count	uint32_t	Number of repeat entries.
yoyo	bool	Value for yoyo.

mk_tween_set_speedfunction

void mk_tween_set_speed(mk_tween_world_t *world, mk_tween_t tween, float speed)

Set speed on the tween.

Parameter	Type	Description
world	mk_tween_world_t *	Value for world.
tween	mk_tween_t	Value for tween.
speed	float	Value for speed.

mk_tween_timefunction

float mk_tween_time(const mk_tween_world_t *world, mk_tween_t tween)

Perform the tween time operation.

Parameter	Type	Description
world	const mk_tween_world_t *	Value for world.
tween	mk_tween_t	Value for tween.

Returns The resulting value.

mk_tween_validfunction

bool mk_tween_valid(const mk_tween_world_t *world, mk_tween_t tween)

Perform the tween valid operation.

Parameter	Type	Description
world	const mk_tween_world_t *	Value for world.
tween	mk_tween_t	Value for tween.

Returns True when the operation succeeds.

mk_tween_world_countfunction

uint32_t mk_tween_world_count(const mk_tween_world_t *world)

Perform the tween world count operation.

Parameter	Type	Description
world	const mk_tween_world_t *	Value for world.

Returns The resulting value.

mk_tween_world_createfunction

mk_tween_world_t * mk_tween_world_create(const mk_tween_world_desc *desc)

Create tween world.

Parameter	Type	Description
desc	const mk_tween_world_desc *	Configuration descriptor.

Returns A borrowed pointer, or NULL when unavailable.

mk_tween_world_destroyfunction

void mk_tween_world_destroy(mk_tween_world_t *world)

Destroy the tween world.

Parameter	Type	Description
world	mk_tween_world_t *	Value for world.

mk_tween_world_stepfunction

void mk_tween_world_step(mk_tween_world_t *world, float dt)

Perform the tween world step operation.

Parameter	Type	Description
world	mk_tween_world_t *	Value for world.
dt	float	Value for dt.

Structs

mk_tweenstruct

Data for tween.

Field	Type	Description
id	uint32_t	The ID.

mk_tween_bindingstruct

Data for tween binding.

Field	Type	Description
type	mk_tween_value_type	The type.
setter	mk_tween_setter_fn	The setter.
user_data	void *	The user data.

mk_tween_descstruct

Data for tween desc.

Field	Type	Description
speed	float	The speed.
paused	bool	The paused.
auto_destroy	bool	The auto destroy.

mk_tween_track_descstruct

Data for tween track desc.

Field	Type	Description
binding	mk_tween_binding	The binding.
from	mk_tween_value	The from.
to	mk_tween_value	The to.
duration	float	The duration.
ease	mk_ease_type	The ease.
curve	mk_curve_t	When valid, overrides ease and is retained by the timeline.
relative	bool	The relative.

mk_tween_world_descstruct

Data for tween world desc.

Field	Type	Description
capacity	uint32_t	Maximum live timelines; 0 selects 256.

Unions

mk_tween_valueunion

Data for tween value.

Field	Type	Description
f	float	The f.
vec2	mk_vec2	The vec2.
vec3	mk_vec3	The vec3.
vec4	mk_vec4	The vec4.
color	mk_vec4	The color.
quat	mk_quat	The quat.

Enums

mk_tween_value_typeenum

Values for tween value type.

Value	Description
MK_TWEEN_FLOAT	Selects float.
MK_TWEEN_VEC2	Selects vec2.
MK_TWEEN_VEC3	Selects vec3.
MK_TWEEN_VEC4	Selects vec4.
MK_TWEEN_COLOR	Selects color.
MK_TWEEN_QUAT	Selects quat.

Typedefs

mk_tween_bindingtypedef

typedef struct mk_tween_binding mk_tween_binding

Data for tween binding.

mk_tween_callback_fntypedef

typedef void(*) mk_tween_callback_fn(mk_tween_t tween, void *user_data)

Callback used for tween callback.

mk_tween_desctypedef

typedef struct mk_tween_desc mk_tween_desc

Data for tween desc.

mk_tween_setter_fntypedef

typedef void(*) mk_tween_setter_fn(void *user_data, mk_tween_value_type type, const mk_tween_value *value)

Callback used for tween setter.

mk_tween_ttypedef

typedef struct mk_tween mk_tween_t

Data for tween.

mk_tween_track_desctypedef

typedef struct mk_tween_track_desc mk_tween_track_desc

Data for tween track desc.

mk_tween_valuetypedef

typedef union mk_tween_value mk_tween_value

Data for tween value.

mk_tween_value_typetypedef

typedef enum mk_tween_value_type mk_tween_value_type

Values for tween value type.

mk_tween_world_desctypedef

typedef struct mk_tween_world_desc mk_tween_world_desc

Data for tween world desc.

mk_tween_world_ttypedef

typedef struct mk_tween_world mk_tween_world_t

Type used for tween world.

Macros

MK_TWEEN_INVALIDdefine

MK_TWEEN_INVALID

Invalid sentinel for tween.

MK_TWEEN_REPEAT_FOREVERdefine

MK_TWEEN_REPEAT_FOREVER

Constant for tween repeat forever.