Tighten wording around capture of API calls#3004
Open
bradgrantham-lunarg wants to merge 2 commits into
Open
Conversation
MarkY-LunarG
reviewed
Jun 5, 2026
| **A capture file should contain as much as possible all of the unmodified graphics API call context made by the application for the captured, trimmed range of frames.** | ||
|
|
||
| It may contain more commands represented by Metadata commands but it should be possible to **reconstruct** the original app’s sequence of API commands from the captured “api call” blocks. | ||
| The capture file should preserve the original application API call, parameters, object associations, and observed results as captured. This data should be stored as an ApiCall or MethodCall block when possible, representing the API call in its original form. |
Contributor
There was a problem hiding this comment.
Maybe "Each API call of the original application should be preserved inside of the capture file in the proper sequence it was made and contain properly recorded parameters, object associations and results." The reason I suggest it is because when I start reading it, the sentence sounds like it's relative to all contents of the capture file, but you're identifying the API call specifically and how it's recorded.
Contributor
Author
There was a problem hiding this comment.
I think this has to be read in context with the next couple of sentences, stating explicitly that ApiCall and MethodCall blocks are preferred, but Metadata commands are an alternative when appropriate. I've changed the paragraph to:
The capture file should preserve the original application API calls and parameters, object associations, and observed results for each call. This data should be stored as an ApiCall or MethodCall block when possible, representing each API call in its original form.
How about that?
MarkY-LunarG
reviewed
Jun 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.