Update library to latest webgpu-native headers #427

PJB3005 · 2024-09-19T15:50:45Z

This goes up to webgpu-native/webgpu-headers@6f549cc
Things I didn't do:

I didn't update the library to make sure "instance dropped" callback error codes are guaranteed to happen, like they seem to be in Dawn.

List of changes (roughly in order of header commits):

Various enum and struct renames
Updated callbacks to use the new *CallbackInfo structs and 2-userdata system. Also updated functions to return WGPUFuture, though the WGPUFuture thing is just stubbed out at the moment as I don't think wgpu-core has the necessary functionality for it. wgpuInstanceWaitAny is unimplemented!()
DepthClipControl merged into PrimitiveState, related code simplified.
Updated depthWriteEnabled to use an optional bool, mostly matters due to added validation.
Add TODOs for missing features (sliced 3D compressed textures)
*Reference() became *AddRef()
Added unorm10-10-10-2 vertex format
Usage field in TextureViewDescriptor, just used for validation as wgpu-core doesn't allow specifying it anyways.
Removed maxInterStageShaderComponents
Added clang_macro_fallback() to bindgen config, since the headers switched to using UINT32_MAX etc. UINT64_MAX still doesn't work so I had to manually define those.
Renamed flags enums. Added a conversion helper function to convert them from u64 -> u32 for mapping. (means added direct dependency on bitflags crate)
Removed device argument from (unimplemented) wgpuGetProcAddress
Suboptimal surface texture acquisition moved to enum return value, was easy since wgpu-core already returns it like that.
"Undefined" present mode added, it just selects FIFO.
*EnumerateFeatures() has been replaced with *GetFeatures().
All strings are now passed as WGPUStringView.

This goes up to webgpu-native/webgpu-headers@2b59747 Things I *didn't* do: * I didn't update the library to make sure "instance dropped" callback error codes are guaranteed to happen, like they seem to be in Dawn. List of changes (roughly in order of header commits): Various enum and struct renames Updated callbacks to use the new *CallbackInfo structs and 2-userdata system. Also updated functions to return WGPUFuture, though the WGPUFuture thing is just stubbed out at the moment as I don't think wgpu-core has the necessary functionality for it. wgpuInstanceWaitAny is unimplemented!() DepthClipControl merged into PrimitiveState, related code simplified. Updated depthWriteEnabled to use an optional bool, mostly matters due to added validation. Add TODOs for missing features (sliced 3D compressed textures) *Reference() became *AddRef() Added unorm10-10-10-2 vertex format Usage field in TextureViewDescriptor, just used for validation as wgpu-core doesn't allow specifying it anyways. Removed maxInterStageShaderComponents Added clang_macro_fallback to bindgen config, since the headers switched to using UINT32_MAX etc. UINT64_MAX still doesn't work so I had to manually define those. Renamed flags enums. Added a conversion helper function to convert them from u64 -> u32 for mapping. (means added direct dependency on bitflags crate) Removed device argument from (unimplemented) wgpuGetProcAddress Suboptimal surface texture acquisition moved to enum return value, was easy since wgpu-core already returns it like that. "Undefined" present mode added, it just selects FIFO.

This enum was replaced with WGPUMapAsyncStatus, but I didn't quite notice. The error codes map different.

PJB3005 · 2024-09-19T16:26:33Z

Remaining Windows CI failure is caused by webgpu-native/webgpu-headers#339

Replaces *EnumerateFeatures with *GetFeatures. Also fixes CI due to fix in headers.

almarklein

LGTM but maybe @rajveermalviya can have a look at the Rust code.

Upstream removed the "Flags" suffix from flags types and moved them to no longer be C enums. This matches that change. WGPUInstanceFlag still has "Flag" in the name because, well, there'd be nothing left to distinguish it from WGPUInstance, and it makes sense for it.

eliemichel

Nice job! I started looking at how to implement futures in wgpu a couple of days ago, nothing obvious but I'll share if I figure sth out!

src/conv.rs

eliemichel · 2024-10-01T21:58:24Z

src/conv.rs

@@ -1701,3 +1694,11 @@ pub fn map_adapter_type(device_type: wgt::DeviceType) -> native::WGPUAdapterType
        wgt::DeviceType::Cpu => native::WGPUAdapterType_CPU,
    }
 }
