# Every member of a vendor's struct that the Overlay reads for Advanced metrics - the whole of what a hooked game's
# arguments give up beyond the frame record (docs/18_GPU_VENDOR_APIS.md section Train B; owner decisions D111, D115 and
# D116, 2026-11-11).
#
# tools/overlay-fields-check.ps1 holds src/native/FrameLedger.Overlay/include/fl_adv_fields.h to this list in both
# directions, on every build: a member read there that is not here is red, and a name here that the header no longer
# reads is red. A camera's position, axes or matrices are red even when they are listed - so one cannot be let in by
# adding a line to this file.
#
# One `Struct::member` per line. To add a read: find the release of the vendor's SDK that introduced the member and add
# it to the table in docs/17_HOOK_ENGINE.md section "Which struct version carries which field" (D115) - a member is read
# only at a struct version proven to carry it - then add its name here, and say in the pull request what it tells and
# why it is an argument of a call the Overlay hooks (rule 4).

# sl::DLSSOptions, chained into slEvaluateFeature's inputs (parameter `o`)
sl::DLSSOptions::structVersion
sl::DLSSOptions::outputWidth
sl::DLSSOptions::outputHeight
sl::DLSSOptions::preExposure
sl::DLSSOptions::exposureScale
sl::DLSSOptions::colorBuffersHDR
sl::DLSSOptions::dlaaPreset
sl::DLSSOptions::qualityPreset
sl::DLSSOptions::balancedPreset
sl::DLSSOptions::performancePreset
sl::DLSSOptions::ultraPerformancePreset
# ... from struct version 2
sl::DLSSOptions::ultraQualityPreset
sl::DLSSOptions::useAutoExposure
# ... from struct version 3
sl::DLSSOptions::alphaUpscalingEnabled

# ffxDispatchDescUpscale, the descriptor of an ffx-api upscale dispatch (parameter `d`). The two cameraX members are
# the depth range and the vertical field of view - numbers a settings menu shows - not where the camera is.
ffxDispatchDescUpscale::enableSharpening
ffxDispatchDescUpscale::sharpness
ffxDispatchDescUpscale::jitterOffset
ffxDispatchDescUpscale::preExposure
ffxDispatchDescUpscale::cameraNear
ffxDispatchDescUpscale::cameraFar
ffxDispatchDescUpscale::cameraFovAngleVertical
ffxDispatchDescUpscale::flags
ffxDispatchDescUpscale::reset
ffxDispatchDescUpscale::frameTimeDelta

# sl::Constants, what the game tells slSetConstants about a frame (parameter `k`; 0.1.0-beta.43). The jitter, the
# motion-vector scale, the depth range, the field of view, the aspect ratio and the seven Booleans - numbers and
# switches of the kind a settings menu or a debug overlay shows. The five matrices, the pinhole offset, the camera's
# position and its three axes sit in the same struct and are refused by name wherever they appear (rule 4).
sl::Constants::jitterOffset
sl::Constants::mvecScale
sl::Constants::cameraNear
sl::Constants::cameraFar
sl::Constants::cameraFOV
sl::Constants::cameraAspectRatio
sl::Constants::depthInverted
sl::Constants::cameraMotionIncluded
sl::Constants::motionVectors3D
sl::Constants::reset
sl::Constants::orthographicProjection
sl::Constants::motionVectorsDilated
sl::Constants::motionVectorsJittered

# sl::FeatureVersion and sl::FeatureRequirements, what Streamline ANSWERS when the game asks about a feature
# (parameters `fv` and `fr`; 0.1.0-beta.44) - read after the original call said OK. The two versions; the flags,
# three counts and four versions of the requirements. The count of required buffer tags is read and its pointer,
# `requiredTags`, is not; nothing after `driverVersionRequired` is - the Vulkan queue counts and the pointers to
# the names of extensions and features.
sl::FeatureVersion::versionSL
sl::FeatureVersion::versionNGX
sl::FeatureRequirements::flags
sl::FeatureRequirements::maxNumCPUThreads
sl::FeatureRequirements::maxNumViewports
sl::FeatureRequirements::numRequiredTags
sl::FeatureRequirements::osVersionDetected
sl::FeatureRequirements::osVersionRequired
sl::FeatureRequirements::driverVersionDetected
sl::FeatureRequirements::driverVersionRequired

