Stay organized with collections
Save and categorize content based on your preferences.
SwappyStats
#include <swappy_common.h>
Swappy frame statistics, collected if toggled on with SwappyGL_enableStats or SwappyVk_enableStats.
Summary
Public attributes
|
idleFrames[MAX_FRAME_BUCKETS]
|
uint64_t
Histogram of the number of screen refreshes a frame waited in the compositor queue after rendering was completed.
|
lateFrames[MAX_FRAME_BUCKETS]
|
uint64_t
Histogram of the number of screen refreshes passed between the requested presentation time and the actual present time.
|
latencyFrames[MAX_FRAME_BUCKETS]
|
uint64_t
Histogram of the number of screen refreshes passed between the call to Swappy_recordFrameStart and the actual present time.
|
offsetFromPreviousFrame[MAX_FRAME_BUCKETS]
|
uint64_t
Histogram of the number of screen refreshes passed between two consecutive frames.
|
totalFrames
|
uint64_t
Total frames swapped by swappy.
|
Public attributes
idleFrames
uint64_t SwappyStats::idleFrames[MAX_FRAME_BUCKETS]
Histogram of the number of screen refreshes a frame waited in the compositor queue after rendering was completed.
For example: if a frame waited 2 refresh periods in the compositor queue after rendering was done, the frame will be counted in idleFrames[2]
lateFrames
uint64_t SwappyStats::lateFrames[MAX_FRAME_BUCKETS]
Histogram of the number of screen refreshes passed between the requested presentation time and the actual present time.
For example: if a frame was presented 2 refresh periods after the requested timestamp swappy set, the frame will be counted in lateFrames[2]
latencyFrames
uint64_t SwappyStats::latencyFrames[MAX_FRAME_BUCKETS]
Histogram of the number of screen refreshes passed between the call to Swappy_recordFrameStart and the actual present time.
For example: if a frame was presented 2 refresh periods after the call to Swappy_recordFrameStart the frame will be counted in latencyFrames[2]
offsetFromPreviousFrame
uint64_t SwappyStats::offsetFromPreviousFrame[MAX_FRAME_BUCKETS]
Histogram of the number of screen refreshes passed between two consecutive frames.
For example: if frame N was presented 2 refresh periods after frame N-1 frame N will be counted in offsetFromPreviousFrame[2]
totalFrames
uint64_t SwappyStats::totalFrames
Total frames swapped by swappy.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2023-03-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-03-10 UTC."],[],[],null,["# SwappyStats Struct Reference\n\nSwappyStats\n===========\n\n`#include \u003cswappy_common.h\u003e`\n\nSwappy frame statistics, collected if toggled on with [SwappyGL_enableStats](/games/sdk/reference/frame-pacing/group/swappy-g-l-extra#group__swappy_g_l__extra_1ga1191b042d23c0e3d9da59afd94d3c4b9) or [SwappyVk_enableStats](/games/sdk/reference/frame-pacing/group/swappy-vk#group__swappy_vk_1gac1b42c5baf4f351955df0c027aba14c2).\n\nSummary\n-------\n\n| ### Public attributes ||\n|---------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| [idleFrames](#struct_swappy_stats_1ad35d26710572f96861be92e2f2354077)`[MAX_FRAME_BUCKETS]` | `uint64_t` Histogram of the number of screen refreshes a frame waited in the compositor queue after rendering was completed. |\n| [lateFrames](#struct_swappy_stats_1aec9d505abf96ddb6de437a5cd3644ab0)`[MAX_FRAME_BUCKETS]` | `uint64_t` Histogram of the number of screen refreshes passed between the requested presentation time and the actual present time. |\n| [latencyFrames](#struct_swappy_stats_1abf14e6e4fc84901ac6de10430dfd7129)`[MAX_FRAME_BUCKETS]` | `uint64_t` Histogram of the number of screen refreshes passed between the call to Swappy_recordFrameStart and the actual present time. |\n| [offsetFromPreviousFrame](#struct_swappy_stats_1ae48fcd61da70878460cec21e868fd9d8)`[MAX_FRAME_BUCKETS]` | `uint64_t` Histogram of the number of screen refreshes passed between two consecutive frames. |\n| [totalFrames](#struct_swappy_stats_1a70ee8980b34e1b8cdb0d9050d125093d) | `uint64_t` Total frames swapped by swappy. |\n\nPublic attributes\n-----------------\n\n### idleFrames\n\n```transact-sql\nuint64_t SwappyStats::idleFrames[MAX_FRAME_BUCKETS]\n``` \nHistogram of the number of screen refreshes a frame waited in the compositor queue after rendering was completed.\n\nFor example: if a frame waited 2 refresh periods in the compositor queue after rendering was done, the frame will be counted in idleFrames\\[2\\] \n\n### lateFrames\n\n```transact-sql\nuint64_t SwappyStats::lateFrames[MAX_FRAME_BUCKETS]\n``` \nHistogram of the number of screen refreshes passed between the requested presentation time and the actual present time.\n\nFor example: if a frame was presented 2 refresh periods after the requested timestamp swappy set, the frame will be counted in lateFrames\\[2\\] \n\n### latencyFrames\n\n```transact-sql\nuint64_t SwappyStats::latencyFrames[MAX_FRAME_BUCKETS]\n``` \nHistogram of the number of screen refreshes passed between the call to Swappy_recordFrameStart and the actual present time.\n\nFor example: if a frame was presented 2 refresh periods after the call to `Swappy_recordFrameStart` the frame will be counted in latencyFrames\\[2\\] \n\n### offsetFromPreviousFrame\n\n```transact-sql\nuint64_t SwappyStats::offsetFromPreviousFrame[MAX_FRAME_BUCKETS]\n``` \nHistogram of the number of screen refreshes passed between two consecutive frames.\n\nFor example: if frame N was presented 2 refresh periods after frame N-1 frame N will be counted in offsetFromPreviousFrame\\[2\\] \n\n### totalFrames\n\n```scdoc\nuint64_t SwappyStats::totalFrames\n``` \nTotal frames swapped by swappy."]]