+
+pub fn from_u64_bits<T: bitflags::Flags<Bits = u32>>(value: u64) -> Option<T> {


(Note: Ideally bitfields would switch to u64 in upstream wgpu instead of needing a conversion here)

eliemichel · 2024-10-01T21:59:48Z

Cargo.toml

@@ -157,6 +157,7 @@ log = "0.4"
 thiserror = "1"
 parking_lot = "0.12"
 smallvec = "1"
+bitflags = "2.6.0"


why is this needed?

It's to be able to refer to bitflags types for the from_u64_bits helper.

Also updates wgpu.h to use WGPUStringView everywhere.

eliemichel · 2024-10-03T07:16:28Z

For WGPUFuture, we need to have access to submission index (and return that in the future's id). Here is the beginning of an attempt at adding this upstream: gfx-rs/wgpu#6360

PJB3005 · 2024-10-03T12:04:01Z

src/utils.rs

+            _ => make_slice(string_view.data as *const u8, string_view.length),
+        };
+
+        Some(std::str::from_utf8_unchecked(bytes))


Important to note: this doesn't check whether strings passed into the library are valid UTF-8. I previously many locations did, but I figured this wasn't necessary.

eliemichel · 2024-10-10T07:31:54Z

FYI I started trying to build upon this PR and upgrade wgpu to my PR that adds submission indices for futures, WIP is here: https://github.com/eliemichel/wgpu-native/tree/eliemichel/2024-10-10-upgrade-wgpu-futures

Ongoing work: I need to figure out what replaced the DynComputePass and DynRenderPass types in newest wgpu.

ygdrasil-io · 2024-10-13T14:53:39Z

There is a missing fonction wgpuGetInstanceFeatures on the rust code but describe on yaml as :

  - name: get_instance_features
    doc: Query the supported instance features
    args:
      - name: features
        doc: The supported instance features
        type: struct.instance_features
        pointer: mutable

eliemichel · 2024-10-13T22:41:21Z

FYI I started trying to build upon this PR and upgrade wgpu

This is now ready, PR: #441

All stubs, since we don't have WaitAny at the moment.

PJB3005 · 2024-10-19T14:37:20Z

@ygdrasil-io done, thanks for pointing that out. Though note it's not very useful since WaitAny isn't implemented yet.

Updates to webgpu-native/webgpu-headers@6a23100

Update to webgpu-native/webgpu-headers@f1cdc3f Also went through a bunch of existing enum conversions and fixed up some seemingly spec-incorrect cases of undefined enums not being handled properly. As part of this, I made a new helper map_enum_with_undefined!() which distinguishes undefined and unknown enum values. Previously, much code relied on undefined being caught in the same net as an unknown value. This is no longer the case.

This updates the headers to webgpu-native/webgpu-headers@af63d34 These changes are exclusively in the header enum values, so no Rust code needs changing. Making this a separate commit for easier review.

Update headers to webgpu-native/webgpu-headers@b7656d0 Adds dual source blending. Other two features (float32 blendable and clip distances feature in wgsl) are not supported by wgpu. Also made map_blend_factor use the shorter macro form, as all the enum names match (they didn't 3 years ago when this code was originally written, according to Git history).

Oops that's not how these chained structs work.

Updates headers to webgpu-native/webgpu-headers@6f549cc Also made matching changes to wgpu.h

…aders

eliemichel · 2024-10-20T16:28:44Z

@rajveermalviya Any specific reason why this PR is on hold? (You not having had time to review it yet is a perfectly fine reason, just trying to figure out if there is a technical blocker I could help with!)

PJB3005 added 2 commits September 19, 2024 17:53

Update C examples to new headers

0c60733

PJB3005 force-pushed the 24-09-19-update-headers branch from 1e19d06 to 0c60733 Compare September 19, 2024 15:53

PJB3005 added 2 commits September 19, 2024 18:14

Fix WGPUBufferMapAsyncStatus tomfoolery

980c2ff

This enum was replaced with WGPUMapAsyncStatus, but I didn't quite notice. The error codes map different.

Fix macOS typos in examples

8f34e48

PJB3005 marked this pull request as ready for review September 19, 2024 16:26

almarklein mentioned this pull request Sep 21, 2024

Incompatible WGPUSType declaration in release webgpu.h #428

Closed

amerkoleci mentioned this pull request Sep 23, 2024

Unorm10_10_10_2 is missing from WGPUVertexFormat enum amerkoleci/Alimer.Bindings#9

Open

Update headers again

b36e558

Replaces *EnumerateFeatures with *GetFeatures. Also fixes CI due to fix in headers.

almarklein requested a review from rajveermalviya September 27, 2024 09:43

almarklein reviewed Sep 27, 2024

View reviewed changes

This was referenced Oct 1, 2024

First class async support pygfx/wgpu-py#391

Closed

WGPUFuture webgpu-native/webgpu-headers#199

Open

eliemichel approved these changes Oct 1, 2024

View reviewed changes

ygdrasil-io mentioned this pull request Oct 2, 2024

use wgpu4k and add Android basic rendering littlektframework/littlekt#279

Draft

PJB3005 added 3 commits October 3, 2024 01:44

Update headers again, WGPUStringView

a256544

Also updates wgpu.h to use WGPUStringView everywhere.

Only specify major version for bitflags dependency

8947cf2

Remove redundant unsafe block

fe965c8

eliemichel approved these changes Oct 3, 2024

View reviewed changes

eliemichel mentioned this pull request Oct 3, 2024

Return submission index to track down completion of async callbacks gfx-rs/wgpu#6360

Open

PJB3005 commented Oct 3, 2024

View reviewed changes

PJB3005 force-pushed the 24-09-19-update-headers branch from ef739f1 to fe965c8 Compare October 4, 2024 23:57

eliemichel mentioned this pull request Oct 13, 2024

Upgrade to latest wgpu #441

Open

Add wgpuGetInstanceFeatures stuff

482bc24

All stubs, since we don't have WaitAny at the moment.

PJB3005 added 9 commits October 19, 2024 17:19

I forgot to cargo fmt again

8f80a2c

Implement "NotUsed" bind group entry types

77dfe52

Updates to webgpu-native/webgpu-headers@6a23100

Update for other enum changes

aa6b617

This updates the headers to webgpu-native/webgpu-headers@af63d34 These changes are exclusively in the header enum values, so no Rust code needs changing. Making this a separate commit for easier review.

Fix getFeatures chained struct handling.

b6b6903

Oops that's not how these chained structs work.

Flatten limits structures

4d49d7f

Updates headers to webgpu-native/webgpu-headers@6f549cc Also made matching changes to wgpu.h

Merge remote-tracking branch 'upstream/trunk' into 24-09-19-update-he…

24ec452

…aders

Some day I will learn to run cargo fmt and check compile before merges

620405f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update library to latest webgpu-native headers #427

Update library to latest webgpu-native headers #427

PJB3005 commented Sep 19, 2024 •

edited

Loading

PJB3005 commented Sep 19, 2024

almarklein left a comment

eliemichel left a comment •

edited

Loading

eliemichel Oct 1, 2024

eliemichel Oct 1, 2024

PJB3005 Oct 1, 2024

eliemichel commented Oct 3, 2024 •

edited

Loading

PJB3005 Oct 3, 2024

eliemichel commented Oct 10, 2024

ygdrasil-io commented Oct 13, 2024

eliemichel commented Oct 13, 2024

PJB3005 commented Oct 19, 2024

eliemichel commented Oct 20, 2024

Update library to latest webgpu-native headers #427

Are you sure you want to change the base?

Update library to latest webgpu-native headers #427

Conversation

PJB3005 commented Sep 19, 2024 • edited Loading

PJB3005 commented Sep 19, 2024

almarklein left a comment

Choose a reason for hiding this comment

eliemichel left a comment • edited Loading

Choose a reason for hiding this comment

eliemichel Oct 1, 2024

Choose a reason for hiding this comment

eliemichel Oct 1, 2024

Choose a reason for hiding this comment

PJB3005 Oct 1, 2024

Choose a reason for hiding this comment

eliemichel commented Oct 3, 2024 • edited Loading

PJB3005 Oct 3, 2024

Choose a reason for hiding this comment

eliemichel commented Oct 10, 2024

ygdrasil-io commented Oct 13, 2024

eliemichel commented Oct 13, 2024

PJB3005 commented Oct 19, 2024

eliemichel commented Oct 20, 2024

PJB3005 commented Sep 19, 2024 •

edited

Loading

eliemichel left a comment •

edited

Loading

eliemichel commented Oct 3, 2024 •

edited

Loading