Epok Engine

EPOK RUNTIME

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

Shape-aware pair test in world space.

Belongs to
epok
Header
world2d.hpp
Overloads
1

Declaration

Declaration
inline bool collider2d_overlap(const Collider2D& a, const Fixed* world_a, const Collider2D& b, const Fixed* world_b, bool inclusive = false)

Shape-aware pair test in world space.

ParameterTypeMeaning
aconst Collider2D &Not documented; consult the linked header.
world_aconst Fixed *Not documented; consult the linked header.
bconst Collider2D &Not documented; consult the linked header.
world_bconst Fixed *Not documented; consult the linked header.
inclusiveboolNot documented; consult the linked header.

Returns: bool. 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 Collider2D & a
// const Fixed * world_a
// const Collider2D & b
// const Fixed * world_b
// bool inclusive

auto result = epok::collider2d_overlap(a, world_a, b, world_b, inclusive);

Trade-offs and warnings

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

Declared in runtime/world2d.hpp:381

Related members