wgpu
wgpu copied to clipboard
Use WGSL instead of GLSL in library documentation
There are a number of items in wgpu whose documentation contain examples using GLSL syntax or other references to GLSL elements. Since WGSL is now the standard shading language for WebGPU, it would be beneficial to readers if these examples were presented first in WGSL. (Keeping the GLSL would still be helpful for new users arriving from WebGL.)
Relevant occurrences of the text "GLSL" in documentation as of commit c36eb9f44bd9462fe176fb859839592131428feb (just after 0.13.1):
Features::SAMPLED_TEXTURE_AND_STORAGE_BUFFER_ARRAY_NON_UNIFORM_INDEXINGFeatures::UNIFORM_BUFFER_AND_STORAGE_TEXTURE_ARRAY_NON_UNIFORM_INDEXINGBufferBindingTypeBindingTypeStorageTextureAccessTextureSampleTypeTextureViewDimension
Incomplete list (since it's hard to search for) of locations where the documentation refers to GLSL entities without even mentioning GLSL:
PipelineLayoutDescriptorrefers to "set = 0" which is GLSL syntax.BindingType::Texture::multisampledrefers to GLSL texture sampling functions.Features::TEXTURE_BINDING_ARRAYandBUFFER_BINDING_ARRAYhave GLSL examples.
Also possibly of interest: the following items mention something like “See the OpenGL specification” but are not about shading language per se and are mostly just declining to explain a topic:
BlendFactorBlendStateBindingType::StorageTextureSamplerBindingType
I can work on this.
Shouldn't this be closed now?
Maybe, though #2888 technically didn't address everything @kpreid mentioned; it was primarily additive and didn't remove or modify bits where GLSL or OpenGL are mentioned out of context, for example. Remaining items of interest are:
BindingType::Texture::multisampledBindingType::StorageTextureBlendFactorBlendStatePipelineLayoutDescriptorSamplerBindingType
And maybe more.