Add partial documentation of WGPUSurface. #319
Merged
Conversation
This file contains 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
Done are: - wgpuInstanceCreateSurface - wgpuSurfaceGetCapabilities And all the descriptors / enums referenced by them, as well as a more detailed article with pseudo-spec and examples. Remaining are: - wgpuSurfaceConfigure - wgpuSurfaceUnconfigure - wgpuSurfaceGetCurrentTexture - wgpuSurfacePresent
|
Can you add comments instead? I was going to push the rest of the doc now because I had time before your review. Sorry :X |
|
Or actually, let me rebase on top of your edits. |
|
PTAL, this should be the full API documentation, with some TODOs of things to resolve. |
|
Oops sorry, didn't realize you had more changes incoming! |
kainino0x
approved these changes
Aug 27, 2024
|
|
||
| The behavior of `::wgpuSurfaceConfigure``(surface, config)` is: | ||
|
|
||
| - If any of these validation steps fails, TODO: what should happen on failure? |
There was a problem hiding this comment.
Probably it should follow the JS API, which:
- throws a TypeError (= WGPUStatus_something probably?) for invalid texture formats
- generates a device error (on
config.device) for other cases
There was a problem hiding this comment.
I'll leave this open for now as I think it requires more discussions than what we can do in this review.
Kangz
commented
Aug 27, 2024
Kangz
commented
Aug 27, 2024
Co-authored-by: Kai Ninomiya <[email protected]>
Co-authored-by: Kai Ninomiya <[email protected]>
kainino0x
approved these changes
Aug 28, 2024
|
Merging now, @kainino0x please ask wgpu folks to review it and let's file issue for any changes that we might need. |
This was referenced Aug 28, 2024
eliemichel
reviewed
Sep 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Done are:
And all the descriptors / enums referenced by them, as well as a more detailed article with pseudo-spec and examples.
Remaining are: