Epok Engine

EPOK RUNTIME

epok::Tween::start

Method · 1 overload

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Method

Starts start as part of the utility module.

Belongs to
epok::Tween
Header
utility.hpp
Overloads
1

Declaration

Declaration
bool start(Fixed a,Fixed b,Fixed seconds,Ease mode=Ease::Linear)

Starts start as part of the utility module.

ParameterTypeMeaning
aFixedNot documented; consult the linked header.
bFixedNot documented; consult the linked header.
secondsFixedNot documented; consult the linked header.
modeEaseNot documented; consult the linked header.

Returns: bool. Consult the linked header for its meaning.

Example sketch

C++ example
#include "utility.hpp"

// Assume these named values have been initialized with valid data:
// Fixed a
// Fixed b
// Fixed seconds
// Ease mode

epok::Tween& object = /* obtain a valid instance */;

auto result = object.start(a, b, seconds, mode);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in runtime/utility.hpp:56

Related members