Epok Engine

EPOK RUNTIME

epok::world2d::Service::overlap

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

Performs `overlap` as part of the world2d service module.

Belongs to
epok::world2d::Service
Header
world2d_service.hpp
Overloads
1

Declaration

Declaration
size_t overlap(const Aabb2D& box, ObjectId* actors, size_t capacity, uint32_t mask, bool triggers)

Performs `overlap` as part of the world2d service module.

ParameterTypeMeaning
boxconst Aabb2D &Not documented; consult the linked header.
actorsObjectId *Not documented; consult the linked header.
capacitysize_tNot documented; consult the linked header.
maskuint32_tNot 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 "world2d_service.hpp"

// Assume these named values have been initialized with valid data:
// const Aabb2D & box
// ObjectId * actors
// size_t capacity
// uint32_t mask
// bool triggers

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

auto result = object.overlap(box, actors, capacity, mask, triggers);

Trade-offs and warnings

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

Declared in runtime/world2d_service.hpp:553

Related members