WebGPU PR #2 — Interfaces for representing pipeline resources by chrisdavidmills · Pull Request #25140 · mdn/content

chrisdavidmills · 2023-03-07T10:36:22Z

Important: DO NOT merge this PR until #24202 has been merged.

Description

This PR is part of a multi-PR series that aims to document the WebGPU API. The interfaces documented in this PR are:

GPUBuffer (done)
GPUExternalTexture (done)
GPUSampler (done)
GPUShaderModule (done)
GPUTexture (done)
GPUTextureView (done)

Note that the main PR for this series is #24202 — that one must be merged first, before any others! after that, and each subsequent one, is merged, main should be merged into the next PR, and the documentation integrity must be checked (e.g. do all the links work) before merging.

You can see full details of the additions expected in the WebGPU docs in my research document.

Motivation

Additional details

Related issues and pull requests

github-actions · 2023-03-07T10:46:22Z

Preview URLs (31 pages)

Flaws (42)

Note! 14 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/GPUExternalTexture
Title: GPUExternalTexture
Flaw count: 2

macros:
- /en-US/docs/Web/API/GPUError does not exist
- /en-US/docs/Web/API/GPUBindGroup does not exist

URL: /en-US/docs/Web/API/GPUExternalTexture/label
Title: GPUExternalTexture.label
Flaw count: 1

macros:
- /en-US/docs/Web/API/GPUError does not exist

URL: /en-US/docs/Web/API/GPUBuffer
Title: GPUBuffer
Flaw count: 1

macros:
- /en-US/docs/Web/API/GPUError does not exist

URL: /en-US/docs/Web/API/GPUBuffer/mapAsync
Title: GPUBuffer.mapAsync()
Flaw count: 1

macros:
- /en-US/docs/Web/API/GPUValidationError does not exist

URL: /en-US/docs/Web/API/GPUBuffer/label
Title: GPUBuffer.label
Flaw count: 1

macros:
- /en-US/docs/Web/API/GPUError does not exist

URL: /en-US/docs/Web/API/GPUBuffer/usage
Title: GPUBuffer.usage
Flaw count: 11

macros:
- /en-US/docs/Web/API/GPUCommandEncoder/copyBufferToBuffer does not exist
- /en-US/docs/Web/API/GPUCommandEncoder/copyTextureToBuffer does not exist
- /en-US/docs/Web/API/GPURenderPassEncoder/setIndexBuffer does not exist
- /en-US/docs/Web/API/GPURenderPassEncoder/drawIndirect does not exist
- /en-US/docs/Web/API/GPURenderPassEncoder/dispatchWorkgroupsIndirect does not exist
- and 6 more flaws omitted

URL: /en-US/docs/Web/API/GPUShaderModule
Title: GPUShaderModule
Flaw count: 2

macros:
- /en-US/docs/Web/API/GPUError does not exist
- /en-US/docs/Web/API/GPUCompilationInfo does not exist

URL: /en-US/docs/Web/API/GPUShaderModule/label
Title: GPUShaderModule.label
Flaw count: 1

macros:
- /en-US/docs/Web/API/GPUError does not exist

URL: /en-US/docs/Web/API/GPUShaderModule/getCompilationInfo
Title: GPUShaderModule.getCompilationInfo()
Flaw count: 4

macros:
- /en-US/docs/Web/API/GPUCompilationInfo does not exist
- /en-US/docs/Web/API/GPUCompilationInfo does not exist
- /en-US/docs/Web/API/GPUCompilationInfo does not exist
- /en-US/docs/Web/API/GPUCompilationMessage does not exist

URL: /en-US/docs/Web/API/GPUTextureView
Title: GPUTextureView
Flaw count: 2

macros:
- /en-US/docs/Web/API/GPUError does not exist
- /en-US/docs/Web/API/GPUCommandEncoder/beginRenderPass does not exist

URL: /en-US/docs/Web/API/GPUTextureView/label
Title: GPUTextureView.label
Flaw count: 1

macros:
- /en-US/docs/Web/API/GPUError does not exist

URL: /en-US/docs/Web/API/GPUSampler
Title: GPUSampler
Flaw count: 1

macros:
- /en-US/docs/Web/API/GPUError does not exist

URL: /en-US/docs/Web/API/GPUSampler/label
Title: GPUSampler.label
Flaw count: 1

macros:
- /en-US/docs/Web/API/GPUError does not exist

URL: /en-US/docs/Web/API/GPUTexture
Title: GPUTexture
Flaw count: 2

macros:
- /en-US/docs/Web/API/GPUError does not exist
- /en-US/docs/Web/API/GPUQueue/copyExternalImageToTexture does not exist

URL: /en-US/docs/Web/API/GPUTexture/label
Title: GPUTexture.label
Flaw count: 1

macros:
- /en-US/docs/Web/API/GPUError does not exist

URL: /en-US/docs/Web/API/GPUTexture/usage
Title: GPUTexture.usage
Flaw count: 7

macros:
- /en-US/docs/Web/API/GPUCommandEncoder/copyTextureToBuffer does not exist
- /en-US/docs/Web/API/GPUCommandEncoder/copyBufferToTexture does not exist
- /en-US/docs/Web/API/GPUCommandEncoder/beginRenderPass does not exist
- /en-US/docs/Web/API/GPUBindGroup does not exist
- /en-US/docs/Web/API/GPUBindGroupLayout does not exist
- and 2 more flaws omitted

URL: /en-US/docs/Web/API/GPUTexture/createView
Title: GPUTexture.createView()
Flaw count: 3

macros:
- /en-US/docs/Web/API/GPUError does not exist
- /en-US/docs/Web/API/GPUValidationError does not exist
- /en-US/docs/Web/API/GPUCommandEncoder/beginRenderPass does not exist

