Add and document many synchronous error statuses #377
Conversation
Fixes webgpu-native#255 Fixes (again?) webgpu-native#291 Issue webgpu-native#225 Fixes webgpu-native#64
webgpu.yml
Outdated
| - name: device_lost | ||
| doc: The @ref WGPUDevice configured on the @ref WGPUSurface was lost. | ||
| - name: error | ||
| doc: The surface is not configured, or there was a @ref StructChainingError. |
There was a problem hiding this comment.
Maybe just point at the Surface.md article for a description of what might return an error?
There was a problem hiding this comment.
I kind of think struct chaining isn't really relevant to pile into the Surface.md article and prefer to just document it here.
webgpu.yml
Outdated
| doc: | | ||
| TODO | ||
| type: bool | ||
| Returns @ref WGPUStatus_Error (and leaves `limits` unchanged) if there was a @ref StructChainingError. |
There was a problem hiding this comment.
What about if the device/adapter itself is an error? IMHO the error cases should be defined in the algorithm steps of the articles, and not call out a particular kind of error.
There was a problem hiding this comment.
This is meant to mirror adapter.limits/device.limits in JS, where there is no possibility of the JS-wrapper object being an error.
I'm OK with moving this stuff into articles if we want to write those, but it's easier to start documenting things here and move them to articles if they get larger.
kainino0x
added
!discuss
|
Revised finally. |
|
@Kangz re-review bump! |
kainino0x
force-pushed
the
return-statuses
branch
from
ba7612f to
e6fdcca
Compare
Sorry this is a lot of things in one PR, but I kept changing all of the docs to be consistent with each other, so this was easier.
(Can split if there are some parts that need more time to discuss.)
Fixes #255
Fixes #291 (again?)
IssueFixes #225Fixes #64 (EDIT: and its duplicate #194)
EDIT: also fixes #115