EPOK RUNTIME

epok::collider2d_overlap

Function · 1 overload

Function

Shape-aware pair test in world space.

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

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.

Parameter	Type	Meaning
`a`	`const Collider2D &`	Value supplied for a. Keep referenced or pointed-to data valid for the complete call.
`world_a`	`const Fixed *`	Value supplied for world_a. Keep referenced or pointed-to data valid for the complete call.
`b`	`const Collider2D &`	Value supplied for b. Keep referenced or pointed-to data valid for the complete call.
`world_b`	`const Fixed *`	Value supplied for world_b. Keep referenced or pointed-to data valid for the complete call.
`inclusive`	`bool`	Value supplied for inclusive. 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 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);

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:375

Related members

aabb_may_touchPerforms `aabb may touch` as part of bounded AABB collision queries and movement.Function template aabb_overlapPerforms `aabb overlap` as part of bounded AABB collision queries and movement.Function template aabb2d_containsPerforms `aabb2d contains` as part of the world2d module.Function aabb2d_overlapPerforms `aabb2d overlap` as part of the world2d module.Function aabb2d_touchPerforms `aabb2d touch` as part of the world2d module.Function aabb2d_translatedPerforms `aabb2d translated` as part of the world2d module.Function activate_texture_bankPerforms `activate texture bank` as part of the epok module.Function active_cameraPerforms `active camera` as part of the epok module.Function actor_for_slotPerforms `actor for slot` as part of the actor tables module.Function allocate_actor_dataPerforms `allocate actor data` as part of the epok module.Function attach_componentSpatial attachment between components of the same domain.Function audio_initializePerforms `audio initialize` as part of SPU sound playback and voice ownership.Function