Epok Engine

EPOK RUNTIME

epok::circle_overlap_2d

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 `circle overlap 2d` as part of the world2d module.

Belongs to
epok
Header
world2d.hpp
Overloads
1

Declaration

Declaration
inline bool circle_overlap_2d(const Fixed* a, Fixed radius_a, const Fixed* b, Fixed radius_b, bool inclusive = false)

Performs `circle overlap 2d` as part of the world2d module.

ParameterTypeMeaning
aconst Fixed *Not documented; consult the linked header.
radius_aFixedNot documented; consult the linked header.
bconst Fixed *Not documented; consult the linked header.
radius_bFixedNot 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 Fixed * a
// Fixed radius_a
// const Fixed * b
// Fixed radius_b
// bool inclusive

auto result = epok::circle_overlap_2d(a, radius_a, b, radius_b, inclusive);

Trade-offs and warnings

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

Declared in runtime/world2d.hpp:363

Related members