# ffxConfigureDescFrameGeneration, how the game configures FSR frame generation (parameter `g`; 0.1.0-beta.43):
# on or off, asynchronous or not, the flags, generated frames only or not, the rectangle generated in. The swapchain,
# the two callbacks and their contexts, the HUD-less resource and the frame id in the same descriptor are not read.
ffxConfigureDescFrameGeneration::frameGenerationEnabled
ffxConfigureDescFrameGeneration::allowAsyncWorkloads
ffxConfigureDescFrameGeneration::flags
ffxConfigureDescFrameGeneration::onlyPresentGenerated
ffxConfigureDescFrameGeneration::generationRect

# The upscaler's memory query: the header's type, the game's out-pointer in either version of the descriptor
# (parameter `q`), and what ffxQuery wrote through it after answering OK (parameter `m`)
ffxQueryDescHeader::type
ffxQueryDescUpscaleGetGPUMemoryUsage::gpuMemoryUsageUpscaler
FfxApiEffectMemoryUsage::totalUsageInBytes
FfxApiEffectMemoryUsage::aliasableUsageInBytes

# NVIDIA's latency report and sleep status (parameters `lr`, `lf`, `ls`; Advanced metrics train C, owner decisions
# D132, D136). NOT arguments of a hooked call: what the driver wrote into buffers the Overlay handed to its two
# read-only getters (fl_reflex.h). Of a frame: its id, the six pairs of times the spans are made of and, since
# 0.1.0-beta.48 (owner decision D142), the two times the driver works out itself -- the GPU's active render time and
# its frame time. Not read: `inputSampleTime`, the camera, frame-generation and cross-adapter times. Of the sleep
# status: the five switches and the frame-generation multiplier; the sleep interval is not read.
NV_LATENCY_RESULT_PARAMS::frameReport
NV_LATENCY_RESULT_PARAMS::FrameReport::frameID
NV_LATENCY_RESULT_PARAMS::FrameReport::simStartTime
NV_LATENCY_RESULT_PARAMS::FrameReport::simEndTime
NV_LATENCY_RESULT_PARAMS::FrameReport::renderSubmitStartTime
NV_LATENCY_RESULT_PARAMS::FrameReport::renderSubmitEndTime
NV_LATENCY_RESULT_PARAMS::FrameReport::presentStartTime
NV_LATENCY_RESULT_PARAMS::FrameReport::presentEndTime
NV_LATENCY_RESULT_PARAMS::FrameReport::driverStartTime
NV_LATENCY_RESULT_PARAMS::FrameReport::driverEndTime
NV_LATENCY_RESULT_PARAMS::FrameReport::osRenderQueueStartTime
NV_LATENCY_RESULT_PARAMS::FrameReport::osRenderQueueEndTime
NV_LATENCY_RESULT_PARAMS::FrameReport::gpuRenderStartTime
NV_LATENCY_RESULT_PARAMS::FrameReport::gpuRenderEndTime
NV_LATENCY_RESULT_PARAMS::FrameReport::gpuActiveRenderTimeUs
NV_LATENCY_RESULT_PARAMS::FrameReport::gpuFrameTimeUs
NV_GET_SLEEP_STATUS_PARAMS::bLowLatencyMode
NV_GET_SLEEP_STATUS_PARAMS::bFsVrr
NV_GET_SLEEP_STATUS_PARAMS::bCplVsyncOn
NV_GET_SLEEP_STATUS_PARAMS::bUseGameSleep
NV_GET_SLEEP_STATUS_PARAMS::bFullscreenIFlip
NV_GET_SLEEP_STATUS_PARAMS::fgMultiplier
