Epok Engine

EPOK RUNTIME

epok::RumbleService::begin_frame

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

Begins frame as part of bounded controller motor pulses and cancellation.

Belongs to
epok::RumbleService
Header
rumble.hpp
Overloads
1

Declaration

Declaration
void begin_frame(uint32_t now,bool suspended=false)

Begins frame as part of bounded controller motor pulses and cancellation.

ParameterTypeMeaning
nowuint32_tNot documented; consult the linked header.
suspendedboolNot documented; consult the linked header.

Returns: Nothing (void).

Example sketch

C++ example
#include "rumble.hpp"

// Assume these named values have been initialized with valid data:
// uint32_t now
// bool suspended

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

object.begin_frame(now, suspended);

Trade-offs and warnings

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

Declared in runtime/rumble.hpp:48

Related members