External URLs (12)

URL: /en-US/docs/Web/API/GPUExternalTexture
Title: GPUExternalTexture

https://webgpu.github.io/webgpu-samples/samples/videoUploading (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/GPUBuffer
Title: GPUBuffer

https://mdn.github.io/dom-examples/webgpu-compute-demo/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/GPUShaderModule
Title: GPUShaderModule

https://gpuweb.github.io/gpuweb/wgsl/ (1 time) (Note! This may be a new URL 👀)
https://mdn.github.io/dom-examples/webgpu-render-demo/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/GPUTextureView
Title: GPUTextureView

https://webgpu.github.io/webgpu-samples/samples/cubemap (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/GPUSampler
Title: GPUSampler

https://webgpu.github.io/webgpu-samples/samples/shadowMapping (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/GPUTexture
Title: GPUTexture

https://webgpu.github.io/webgpu-samples/samples/texturedCube (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/GPUTexture/createView
Title: GPUTexture.createView()

https://gpuweb.github.io/gpuweb/ (6 times) (Note! This may be a new URL 👀)
https://webgpu.github.io/webgpu-samples/samples/cubemap (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/GPUTexture/format
Title: GPUTexture.format

https://gpuweb.github.io/gpuweb/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Glossary/Bitwise_flags
Title: Bitwise flags

https://en.wikipedia.org/wiki/Bitwise_operation (1 time) (Note! This may be a new URL 👀)
https://www.hendrik-erz.de/post/bitwise-flags-are-beautiful-and-heres-why (1 time) (Note! This may be a new URL 👀)

(comment last updated: 2023-04-05 12:27:06)

dawei-wang

A few typos

files/en-us/web/api/gputexture/dimension/index.md

files/en-us/web/api/gputexture/format/index.md

files/en-us/web/api/gputexture/index.md

toji

Looking good!

files/en-us/web/api/gpubuffer/getmappedrange/index.md

files/en-us/web/api/gpubuffer/mapasync/index.md

files/en-us/web/api/gpubuffer/index.md

files/en-us/web/api/gputexture/height/index.md

files/en-us/web/api/gputexture/index.md

files/en-us/web/api/gputexture/usage/index.md

files/en-us/web/api/gputexture/width/index.md

files/en-us/glossary/bitwise_flags/index.md

toji

Awesome, thanks for the updates! This change overall LGTM now! (Can't actually approve because it's a draft)

chrisdavidmills · 2023-03-20T08:04:57Z

Awesome, thanks for the updates! This change overall LGTM now! (Can't actually approve because it's a draft)

Great, thanks!

Elchi3

Merging this per slack discussion 👍

chrisdavidmills requested a review from a team as a code owner March 7, 2023 10:36

chrisdavidmills requested review from wbamberg and removed request for a team March 7, 2023 10:36

github-actions bot added the Content:WebAPI Web API docs label Mar 7, 2023

chrisdavidmills marked this pull request as draft March 7, 2023 10:36

chrisdavidmills mentioned this pull request Mar 7, 2023

WebGPU API docs #24202

Merged

dawei-wang reviewed Mar 7, 2023

View reviewed changes

toji reviewed Mar 8, 2023

View reviewed changes

github-actions bot added the Content:Glossary Glossary entries label Mar 13, 2023

toji reviewed Mar 13, 2023

View reviewed changes

files/en-us/glossary/bitwise_flags/index.md Show resolved Hide resolved

files/en-us/glossary/bitwise_flags/index.md Show resolved Hide resolved

files/en-us/glossary/bitwise_flags/index.md Show resolved Hide resolved

toji reviewed Mar 14, 2023

View reviewed changes

chrisdavidmills marked this pull request as ready for review April 3, 2023 08:54

chrisdavidmills requested a review from a team as a code owner April 3, 2023 08:54

chrisdavidmills mentioned this pull request Apr 3, 2023

WebGPU PR #3 — Interfaces for representing pipelines #25174

Merged

chrisdavidmills added 14 commits April 5, 2023 12:51

Add GPUBuffer reference pages

cda6d28

update folder names

3db6d7f

update folder names

06efa76

Add GPUTexture reference pages

c7223a0

Add GPUTextureView reference pages

1f9e3fc

Add GPUSampler reference pages

569bd88

Add GPUExternalTexture reference pages

d37d57c

Adding GPUShaderModule reference pages

4fe0dc2

Fixes for toji and dawei-wang comments

afdab06

Update bitwise flags information, including adding glossary entry

2d2e2ee

Remove curly quote

3fcfc20

Couple of updates to the Bitwise flags Glossary entry

60b94cd

Fixing typos, improving language

1741cb4

Update basic MDN demo links to use the dom-examples versions

1c210af

chrisdavidmills force-pushed the webgpu-docs-2-resources branch from de4f813 to 1c210af Compare April 5, 2023 11:54

fixing a couple of small errors

8ca9812

Elchi3 approved these changes Apr 5, 2023

View reviewed changes

Elchi3 merged commit 3996d67 into mdn:main Apr 5, 2023

chrisdavidmills deleted the webgpu-docs-2-resources branch April 5, 2023 13:04

Comments

Conversation

chrisdavidmills commented Mar 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation

Additional details

Related issues and pull requests

Uh oh!

github-actions bot commented Mar 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dawei-wang left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

toji left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

toji left a comment

Choose a reason for hiding this comment

Uh oh!

chrisdavidmills commented Mar 20, 2023

Uh oh!

Elchi3 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

chrisdavidmills commented Mar 7, 2023 •

edited

Loading

github-actions bot commented Mar 7, 2023 •

edited

Loading