zig/mach
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

gpu: update README to reflect handle methods strategy

Browse source 
Signed-off-by: Stephen Gutekanst <stephen@hexops.com>
This commit is contained in:
Stephen Gutekanst 2022-07-15 00:32:34 -07:00 • committed by Stephen Gutekanst
parent c3cc9d5ae2
commit 3c8dfa06a1
1 changed files with 3 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
gpu/README.md
View file

@ -94,7 +94,9 @@ When updating, every single change is verified against [the WebGPU spec itself](
The rules for translating `webgpu.h` are as follows:
* `WGPUBuffer` -> `gpu.Buffer` (opaque pointer types only go into their own `Buffer.zig` file, with a `ptr: *anyopaque` field.)
* `WGPUBuffer` -> `gpu.Buffer`:
* Handles like these become a `pub const Buffer = enum(usize) {_}` to ensure they are still pointers compatible with the C ABI, while still allowing us to declare methods on them.
* As a result, `null` is represented as `gpu.Buffer.none` which is defined as `pub const none: Buffer = @intToEnum(Buffer, 0);` iff the type can be nullable.g
* `WGPUBufferBindingType` -> `gpu.Buffer.BindingType` (purely because it's prefix matches an opaque pointer type, it thus goes into that file.)
* Reserved Zig keywords:
* `undefined` -> `undef`