Epok Engine

EPOK RUNTIME

epok::overlap

Function · 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.

Function

Performs `overlap` as part of the epok module.

Belongs to
epok
Header
epok.hpp
Overloads
1

Declaration

Declaration
size_t overlap(const Aabb& box,DataHandle* output,size_t capacity,uint32_t mask=0xffffffffu,const ActorData* ignore=nullptr,bool triggers=true)

Performs `overlap` as part of the epok module.

ParameterTypeMeaning
boxconst Aabb &Not documented; consult the linked header.
outputDataHandle *Not documented; consult the linked header.
capacitysize_tNot documented; consult the linked header.
maskuint32_tNot documented; consult the linked header.
ignoreconst ActorData *Not documented; consult the linked header.
triggersboolNot documented; consult the linked header.

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

Example sketch

C++ example
#include "epok.hpp"

// Assume these named values have been initialized with valid data:
// const Aabb & box
// DataHandle * output
// size_t capacity
// uint32_t mask
// const ActorData * ignore
// bool triggers

auto result = epok::overlap(box, output, capacity, mask, ignore, triggers);

Trade-offs and warnings

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

Declared in runtime/epok.hpp:363

Related members