EPOK RUNTIME

epok::streaming_warmup

Function · 1 overload

Function

The caller selects a startup working set from resident metadata.

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

Declaration

inline bool streaming_warmup(const uint32_t *pages, size_t count, psyqo::GPU &gpu)

The caller selects a startup working set from resident metadata.

Parameter	Type	Meaning
`pages`	`const uint32_t *`	Value supplied for pages. Keep referenced or pointed-to data valid for the complete call.
`count`	`size_t`	Value supplied for count. Keep referenced or pointed-to data valid for the complete call.
`gpu`	`psyqo::GPU &`	Value supplied for gpu. 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 "streaming.hpp"

// Assume these named values have been initialized with valid data:
// const uint32_t * pages
// size_t count
// psyqo::GPU & gpu

auto result = epok::streaming_warmup(pages, count, gpu);

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/streaming.hpp:219

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