Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/articles/Asynchronous Operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,13 @@ Waits on any WGPUFuture in the list of `futures` to complete for `timeoutNS` nan
- Note that the timeout applies only to the "wait" phase, and does not affect the callback firing phase.
- Returns @ref WGPUWaitStatus_TimedOut if the timeout passed without any futures completing.
- Returns @ref WGPUWaitStatus_Error if the call was invalid for any of the following reasons:
- A @ref Timed-Wait was performed when WGPUInstanceFeatures::timedWaitAnyEnable is not enabled.
- A @ref Timed-Wait was performed when @ref WGPUInstanceFeatureName_TimedWaitAny is not enabled.
- The number of futures waited on in a @ref Timed-Wait is greater than the enabled WGPUInstanceFeatures::timedWaitAnyMaxCount.
- A wait was attempted with @ref Mixed-Sources.

### Timed Wait {#Timed-Wait}

Use of _timed waits_ (`timeoutNS > 0`), must be enabled on the WGPUInstance in @ref wgpuCreateInstance() with @ref WGPUInstanceFeatureName_TimedWaitAnyEnable, and the number of futures waited on must be less than or equal to @ref WGPUInstanceLimits::timedWaitAnyMaxCount.
Use of _timed waits_ (`timeoutNS > 0`), must be enabled on the WGPUInstance in @ref wgpuCreateInstance() with @ref WGPUInstanceFeatureName_TimedWaitAny, and the number of futures waited on must be less than or equal to @ref WGPUInstanceLimits::timedWaitAnyMaxCount.

### Mixed Sources {#Mixed-Sources}

Expand Down
2 changes: 1 addition & 1 deletion webgpu.h
Original file line number Diff line number Diff line change
Expand Up @@ -651,7 +651,7 @@ typedef enum WGPUInstanceFeatureName {
/**
* Enable use of ::wgpuInstanceWaitAny with `timeoutNS > 0`.
*/
WGPUInstanceFeatureName_TimedWaitAnyEnable = 0x00000001,
WGPUInstanceFeatureName_TimedWaitAny = 0x00000001,
/**
* Enable passing SPIR-V shaders to @ref wgpuDeviceCreateShaderModule,
* via @ref WGPUShaderSourceSPIRV.
Expand Down
2 changes: 1 addition & 1 deletion webgpu.yml
Original file line number Diff line number Diff line change
Expand Up @@ -534,7 +534,7 @@ enums:
TODO
entries:
- null
- name: timed_wait_any_enable
- name: timed_wait_any
doc: |
Enable use of ::wgpuInstanceWaitAny with `timeoutNS > 0`.
- name: shader_source_SPIRV
Expand Down