Skip to content

EPOK RUNTIME

Streaming

streaming.hpp · bounded CD or PC geometry-page streaming

Module

bounded CD or PC geometry-page streaming.

Header: streaming.hpp
Include: #include "streaming.hpp"
Stability: Epok runtime API

Include this module

C++ include

#include "streaming.hpp"

Types

StreamingStatsStruct declared by the streaming module for bounded CD or PC geometry-page streaming.Struct StreamingWarmupStatsStruct declared by the streaming module for bounded CD or PC geometry-page streaming.Struct StreamMeshLeaseClass declared by the streaming module for bounded CD or PC geometry-page streaming.Class StreamMeshViewScope-bound pin covers CPU geometry consumption.Struct StreamObjectBindingStruct declared by the streaming module for bounded CD or PC geometry-page streaming.Struct StreamPageCursorConsecutive chunks can borrow one renderer-scoped page pin.Class

Functions and methods

~StreamMeshLeaseReleases the resources owned by `epok::StreamMeshLease`.destructor ~StreamPageCursorReleases the resources owned by `epok::StreamPageCursor`.destructor borrowPerforms `borrow` as part of bounded CD or PC geometry-page streaming.Method geometryCompatibility accessor for users needing a full rebound descriptor.Method operator=Performs `operator =` as part of bounded CD or PC geometry-page streaming.Method operator=Performs `operator =` as part of bounded CD or PC geometry-page streaming.Method quadsPerforms `quads` as part of bounded CD or PC geometry-page streaming.Method releasePerforms `release` as part of bounded CD or PC geometry-page streaming.Method release_borrowPerforms `release borrow` as part of bounded CD or PC geometry-page streaming.Method resolveRenderer-only sequential view: consume all payload data before the next resolve/advance/release.Method streaming_acquirePerforms `streaming acquire` as part of bounded CD or PC geometry-page streaming.Function streaming_acquire_slotPerforms `streaming acquire slot` as part of bounded CD or PC geometry-page streaming.Function streaming_acquire_slot_slowPerforms `streaming acquire slot slow` as part of bounded CD or PC geometry-page streaming.Function streaming_bind_chainPerforms `streaming bind chain` as part of bounded CD or PC geometry-page streaming.Function streaming_bind_objectPerforms `streaming bind object` as part of bounded CD or PC geometry-page streaming.Function streaming_descriptor_validExported descriptors are immutable.Function streaming_lookupPerforms `streaming lookup` as part of bounded CD or PC geometry-page streaming.Function streaming_prefetchOpportunistic only: XA playback and a pending XA request retain priority.Function streaming_prefetch_neededPerforms `streaming prefetch needed` as part of bounded CD or PC geometry-page streaming.Function streaming_preparePerforms `streaming prepare` as part of bounded CD or PC geometry-page streaming.Function streaming_releasePerforms `streaming release` as part of bounded CD or PC geometry-page streaming.Function streaming_resolve_archive_meshPerforms `streaming resolve archive mesh` as part of bounded CD or PC geometry-page streaming.Function streaming_resolve_stableOnly whole-archive pools permit unpinned payload views.Function streaming_scene_changedPerforms `streaming scene changed` as part of bounded CD or PC geometry-page streaming.Function streaming_start_readPerforms `streaming start read` as part of bounded CD or PC geometry-page streaming.Function streaming_tickRelease the controller only after every parser/read/XA callback has drained.Function streaming_warmupThe caller selects a startup working set from resident metadata.Function streaming_warmup_sceneA bounded small-scene startup policy.Function template StreamMeshLeaseConstructs `epok::StreamMeshLease` for bounded CD or PC geometry-page streaming.constructor StreamPageCursorConstructs `epok::StreamPageCursor` for bounded CD or PC geometry-page streaming.constructor validPerforms `valid` as part of bounded CD or PC geometry-page streaming.Method verticesPerforms `vertices` as part of bounded CD or PC geometry-page streaming.Method

