Why use it
The asynchronous shape lets the frame loop continue while hardware or queued work completes.
EPOK RUNTIME
epok::UtilityLibrary::tween_schedule
Method · 1 overload
Method
The full plan: `delay_seconds` holds the first leg back, `loop` and `legs` decide the replay, and `legs` 0 loops without end.
Declaration
staticDeclaration
static GameplayTweenState tween_schedule(Fixed from,Fixed to,Fixed seconds,Ease easing,Fixed delay_seconds,TweenLoop loop,uint32_t legs)The full plan: `delay_seconds` holds the first leg back, `loop` and `legs` decide the replay, and `legs` 0 loops without end.
| Parameter | Type | Meaning |
|---|---|---|
from | Fixed | Value supplied for from. Keep referenced or pointed-to data valid for the complete call. |
to | Fixed | Value supplied for to. Keep referenced or pointed-to data valid for the complete call. |
seconds | Fixed | Value supplied for seconds. Keep referenced or pointed-to data valid for the complete call. |
easing | Ease | Value supplied for easing. Keep referenced or pointed-to data valid for the complete call. |
delay_seconds | Fixed | Value supplied for delay_seconds. Keep referenced or pointed-to data valid for the complete call. |
loop | TweenLoop | Value supplied for loop. Keep referenced or pointed-to data valid for the complete call. |
legs | uint32_t | Value supplied for legs. Keep referenced or pointed-to data valid for the complete call. |
Returns: GameplayTweenState. Check the value before continuing when it represents success, availability or a resource handle.
Example
C++ example
#include "utility.hpp"
// Assume these named values have been initialized with valid data:
// Fixed from
// Fixed to
// Fixed seconds
// Ease easing
// Fixed delay_seconds
// TweenLoop loop
// uint32_t legs
auto result = epok::UtilityLibrary::tween_schedule(from, to, seconds, easing, delay_seconds, loop, legs);Trade-offs and warnings
Captured data and buffers must remain valid until the callback or task has completed.
Declared in runtime/utility.hpp:181
Related members
easeThe easing catalogue on its own, for curves applied to something that is not a tween.Methodevent_queue_clearPerforms `event queue clear` as part of the utility module.Methodevent_queue_emitPerforms `event queue emit` as part of the utility module.Methodevent_queue_pollPerforms `event queue poll` as part of the utility module.Methodtween_advancePerforms `tween advance` as part of the utility module.Methodtween_cancelPerforms `tween cancel` as part of the utility module.Methodtween_startPerforms `tween start` as part of the utility module.Methodtween_valuePerforms `tween value` as part of the utility module.Method