EPOK RUNTIME
Scene Files
scene_files.hpp · scene lifecycle and scene-stack control
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
scene lifecycle and scene-stack control.
Include this module
C++ include
#include "scene_files.hpp"Types
SceneFileErrorEnum declared by the scene-files module for scene lifecycle and scene-stack control.EnumSceneFileLoadStruct declared by the scene-files module for scene lifecycle and scene-stack control.StructSceneFileStateEnum declared by the scene-files module for scene lifecycle and scene-stack control.EnumSceneFileStatsLoading time and bytes are measured here, apart from gameplay frame timing.StructFunctions and methods
pendingA CD callback still owns the region (and its directory entry).Methodscene_bank_externalPerforms `scene bank external` as part of scene lifecycle and scene-stack control.Functionscene_bank_readyPerforms `scene bank ready` as part of scene lifecycle and scene-stack control.Functionscene_file_beginStart loading the file of an external bank.Functionscene_file_bootAt boot, an external startup bank waits for its file like a transition.Functionscene_file_failPerforms `scene file fail` as part of scene lifecycle and scene-stack control.Functionscene_file_progressFraction of the current file verified so far, 0..4096 (Q12).Functionscene_file_publishPerforms `scene file publish` as part of scene lifecycle and scene-stack control.Functionscene_file_release_drivePerforms `scene file release drive` as part of scene lifecycle and scene-stack control.Functionscene_file_retryAfter a failure, start the same file again once no read owns the region.Functionscene_file_serviceAdvance the current load.Functionscene_file_waitingPerforms `scene file waiting` as part of scene lifecycle and scene-stack control.Functionscene_files_preparePerforms `scene files prepare` as part of scene lifecycle and scene-stack control.Functionscene_regionPerforms `scene region` as part of scene lifecycle and scene-stack control.Functionscene_region_bytesPerforms `scene region bytes` as part of scene lifecycle and scene-stack control.FunctionFields, variables and values
__epok_scene_region_endExposes `__epok_scene_region_end` on the `epok` namespace for scene lifecycle and scene-stack control.Variable__epok_scene_region_startExternal scenes keep their data out of the executable.VariablebytesExposes `bytes` on `epok::SceneFileStats` for scene lifecycle and scene-stack control.FieldChecksumNamed value `Checksum` in `epok::SceneFileError`.Enum valueDriveNamed value `Drive` in `epok::SceneFileError`.Enum valueerrorExposes `error` on `epok::SceneFileStats` for scene lifecycle and scene-stack control.FieldFailedNamed value `Failed` in `epok::SceneFileState`.Enum valuefailuresExposes `failures` on `epok::SceneFileStats` for scene lifecycle and scene-stack control.FieldfoundExposes `found` on `epok::SceneFileLoad` for scene lifecycle and scene-stack control.FieldhashExposes `hash` on `epok::SceneFileLoad` for scene lifecycle and scene-stack control.FieldhostExposes `host` on `epok::SceneFileLoad` for scene lifecycle and scene-stack control.FieldIdleNamed value `Idle` in `epok::SceneFileState`.Enum valuelast_usExposes `last_us` on `epok::SceneFileStats` for scene lifecycle and scene-stack control.FieldloadedVerified bytes of the file being loaded.FieldloadingFile indices; -1 means none.FieldloadsExposes `loads` on `epok::SceneFileStats` for scene lifecycle and scene-stack control.FieldlookupExposes `lookup` on `epok::SceneFileLoad` for scene lifecycle and scene-stack control.Fieldlookup_doneExposes `lookup_done` on `epok::SceneFileLoad` for scene lifecycle and scene-stack control.Fieldmax_usExposes `max_us` on `epok::SceneFileStats` for scene lifecycle and scene-stack control.FieldMissingNamed value `Missing` in `epok::SceneFileError`.Enum valueNoneNamed value `None` in `epok::SceneFileError`.Enum valueReadNamed value `Read` in `epok::SceneFileError`.Enum valueread_completeExposes `read_complete` on `epok::SceneFileLoad` for scene lifecycle and scene-stack control.Fieldread_okExposes `read_ok` on `epok::SceneFileLoad` for scene lifecycle and scene-stack control.Fieldread_startedExposes `read_started` on `epok::SceneFileLoad` for scene lifecycle and scene-stack control.FieldReadingNamed value `Reading` in `epok::SceneFileState`.Enum valueReadyNamed value `Ready` in `epok::SceneFileState`.Enum valueRecordNamed value `Record` in `epok::SceneFileError`.Enum valueresidentFile indices; -1 means none.Fieldscene_file_bankBank whose file is being loaded before its load function may run, or -1.Variablescene_file_entryExposes `scene_file_entry` on the `epok` namespace for scene lifecycle and scene-stack control.Variablescene_file_host_chunkPCDrv reads block the frame; smaller reads keep the loading screen updating.Variablescene_file_loadExposes `scene_file_load` on the `epok` namespace for scene lifecycle and scene-stack control.Variablescene_file_statsExposes `scene_file_stats` on the `epok` namespace for scene lifecycle and scene-stack control.Variablescene_file_timeout_usExposes `scene_file_timeout_us` on the `epok` namespace for scene lifecycle and scene-stack control.Variablescene_read_actionExposes `scene_read_action` on the `epok` namespace for scene lifecycle and scene-stack control.VariableSizeNamed value `Size` in `epok::SceneFileError`.Enum valuestartedExposes `started` on `epok::SceneFileLoad` for scene lifecycle and scene-stack control.FieldstateExposes `state` on `epok::SceneFileStats` for scene lifecycle and scene-stack control.FieldtotalVerified bytes of the file being loaded.FieldWaitingNamed value `Waiting` in `epok::SceneFileState`.Enum value