Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Provide a description of every descriptor member #2815

Open
toji opened this issue May 3, 2022 · 0 comments
Open

Provide a description of every descriptor member #2815

toji opened this issue May 3, 2022 · 0 comments
Assignees
@toji
Labels
copyediting Pure editorial stuff (copyediting, bikeshed, etc.)
Projects
Main
Milestone
Milestone 0

Comments

@toji
Copy link
Member

toji commented May 3, 2022

The WebGPU spec contains tons of descriptors for object creation or command arguments, but almost none of them have text to describe what effect they have (unless it happens to be given as part of validation somewhere.)

Similar to how most every function argument now has at least a sentence describing it's purpose, every single descriptor in the spec should have at least a basic description of what effect it's members have.
@toji toji added the copyediting Pure editorial stuff (copyediting, bikeshed, etc.) label May 3, 2022
@toji toji added this to the V1.0 milestone May 3, 2022
@toji toji self-assigned this May 3, 2022
@toji toji mentioned this issue May 3, 2022
Merged
toji added a commit that referenced this issue May 5, 2022
@toji
Add definitions to more render pipeline descriptors
8b7a1e4 
Part of #2815

Adds descriptor definitions for BlendComponent, MultisampleState,
PrimitiveState, and related descriptors and enums.
@toji toji mentioned this issue May 5, 2022
Merged
toji added a commit that referenced this issue May 6, 2022
@toji
Add descriptions for buffer and texture creation options
822f863 
Part of #2815, adds descriptions to buffer and texture descriptors
and usages.
@toji toji mentioned this issue May 6, 2022
Merged
toji added a commit that referenced this issue May 6, 2022
@toji
Add descriptions for buffer and texture creation options
11802ab 
Part of #2815, adds descriptions to buffer and texture descriptors
and usages.
toji added a commit that referenced this issue May 10, 2022
@toji
Adds descriptions to multiple dictionary and enum members
612776b 
Part of #2815

Adds or improves descriptions for the following dictionaries and
enums:
 - GPUMapMode
 - GPUTextureViewDescriptor
 - GPUTextureAspect
 - GPUSamplerDescriptor
 - GPUShaderStageFlags
 - GPUShaderStage
 - GPUShaderModuleDescriptor
 - GPUShaderModuleCompilationHint
 - GPUIndexFormat
 - GPUVertexStepMode
 - GPUVertexBufferLayout
 - GPUVertexAttribute
 - GPUImageDataLayout
 - GPUImageCopyBuffer
This was referenced May 10, 2022
Merged
Merged
kainino0x added a commit that referenced this issue May 12, 2022
@toji @kainino0x
Even more descriptions for dictionary and enum members (#2858)
70bd8f1 
* Adds descriptions to multiple dictionary and enum members

Part of #2815

Adds or improves descriptions for the following dictionaries and
enums:
 - GPUMapMode
 - GPUTextureViewDescriptor
 - GPUTextureAspect
 - GPUSamplerDescriptor
 - GPUShaderStageFlags
 - GPUShaderStage
 - GPUShaderModuleDescriptor
 - GPUShaderModuleCompilationHint
 - GPUIndexFormat
 - GPUVertexStepMode
 - GPUVertexBufferLayout
 - GPUVertexAttribute
 - GPUImageDataLayout
 - GPUImageCopyBuffer

* Apply suggestions from code review

Co-authored-by: Kai Ninomiya <kainino@chromium.org>
toji added a commit that referenced this issue May 12, 2022
@toji
Add definitions to more render pipeline descriptors
8669f7e 
Part of #2815

Adds descriptor definitions for BlendComponent, MultisampleState,
PrimitiveState, and related descriptors and enums.
toji added a commit that referenced this issue May 16, 2022
@toji
Add definitions for bind group descriptors
31c96f7 
Part of #2815

Adds or improves descriptions for the following dictionaries:

 - GPUBindGroupLayoutEntry
 - GPUBindGroupDescriptor
 - GPUBindGroupEntry
 - GPUBufferBinding
 - GPUPipelineLayoutDescriptor
@toji toji mentioned this issue May 16, 2022
Merged
toji added a commit that referenced this issue May 17, 2022
@toji
Add definitions for bind group descriptors
b343f14 
Part of #2815

Adds or improves descriptions for the following dictionaries:

 - GPUBindGroupLayoutEntry
 - GPUBindGroupDescriptor
 - GPUBindGroupEntry
 - GPUBufferBinding
 - GPUPipelineLayoutDescriptor
toji added a commit that referenced this issue May 17, 2022
@toji
Add definitions for bind group descriptors
4aa25a6 
Part of #2815

Adds or improves descriptions for the following dictionaries:

 - GPUBindGroupLayoutEntry
 - GPUBindGroupDescriptor
 - GPUBindGroupEntry
 - GPUBufferBinding
 - GPUPipelineLayoutDescriptor
jdarpinian pushed a commit to jdarpinian/gpuweb that referenced this issue Aug 12, 2022
@toji @jdarpinian
Add descriptions for buffer and texture creation options
c4e8892 
Part of gpuweb#2815, adds descriptions to buffer and texture descriptors
and usages.
jdarpinian pushed a commit to jdarpinian/gpuweb that referenced this issue Aug 12, 2022
@toji @kainino0x @jdarpinian
Even more descriptions for dictionary and enum members (gpuweb#2858)
e0bc991 
* Adds descriptions to multiple dictionary and enum members

Part of gpuweb#2815

Adds or improves descriptions for the following dictionaries and
enums:
 - GPUMapMode
 - GPUTextureViewDescriptor
 - GPUTextureAspect
 - GPUSamplerDescriptor
 - GPUShaderStageFlags
 - GPUShaderStage
 - GPUShaderModuleDescriptor
 - GPUShaderModuleCompilationHint
 - GPUIndexFormat
 - GPUVertexStepMode
 - GPUVertexBufferLayout
 - GPUVertexAttribute
 - GPUImageDataLayout
 - GPUImageCopyBuffer

* Apply suggestions from code review

Co-authored-by: Kai Ninomiya <kainino@chromium.org>
jdarpinian pushed a commit to jdarpinian/gpuweb that referenced this issue Aug 12, 2022
@toji @jdarpinian
Add definitions to more render pipeline descriptors
83f2554 
Part of gpuweb#2815

Adds descriptor definitions for BlendComponent, MultisampleState,
PrimitiveState, and related descriptors and enums.
jdarpinian pushed a commit to jdarpinian/gpuweb that referenced this issue Aug 12, 2022
@toji @jdarpinian
Add definitions for bind group descriptors
393b866 
Part of gpuweb#2815

Adds or improves descriptions for the following dictionaries:

 - GPUBindGroupLayoutEntry
 - GPUBindGroupDescriptor
 - GPUBindGroupEntry
 - GPUBufferBinding
 - GPUPipelineLayoutDescriptor
@kainino0x kainino0x modified the milestones: V1.0, Polish post-V1 Mar 2, 2023
@kainino0x kainino0x modified the milestones: Polish post-V1, V1.0 Aug 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@toji toji

Labels
copyediting Pure editorial stuff (copyediting, bikeshed, etc.)
Projects
No open projects
Main
Awaiting triage
Milestone
Milestone 0
Development

No branches or pull requests
2 participants
@kainino0x @toji