Write overview

eliemichel · Mar 3, 2024 · 86e9533 · 86e9533
1 parent 48724f4
commit 86e9533
Show file tree

Hide file tree

Showing 33 changed files with 2,206 additions and 485 deletions.
diff --git a/.github/workflows/gen-docs.yml b/.github/workflows/gen-docs.yml
@@ -15,7 +15,7 @@ jobs:
   gen-docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: actions/setup-go@v4
         with:
           go-version: '>=1.21.0'

diff --git a/doc/src/api.md b/doc/src/api.md
diff --git a/doc/src/enum/index.md b/doc/src/enum/index.md
@@ -2,48 +2,48 @@
 
 **NB** All enumerations also have an extra values ending with `_Force32` that is here to ensure that all compilers use the same underlying representation for the enum values. This value must never be used.
 
- - [`WGPUAdapterType`](AdapterType)
- - [`WGPUAddressMode`](AddressMode)
- - [`WGPUBackendType`](BackendType)
- - [`WGPUBlendFactor`](BlendFactor)
- - [`WGPUBlendOperation`](BlendOperation)
- - [`WGPUBufferBindingType`](BufferBindingType)
- - [`WGPUBufferMapAsyncStatus`](BufferMapAsyncStatus)
- - [`WGPUBufferMapState`](BufferMapState)
- - [`WGPUCompareFunction`](CompareFunction)
- - [`WGPUCompilationInfoRequestStatus`](CompilationInfoRequestStatus)
- - [`WGPUCompilationMessageType`](CompilationMessageType)
- - [`WGPUCompositeAlphaMode`](CompositeAlphaMode)
- - [`WGPUCreatePipelineAsyncStatus`](CreatePipelineAsyncStatus)
- - [`WGPUCullMode`](CullMode)
- - [`WGPUDeviceLostReason`](DeviceLostReason)
- - [`WGPUErrorFilter`](ErrorFilter)
- - [`WGPUErrorType`](ErrorType)
- - [`WGPUFeatureName`](FeatureName)
- - [`WGPUFilterMode`](FilterMode)
- - [`WGPUFrontFace`](FrontFace)
- - [`WGPUIndexFormat`](IndexFormat)
- - [`WGPULoadOp`](LoadOp)
- - [`WGPUMipmapFilterMode`](MipmapFilterMode)
- - [`WGPUPowerPreference`](PowerPreference)
- - [`WGPUPresentMode`](PresentMode)
- - [`WGPUPrimitiveTopology`](PrimitiveTopology)
- - [`WGPUQueryType`](QueryType)
- - [`WGPUQueueWorkDoneStatus`](QueueWorkDoneStatus)
- - [`WGPURequestAdapterStatus`](RequestAdapterStatus)
- - [`WGPURequestDeviceStatus`](RequestDeviceStatus)
- - [`WGPUSType`](SType)
- - [`WGPUSamplerBindingType`](SamplerBindingType)
- - [`WGPUStencilOperation`](StencilOperation)
- - [`WGPUStorageTextureAccess`](StorageTextureAccess)
- - [`WGPUStoreOp`](StoreOp)
- - [`WGPUSurfaceGetCurrentTextureStatus`](SurfaceGetCurrentTextureStatus)
- - [`WGPUTextureAspect`](TextureAspect)
- - [`WGPUTextureDimension`](TextureDimension)
- - [`WGPUTextureFormat`](TextureFormat)
- - [`WGPUTextureSampleType`](TextureSampleType)
- - [`WGPUTextureViewDimension`](TextureViewDimension)
- - [`WGPUVertexFormat`](VertexFormat)
- - [`WGPUVertexStepMode`](VertexStepMode)
- - [`WGPUWGSLFeatureName`](WGSLFeatureName)
+ - [`WGPUAdapterType`](AdapterType.md)
+ - [`WGPUAddressMode`](AddressMode.md)
+ - [`WGPUBackendType`](BackendType.md)
+ - [`WGPUBlendFactor`](BlendFactor.md)
+ - [`WGPUBlendOperation`](BlendOperation.md)
+ - [`WGPUBufferBindingType`](BufferBindingType.md)
+ - [`WGPUBufferMapAsyncStatus`](BufferMapAsyncStatus.md)
+ - [`WGPUBufferMapState`](BufferMapState.md)
+ - [`WGPUCompareFunction`](CompareFunction.md)
+ - [`WGPUCompilationInfoRequestStatus`](CompilationInfoRequestStatus.md)
+ - [`WGPUCompilationMessageType`](CompilationMessageType.md)
+ - [`WGPUCompositeAlphaMode`](CompositeAlphaMode.md)
+ - [`WGPUCreatePipelineAsyncStatus`](CreatePipelineAsyncStatus.md)
+ - [`WGPUCullMode`](CullMode.md)
+ - [`WGPUDeviceLostReason`](DeviceLostReason.md)
+ - [`WGPUErrorFilter`](ErrorFilter.md)
+ - [`WGPUErrorType`](ErrorType.md)
+ - [`WGPUFeatureName`](FeatureName.md)
+ - [`WGPUFilterMode`](FilterMode.md)
+ - [`WGPUFrontFace`](FrontFace.md)
+ - [`WGPUIndexFormat`](IndexFormat.md)
+ - [`WGPULoadOp`](LoadOp.md)
+ - [`WGPUMipmapFilterMode`](MipmapFilterMode.md)
+ - [`WGPUPowerPreference`](PowerPreference.md)
+ - [`WGPUPresentMode`](PresentMode.md)
+ - [`WGPUPrimitiveTopology`](PrimitiveTopology.md)
+ - [`WGPUQueryType`](QueryType.md)
+ - [`WGPUQueueWorkDoneStatus`](QueueWorkDoneStatus.md)
+ - [`WGPURequestAdapterStatus`](RequestAdapterStatus.md)
+ - [`WGPURequestDeviceStatus`](RequestDeviceStatus.md)
+ - [`WGPUSType`](SType.md)
+ - [`WGPUSamplerBindingType`](SamplerBindingType.md)
+ - [`WGPUStencilOperation`](StencilOperation.md)
+ - [`WGPUStorageTextureAccess`](StorageTextureAccess.md)
+ - [`WGPUStoreOp`](StoreOp.md)
+ - [`WGPUSurfaceGetCurrentTextureStatus`](SurfaceGetCurrentTextureStatus.md)
+ - [`WGPUTextureAspect`](TextureAspect.md)
+ - [`WGPUTextureDimension`](TextureDimension.md)
+ - [`WGPUTextureFormat`](TextureFormat.md)
+ - [`WGPUTextureSampleType`](TextureSampleType.md)
+ - [`WGPUTextureViewDimension`](TextureViewDimension.md)
+ - [`WGPUVertexFormat`](VertexFormat.md)
+ - [`WGPUVertexStepMode`](VertexStepMode.md)
+ - [`WGPUWGSLFeatureName`](WGSLFeatureName.md)
 
