EPOK RUNTIME

epok::overlap

Function · 1 overload

Function

Performs `overlap` as part of the epok module.

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

Declaration

size_t overlap(const Aabb& box,DataHandle* output,size_t capacity,uint32_t mask=0xffffffffu,const ActorData* ignore=nullptr,bool triggers=true)

Performs `overlap` as part of the epok module.

Parameter	Type	Meaning
`box`	`const Aabb &`	Value supplied for box. Keep referenced or pointed-to data valid for the complete call.
`output`	`DataHandle *`	Value supplied for output. Keep referenced or pointed-to data valid for the complete call.
`capacity`	`size_t`	Value supplied for capacity. Keep referenced or pointed-to data valid for the complete call.
`mask`	`uint32_t`	Value supplied for mask. Keep referenced or pointed-to data valid for the complete call.
`ignore`	`const ActorData *`	Value supplied for ignore. Keep referenced or pointed-to data valid for the complete call.
`triggers`	`bool`	Value supplied for triggers. Keep referenced or pointed-to data valid for the complete call.

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

Example

C++ example

#include "epok.hpp"

// Assume these named values have been initialized with valid data:
// const Aabb & box
// DataHandle * output
// size_t capacity
// uint32_t mask
// const ActorData * ignore
// bool triggers

auto result = epok::overlap(box, output, capacity, mask, ignore, triggers);

Why use it

It provides direct, allocation-conscious access to the epok module. No exception-based error path is implied by the signature.

Trade-offs and warnings

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/epok.hpp:206

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