Why use it
The method is `const`, so it does not mutate the object through this API surface. The asynchronous shape lets the frame loop continue while hardware or queued work completes.
EPOK RUNTIME
epok::EventQueue::snapshot
Method · 1 overload
Method
Performs `snapshot` as part of the utility module.
Declaration
constDeclaration
size_t snapshot(QueueEvent* output,size_t capacity)constPerforms `snapshot` as part of the utility module.
| Parameter | Type | Meaning |
|---|---|---|
output | QueueEvent * | Value supplied for output. Keep referenced or pointed-to data valid for the complete call. |
capacity | size_t | Value supplied for capacity. Keep referenced or pointed-to data valid for the complete call. |
Returns: size_t. 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:
// QueueEvent * output
// size_t capacity
epok::EventQueue& object = /* obtain a valid instance */;
auto result = object.snapshot(output, capacity);Trade-offs and warnings
Captured data and buffers must remain valid until the callback or task has completed. Pointer/reference arguments are borrowed unless the source contract says otherwise; keep them valid for the complete operation and never assume null is accepted.
Declared in runtime/utility.hpp:109