diff --git a/doc/src/index.md b/doc/src/index.md
@@ -1,3 +1,13 @@
 # WebGPU Native
 
-See [overview](overview).
+**NB** *This documentation is a Work In Progress.*
+
+This is the home of WebGPU Native specification. We define here the standard `webgpu.h` header that all implementations of WebGPU should implement.
+
+## Getting started
+
+The [overview](overview.md) page introduces the key entities that are used by the API and is a good place to start. The [API index](api.md) lists all symbols defined by the C header and can be used for fast navigation.
+
+## Contributing
+
+This documentation is automatically generated from [`webgpu.yml`](https://github.com/webgpu-native/webgpu-headers/blob/main/webgpu.yml), so if you spot any mistake please report it in [the issues](https://github.com/webgpu-native/webgpu-headers/issues) and/or provide a patch through a [pull request](https://github.com/webgpu-native/webgpu-headers/pulls).
diff --git a/doc/src/object/Adapter.md b/doc/src/object/Adapter.md
@@ -21,9 +21,18 @@ size_t wgpuAdapterEnumerateFeatures(WGPUAdapter adapter, WGPUFeatureName * featu
 TODO
 
 
+
+
 **Arguments:**
 
- - TODO
+
+ - `features` (`WGPUFeatureName *`):
+
+
+TODO
+
+
+
 
 
 
@@ -48,9 +57,18 @@ Get the limits that the adapter supports. This is used to drive the
 choice of required limits in {device_descriptor.required_limits}.
 
 
+
+
 **Arguments:**
 
- - TODO
+
+ - `limits` (`WGPUSupportedLimits *`):
+
+
+TODO
+
+
+
 
 
 
@@ -74,9 +92,18 @@ void wgpuAdapterGetProperties(WGPUAdapter adapter, WGPUAdapterProperties * prope
 TODO
 
 
+
+
 **Arguments:**
 
- - TODO
+
+ - `properties` (`WGPUAdapterProperties *`):
+
+
+TODO
+
+
+
 
 
 
@@ -94,9 +121,18 @@ WGPUBool wgpuAdapterHasFeature(WGPUAdapter adapter, WGPUFeatureName feature)
 TODO
 
 
+
+
 **Arguments:**
 
- - TODO
+
+ - `feature` (`WGPUFeatureName`):
+
+
+TODO
+
+
+
 
 
 
@@ -120,9 +156,7 @@ void wgpuAdapterRequestAdapterInfo(WGPUAdapter adapter, WGPUAdapterRequestAdapte
 TODO
 
 
-**Arguments:**
 
- - TODO
 
 
 
@@ -140,9 +174,18 @@ void wgpuAdapterRequestDevice(WGPUAdapter adapter, WGPU_NULLABLE WGPUDeviceDescr
 TODO
 
 
+
+
 **Arguments:**
 
- - TODO
+
+ - `descriptor` (`WGPUDeviceDescriptor const *`, **nullable**):
+
+
+TODO
+
+
+
 
 
 
diff --git a/doc/src/object/BindGroup.md b/doc/src/object/BindGroup.md
@@ -21,9 +21,18 @@ void wgpuBindGroupSetLabel(WGPUBindGroup bindGroup, char const * label)
 TODO
 
 
+
+
 **Arguments:**
 
- - TODO
+
+ - `label` (`char const *`):
+
+
+TODO
+
+
+
 
 
 
diff --git a/doc/src/object/BindGroupLayout.md b/doc/src/object/BindGroupLayout.md
@@ -21,9 +21,18 @@ void wgpuBindGroupLayoutSetLabel(WGPUBindGroupLayout bindGroupLayout, char const
 TODO
 
 
+
+
 **Arguments:**
 
- - TODO
+
+ - `label` (`char const *`):
+
+
+TODO
+
+
+
-Original file line number
+Diff line change
@@ Expand Up @@
     TODO
     **Arguments:**
-     - TODO
+     - `label` (`char const *`):
+    TODO