Epok Engine

EPOK RUNTIME

epok::aabb2d_overlap

Function · 1 overload

Function

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

Belongs to
epok
Header
world2d.hpp
Overloads
1

Declaration

Declaration
inline bool aabb2d_overlap(const Aabb2D& a, const Aabb2D& b)

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

ParameterTypeMeaning
aconst Aabb2D &Value supplied for a. Keep referenced or pointed-to data valid for the complete call.
bconst Aabb2D &Value supplied for b. Keep referenced or pointed-to data valid for the complete call.

Returns: bool. Check the value before continuing when it represents success, availability or a resource handle.

Example

C++ example
#include "world2d.hpp"

// Assume these named values have been initialized with valid data:
// const Aabb2D & a
// const Aabb2D & b

auto result = epok::aabb2d_overlap(a, b);

Why use it

The boolean result makes success, availability or state explicit without exceptions.

Trade-offs and warnings

Check the return value; `false` is part of normal control flow for many PSX resource operations. Pointer/reference arguments are borrowed unless the source contract says otherwise; keep them valid for the complete operation and never assume null is accepted.

Declared in runtime/world2d.hpp:314

Related members