Epok Engine

EPOK RUNTIME

epok::world2d::nav_detail::closest_on_segment

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 `closest on segment` as part of the world2d navigation module.

Belongs to
epok::world2d::nav_detail
Header
world2d_navigation.hpp
Overloads
1

Declaration

Declaration
inline void closest_on_segment(const Fixed* p, const Fixed* a, const Fixed* b, Fixed* out)

Performs `closest on segment` as part of the world2d navigation module.

ParameterTypeMeaning
pconst Fixed *Not documented; consult the linked header.
aconst Fixed *Not documented; consult the linked header.
bconst Fixed *Not documented; consult the linked header.
outFixed *Not documented; consult the linked header.

Returns: Nothing (void).

Example sketch

C++ example
#include "world2d_navigation.hpp"

// Assume these named values have been initialized with valid data:
// const Fixed * p
// const Fixed * a
// const Fixed * b
// Fixed * out

epok::world2d::nav_detail::closest_on_segment(p, a, b, out);

Trade-offs and warnings

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

Declared in runtime/world2d_navigation.hpp:251

Related members