Epok Engine

EPOK RUNTIME

epok::CollisionWorld2D::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

Returns the total number of matches; only the first `output_capacity` are written.

Belongs to
epok::CollisionWorld2D
Header
world2d.hpp
Overloads
1

Declaration

const
Declaration
size_t overlap(const Aabb2D& box, uint16_t* output, size_t output_capacity, uint32_t mask = 0xffffffffu, int ignore = -1, bool triggers = true) const

Returns the total number of matches; only the first `output_capacity` are written.

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

// Assume these named values have been initialized with valid data:
// const Aabb2D & box
// uint16_t * output
// size_t output_capacity
// uint32_t mask
// int ignore
// bool triggers

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

auto result = object.overlap(box, output, 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/world2d.hpp:540

Related members