EPOK RUNTIME
Retained
retained.hpp · the retained module
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
the retained module.
Include this module
C++ include
#include "retained.hpp"Types
FramePacketSlotsPacket cache addresses are not reservations of this frame's GPU budget.Class templateMeshMaterialCacheGenerated topology and face materials are immutable.StructRetainedGeometryClass template declared by the retained module for the retained module.Class templateRetainedKeyStruct declared by the retained module for the retained module.StructRetainedQuadStruct declared by the retained module for the retained module.StructRetainedStatsPer-frame counters: retained objects drawn and packet rebuilds.StructStateStruct declared by the retained module for the retained module.StructFunctions and methods
allocate`limit_slot` is the packet-buffer capacity.Methodallocate_dynamicPerforms `allocate dynamic` as part of the retained module.Methodallocate_dynamic_pairGT4/G4 need 52/36 bytes including DMA, versus 40/28 for GT3/G3.Methodbegin_frameBegins frame as part of the retained module.MethodclaimPerforms `claim` as part of the retained module.Methoddynamic_lowPerforms `dynamic low` as part of the retained module.Methodfaces_unlitPerforms `faces unlit` as part of the retained module.Methodfirst_slotPerforms `first slot` as part of the retained module.MethodforgetA reused entity slot keeps its resident range, including across LODs.Methodinvalidate_borrowedA descending allocation can cross protected chunks without writing them.Function templatemesh_faces_unlitAn imported editable mesh owns per-face materials.Functionoperator==Performs `operator ==` as part of the retained module.Methodprepare_keyPerforms `prepare key` as part of the retained module.MethodquadsPerforms `quads` as part of the retained module.Methodrange_claimedPerforms `range claimed` as part of the retained module.MethodresetResets reset as part of the retained module.Methodretain_mesh_packetsPerforms `retain mesh packets` as part of the retained module.Functionrun_floorA pass emitting many packets may bump through the current free run [run_floor(), dynamic_low()) itself, exactly as allocate_dynamic(_pair) would, and store its new low end before any other allocation.Methodsame_attributesPerforms `same attributes` as part of the retained module.Methodset_dynamic_lowSets dynamic low as part of the retained module.Methodslot_topFirst preferred fragment slot beyond the cache (not a per-frame reservation).MethodstatePerforms `state` as part of the retained module.MethodFields, variables and values
allocatedExposes `allocated` on `epok::RetainedGeometry::State` for the retained module.Fieldany_dynamicExposes `any_dynamic` on `epok::RetainedGeometry::State` for the retained module.Fieldattribute_parityExposes `attribute_parity` on `epok::RetainedGeometry::State` for the retained module.Fieldattribute_revisionExposes `attribute_revision` on `epok::RetainedGeometry::State` for the retained module.Fieldattribute_revisionfirst record only; UV/command source epochFieldbakedExposes `baked` on `epok::RetainedKey` for the retained module.Fieldbaked_countExposes `baked_count` on `epok::RetainedKey` for the retained module.FieldbankExposes `bank` on `epok::RetainedKey` for the retained module.FieldbasisExposes `basis` on `epok::RetainedKey` for the retained module.FieldblendExposes `blend` on `epok::RetainedKey` for the retained module.Fieldbuild_scanlinesExposes `build_scanlines` on `epok::RetainedStats` for the retained module.FieldcapacityExposes `capacity` on `epok::RetainedGeometry::State` for the retained module.Fieldchunk_dynamicOnly the first record of a chunk uses these two flags.FieldcolorAll-zero defaults keep the pool in .bss; `valid` gates every comparison.FieldcommandGPU command byte with the transparency bitFielddepth_biasExposes `depth_bias` on `epok::RetainedKey` for the retained module.Fielddepth_biasExposes `depth_bias` on `epok::RetainedQuad` for the retained module.FielddynamicUV scrolling: the per-frame path draws it insteadFielddynamic_lowExposes `dynamic_low` on `epok::RetainedStats` for the retained module.Fieldfirst_quadExposes `first_quad` on `epok::RetainedGeometry::State` for the retained module.Fieldfoggedper-parity bit: colour words currently hold fogged valuesFieldgenerationExposes `generation` on `epok::RetainedKey` for the retained module.FieldgeometryExposes `geometry` on `epok::MeshMaterialCache` for the retained module.FieldgeometryExposes `geometry` on `epok::RetainedGeometry::State` for the retained module.FieldgeometryExposes `geometry` on `epok::RetainedKey` for the retained module.Fieldgpu_colorsOnly the first record of a chunk uses these two flags.FieldkeyExposes `key` on `epok::RetainedGeometry::State` for the retained module.Fieldlight_signatureExposes `light_signature` on `epok::RetainedKey` for the retained module.Fieldlighting_enabledExposes `lighting_enabled` on `epok::RetainedKey` for the retained module.FieldobjectsExposes `objects` on `epok::RetainedStats` for the retained module.Fieldpackets_invalidExposes `packets_invalid` on `epok::RetainedGeometry::State` for the retained module.Fieldquad_capacityExposes `quad_capacity` on `epok::RetainedGeometry` for the retained module.Variablequad_countExposes `quad_count` on `epok::RetainedGeometry::State` for the retained module.FieldquadsExposes `quads` on `epok::RetainedStats` for the retained module.FieldrebuildsExposes `rebuilds` on `epok::RetainedStats` for the retained module.FieldreceiveExposes `receive` on `epok::RetainedKey` for the retained module.Fieldretained_statsExposes `retained_stats` on the `epok` namespace for the retained module.Variableshadedfog-free 0..255 corner coloursFieldslot_topExposes `slot_top` on `epok::RetainedStats` for the retained module.Fieldstream_validatedExposes `stream_validated` on `epok::RetainedGeometry::State` for the retained module.FieldtextureExposes `texture` on `epok::RetainedKey` for the retained module.FieldtexturedExposes `textured` on `epok::RetainedQuad` for the retained module.FielduniformExposes `uniform` on `epok::MeshMaterialCache` for the retained module.Fielduniform_colorExposes `uniform_color` on `epok::MeshMaterialCache` for the retained module.FieldunlitExposes `unlit` on `epok::MeshMaterialCache` for the retained module.FieldunlitExposes `unlit` on `epok::RetainedKey` for the retained module.Fielduv_scrollExposes `uv_scroll` on `epok::RetainedKey` for the retained module.FieldvalidExposes `valid` on `epok::RetainedKey` for the retained module.Fieldvalid_paritiesOnly the first record of a chunk uses these two flags.Field