EPOK RUNTIME
Streaming
streaming.hpp · bounded CD or PC geometry-page streaming
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.
Module
bounded CD or PC geometry-page streaming.
Include this module
C++ include
#include "streaming.hpp"Types
StreamingStatsStruct declared by the streaming module for bounded CD or PC geometry-page streaming.StructStreamingVerificationVerify completed sectors while later sectors are still reading.StructStreamingVerifyStatsKeep media verification visible separately from the render pass: CD completion callbacks may run in GPU::flip, outside GameScene::frame.StructStreamingWarmupStatsStruct declared by the streaming module for bounded CD or PC geometry-page streaming.StructStreamMeshLeaseClass declared by the streaming module for bounded CD or PC geometry-page streaming.ClassStreamMeshViewScope-bound pin covers CPU geometry consumption.StructStreamObjectBindingStruct declared by the streaming module for bounded CD or PC geometry-page streaming.StructStreamPageCursorConsecutive chunks can borrow one renderer-scoped page pin.ClassFunctions and methods
~StreamMeshLeaseReleases the resources owned by `epok::StreamMeshLease`.destructor~StreamPageCursorReleases the resources owned by `epok::StreamPageCursor`.destructorborrowPerforms `borrow` as part of bounded CD or PC geometry-page streaming.MethodgeometryCompatibility accessor for users needing a full rebound descriptor.Methodoperator=Performs `operator =` as part of bounded CD or PC geometry-page streaming.Methodoperator=Performs `operator =` as part of bounded CD or PC geometry-page streaming.MethodquadsPerforms `quads` as part of bounded CD or PC geometry-page streaming.MethodreleasePerforms `release` as part of bounded CD or PC geometry-page streaming.Methodrelease_borrowPerforms `release borrow` as part of bounded CD or PC geometry-page streaming.MethodresolveRenderer-only sequential view: consume all payload data before the next resolve/advance/release.Methodstreaming_acquirePerforms `streaming acquire` as part of bounded CD or PC geometry-page streaming.Functionstreaming_acquire_slotPerforms `streaming acquire slot` as part of bounded CD or PC geometry-page streaming.Functionstreaming_acquire_slot_slowPerforms `streaming acquire slot slow` as part of bounded CD or PC geometry-page streaming.Functionstreaming_begin_working_setCamera-driven demand streaming: pin every resident member of this frame's bounded working set, then start at most one missing page.Function templatestreaming_bind_chainPerforms `streaming bind chain` as part of bounded CD or PC geometry-page streaming.Functionstreaming_bind_objectPerforms `streaming bind object` as part of bounded CD or PC geometry-page streaming.Functionstreaming_descriptor_validExported descriptors are immutable.Functionstreaming_end_working_setPerforms `streaming end working set` as part of bounded CD or PC geometry-page streaming.Function templatestreaming_finish_readPerforms `streaming finish read` as part of bounded CD or PC geometry-page streaming.Functionstreaming_hash_slicePerforms `streaming hash slice` as part of bounded CD or PC geometry-page streaming.Functionstreaming_lookupPerforms `streaming lookup` as part of bounded CD or PC geometry-page streaming.Functionstreaming_prefetchOpportunistic only: XA playback and a pending XA request retain priority.Functionstreaming_prefetch_neededPerforms `streaming prefetch needed` as part of bounded CD or PC geometry-page streaming.Functionstreaming_preparePerforms `streaming prepare` as part of bounded CD or PC geometry-page streaming.Functionstreaming_releasePerforms `streaming release` as part of bounded CD or PC geometry-page streaming.Functionstreaming_request_pageGameplay requests are deliberately queued: the script call never performs a CD seek or waits for callbacks.Functionstreaming_required_page_readyForeground demand may borrow ONE additional sector slice in this frame.Functionstreaming_resolve_archive_meshPerforms `streaming resolve archive mesh` as part of bounded CD or PC geometry-page streaming.Functionstreaming_resolve_stableOnly whole-archive pools permit unpinned payload views.Functionstreaming_retryA failed CD/host operation may be retried only after every callback has relinquished its buffers.Functionstreaming_scene_changedPerforms `streaming scene changed` as part of bounded CD or PC geometry-page streaming.Functionstreaming_service_gameplay_requestsPerforms `streaming service gameplay requests` as part of bounded CD or PC geometry-page streaming.Functionstreaming_start_readPerforms `streaming start read` as part of bounded CD or PC geometry-page streaming.Functionstreaming_tickRelease the controller only after every parser/read/XA callback has drained.Functionstreaming_verify_clockPerforms `streaming verify clock` as part of bounded CD or PC geometry-page streaming.Functionstreaming_verify_slicePerforms `streaming verify slice` as part of bounded CD or PC geometry-page streaming.Functionstreaming_warmupThe caller selects a startup working set from resident metadata.Functionstreaming_warmup_sceneA bounded small-scene startup policy.Function templatestreaming_working_page_readyPerforms `streaming working page ready` as part of bounded CD or PC geometry-page streaming.Function templateStreamMeshLeaseConstructs `epok::StreamMeshLease` for bounded CD or PC geometry-page streaming.constructorStreamPageCursorConstructs `epok::StreamPageCursor` for bounded CD or PC geometry-page streaming.constructorvalidPerforms `valid` as part of bounded CD or PC geometry-page streaming.MethodverticesPerforms `vertices` as part of bounded CD or PC geometry-page streaming.MethodFields, variables and values
activeExposes `active` on `epok::StreamingVerification` for bounded CD or PC geometry-page streaming.Fieldall_streamedExposes `all_streamed` on `epok::StreamObjectBinding` for bounded CD or PC geometry-page streaming.FieldattemptsExposes `attempts` on `epok::StreamingWarmupStats` for bounded CD or PC geometry-page streaming.FieldbatchesExposes `batches` on `epok::StreamingVerifyStats` for bounded CD or PC geometry-page streaming.FieldbytesExposes `bytes` on `epok::StreamingStats` for bounded CD or PC geometry-page streaming.FieldbytesExposes `bytes` on `epok::StreamingVerifyStats` for bounded CD or PC geometry-page streaming.FielderrorsExposes `errors` on `epok::StreamingStats` for bounded CD or PC geometry-page streaming.FieldfailuresExposes `failures` on `epok::StreamingWarmupStats` for bounded CD or PC geometry-page streaming.Fieldgameplay_rejectedExposes `gameplay_rejected` on `epok::StreamingStats` for bounded CD or PC geometry-page streaming.Fieldgameplay_requestsExposes `gameplay_requests` on `epok::StreamingStats` for bounded CD or PC geometry-page streaming.FieldhashExposes `hash` on `epok::StreamingVerification` for bounded CD or PC geometry-page streaming.Fieldlast_scanlinesExposes `last_scanlines` on `epok::StreamingVerifyStats` for bounded CD or PC geometry-page streaming.Fieldmax_scanlinesExposes `max_scanlines` on `epok::StreamingVerifyStats` for bounded CD or PC geometry-page streaming.Fieldmesh_Exposes `mesh_` on the `epok` namespace for bounded CD or PC geometry-page streaming.FieldoffsetExposes `offset` on `epok::StreamingVerification` for bounded CD or PC geometry-page streaming.FieldpageExposes `page` on `epok::StreamingVerification` for bounded CD or PC geometry-page streaming.FieldpagesExposes `pages` on `epok::StreamingWarmupStats` for bounded CD or PC geometry-page streaming.FieldquadsExposes `quads` on `epok::StreamMeshView` for bounded CD or PC geometry-page streaming.Fieldread_completeExposes `read_complete` on `epok::StreamingVerification` for bounded CD or PC geometry-page streaming.Fieldread_okExposes `read_ok` on `epok::StreamingVerification` for bounded CD or PC geometry-page streaming.FieldreadsExposes `reads` on `epok::StreamingStats` for bounded CD or PC geometry-page streaming.FieldreadsExposes `reads` on `epok::StreamingWarmupStats` for bounded CD or PC geometry-page streaming.FieldrejectedExposes `rejected` on `epok::StreamingWarmupStats` for bounded CD or PC geometry-page streaming.FieldrootExposes `root` on `epok::StreamObjectBinding` for bounded CD or PC geometry-page streaming.FieldscanlinesExposes `scanlines` on `epok::StreamingVerifyStats` for bounded CD or PC geometry-page streaming.FieldslotExposes `slot` on `epok::StreamingVerification` for bounded CD or PC geometry-page streaming.Fieldstall_usExposes `stall_us` on `epok::StreamingStats` for bounded CD or PC geometry-page streaming.Fieldstall_usExposes `stall_us` on `epok::StreamingWarmupStats` for bounded CD or PC geometry-page streaming.FieldstallsExposes `stalls` on `epok::StreamingStats` for bounded CD or PC geometry-page streaming.Fieldstream_archive_fitsGenerated scene.hh provides stream_page_count, stream_pool_pages and stream_archive_path.Variablestream_entryExposes `stream_entry` on the `epok` namespace for bounded CD or PC geometry-page streaming.Variablestream_failedExposes `stream_failed` on the `epok` namespace for bounded CD or PC geometry-page streaming.Variablestream_gameplay_request_countExposes `stream_gameplay_request_count` on the `epok` namespace for bounded CD or PC geometry-page streaming.Variablestream_gameplay_requestsExposes `stream_gameplay_requests` on the `epok` namespace for bounded CD or PC geometry-page streaming.Variablestream_lookup_pendingExposes `stream_lookup_pending` on the `epok` namespace for bounded CD or PC geometry-page streaming.Variablestream_lookup_startedExposes `stream_lookup_started` on the `epok` namespace for bounded CD or PC geometry-page streaming.Variablestream_page_dataFixed-slot pools never evict.Variablestream_poolExposes `stream_pool` on the `epok` namespace for bounded CD or PC geometry-page streaming.Variablestream_read_pendingExposes `stream_read_pending` on the `epok` namespace for bounded CD or PC geometry-page streaming.Variablestream_readyExposes `stream_ready` on the `epok` namespace for bounded CD or PC geometry-page streaming.Variablestream_timeout_usExposes `stream_timeout_us` on the `epok` namespace for bounded CD or PC geometry-page streaming.Variablestream_verificationExposes `stream_verification` on the `epok` namespace for bounded CD or PC geometry-page streaming.Variablestream_verify_overlap_bytesSeparate symbol keeps the existing five-word diagnostics ABI intact.Variablestream_verify_slice_bytesOne CD sector per normal frame.Variablestream_warm_sceneExposes `stream_warm_scene` on the `epok` namespace for bounded CD or PC geometry-page streaming.Variablestreaming_statsExposes `streaming_stats` on the `epok` namespace for bounded CD or PC geometry-page streaming.Variablestreaming_verify_statsExposes `streaming_verify_stats` on the `epok` namespace for bounded CD or PC geometry-page streaming.Variablestreaming_warmup_statsExposes `streaming_warmup_stats` on the `epok` namespace for bounded CD or PC geometry-page streaming.VariabletimeoutsExposes `timeouts` on `epok::StreamingStats` for bounded CD or PC geometry-page streaming.Fielduses_streamExposes `uses_stream` on `epok::StreamObjectBinding` for bounded CD or PC geometry-page streaming.FieldvalidExposes `valid` on `epok::StreamMeshView` for bounded CD or PC geometry-page streaming.FieldverticesExposes `vertices` on `epok::StreamMeshView` for bounded CD or PC geometry-page streaming.Fieldxa_interruptionsExposes `xa_interruptions` on `epok::StreamingStats` for bounded CD or PC geometry-page streaming.Field