Fields, variables and values

all_streamedExposes `all_streamed` on `epok::StreamObjectBinding` for bounded CD or PC geometry-page streaming.Field attemptsExposes `attempts` on `epok::StreamingWarmupStats` for bounded CD or PC geometry-page streaming.Field bytesExposes `bytes` on `epok::StreamingStats` for bounded CD or PC geometry-page streaming.Field errorsExposes `errors` on `epok::StreamingStats` for bounded CD or PC geometry-page streaming.Field failuresExposes `failures` on `epok::StreamingWarmupStats` for bounded CD or PC geometry-page streaming.Field mesh_Exposes `mesh_` on the `epok` namespace for bounded CD or PC geometry-page streaming.Field pagesExposes `pages` on `epok::StreamingWarmupStats` for bounded CD or PC geometry-page streaming.Field quadsExposes `quads` on `epok::StreamMeshView` for bounded CD or PC geometry-page streaming.Field readsExposes `reads` on `epok::StreamingStats` for bounded CD or PC geometry-page streaming.Field readsExposes `reads` on `epok::StreamingWarmupStats` for bounded CD or PC geometry-page streaming.Field rejectedExposes `rejected` on `epok::StreamingWarmupStats` for bounded CD or PC geometry-page streaming.Field rootExposes `root` on `epok::StreamObjectBinding` for bounded CD or PC geometry-page streaming.Field stall_usExposes `stall_us` on `epok::StreamingStats` for bounded CD or PC geometry-page streaming.Field stall_usExposes `stall_us` on `epok::StreamingWarmupStats` for bounded CD or PC geometry-page streaming.Field stallsExposes `stalls` on `epok::StreamingStats` for bounded CD or PC geometry-page streaming.Field stream_archive_fitsGenerated scene.hh provides stream_page_count, stream_pool_pages and stream_archive_path.Variable stream_entryExposes `stream_entry` on the `epok` namespace for bounded CD or PC geometry-page streaming.Variable stream_failedExposes `stream_failed` on the `epok` namespace for bounded CD or PC geometry-page streaming.Variable stream_lookup_pendingExposes `stream_lookup_pending` on the `epok` namespace for bounded CD or PC geometry-page streaming.Variable stream_lookup_startedExposes `stream_lookup_started` on the `epok` namespace for bounded CD or PC geometry-page streaming.Variable stream_page_dataFixed-slot pools never evict.Variable stream_poolExposes `stream_pool` on the `epok` namespace for bounded CD or PC geometry-page streaming.Variable stream_read_pendingExposes `stream_read_pending` on the `epok` namespace for bounded CD or PC geometry-page streaming.Variable stream_readyExposes `stream_ready` on the `epok` namespace for bounded CD or PC geometry-page streaming.Variable stream_timeout_usExposes `stream_timeout_us` on the `epok` namespace for bounded CD or PC geometry-page streaming.Variable stream_warm_sceneExposes `stream_warm_scene` on the `epok` namespace for bounded CD or PC geometry-page streaming.Variable streaming_statsExposes `streaming_stats` on the `epok` namespace for bounded CD or PC geometry-page streaming.Variable streaming_warmup_statsExposes `streaming_warmup_stats` on the `epok` namespace for bounded CD or PC geometry-page streaming.Variable timeoutsExposes `timeouts` on `epok::StreamingStats` for bounded CD or PC geometry-page streaming.Field uses_streamExposes `uses_stream` on `epok::StreamObjectBinding` for bounded CD or PC geometry-page streaming.Field validExposes `valid` on `epok::StreamMeshView` for bounded CD or PC geometry-page streaming.Field verticesExposes `vertices` on `epok::StreamMeshView` for bounded CD or PC geometry-page streaming.Field xa_interruptionsExposes `xa_interruptions` on `epok::StreamingStats` for bounded CD or PC geometry-page streaming.Field