Skip to content

Commit

Permalink
show/remove default properties of bindGroupLayoutDescriptor entries
Browse files Browse the repository at this point in the history
  • Loading branch information
@greggman
greggman committed Jul 1, 2024
1 parent 7128d8d commit d93cf1b
Show file tree
Hide file tree
Showing 3 changed files with 226 additions and 8 deletions.
163 changes: 158 additions & 5 deletions test/tests/data-byte-diagram-tests.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ describe('data-byte-diagram-tests', () => {

describe('bind group layouts', () => {

it('handles storage textures', () => {
it('handles various types (no defaults)', () => {
const shader = `
@group(0) @binding(2) var tex2d: texture_2d<f32>;
@group(0) @binding(1) var texMS2d: texture_multisampled_2d<f32>;
Expand Down Expand Up @@ -193,8 +193,151 @@ describe('data-byte-diagram-tests', () => {
const defs = makeShaderDataDefinitions(shader);
const js = makeBindGroupLayoutDescriptorsJS(defs, {
compute: { entryPoint: 'cs' },
}, {
keepDefaults: false,
});
const expected = `[
{
entries: [
{
binding: 0,
visibility: GPUShaderStage.COMPUTE,
texture: {
sampleType: "depth",
},
},
{
binding: 1,
visibility: GPUShaderStage.COMPUTE,
texture: {
multisampled: true,
},
},
{
binding: 2,
visibility: GPUShaderStage.COMPUTE,
texture: {},
},
{
binding: 3,
visibility: GPUShaderStage.COMPUTE,
sampler: {},
},
{
binding: 4,
visibility: GPUShaderStage.COMPUTE,
sampler: {
type: "comparison",
},
},
{
binding: 5,
visibility: GPUShaderStage.COMPUTE,
externalTexture: {},
},
],
},
{
entries: [
{
binding: 0,
visibility: GPUShaderStage.COMPUTE,
buffer: {},
},
{
binding: 1,
visibility: GPUShaderStage.COMPUTE,
buffer: {
type: "read-only-storage",
},
},
{
binding: 2,
visibility: GPUShaderStage.COMPUTE,
buffer: {
type: "read-only-storage",
},
},
{
binding: 3,
visibility: GPUShaderStage.COMPUTE,
buffer: {
type: "storage",
},
},
],
},
{
entries: [],
},
{
entries: [
{
binding: 0,
visibility: GPUShaderStage.COMPUTE,
storageTexture: {
access: "read-only",
format: "rgba8unorm",
},
},
{
binding: 1,
visibility: GPUShaderStage.COMPUTE,
storageTexture: {
format: "rgba32float",
},
},
{
binding: 2,
visibility: GPUShaderStage.COMPUTE,
storageTexture: {
access: "read-write",
format: "rgba16uint",
},
},
],
},
]`;
assertEqual(js, expected);
});

it('handles various types (with defaults)', () => {
const shader = `
@group(0) @binding(2) var tex2d: texture_2d<f32>;
@group(0) @binding(1) var texMS2d: texture_multisampled_2d<f32>;
@group(0) @binding(0) var texDepth: texture_depth_2d;
@group(0) @binding(3) var samp: sampler;
@group(0) @binding(4) var sampC: sampler_comparison;
@group(0) @binding(5) var texExt: texture_external;
@group(1) @binding(0) var<uniform> u: mat4x4f;
@group(1) @binding(1) var<storage> s: mat4x4f;
@group(1) @binding(2) var<storage, read> sr: mat4x4f;
@group(1) @binding(3) var<storage, read_write> srw: mat4x4f;
@group(3) @binding(0) var tsR: texture_storage_2d<rgba8unorm, read>;
@group(3) @binding(1) var tsW: texture_storage_2d<rgba32float, write>;
@group(3) @binding(2) var tsRW: texture_storage_2d<rgba16uint, read_write>;
@compute @workgroup_size(1) fn cs() {
_ = tex2d;
_ = texMS2d;
_ = texDepth;
_ = samp;
_ = sampC;
_ = texExt;
_ = u;
_ = s;
_ = sr;
_ = srw;
_ = tsR;
_ = tsW;
_ = tsRW;
}
`;

const defs = makeShaderDataDefinitions(shader);
const js = makeBindGroupLayoutDescriptorsJS(defs, {
compute: { entryPoint: 'cs' },
}, { keepDefaults: true });
const expected = `[
{
entries: [
{
Expand Down Expand Up @@ -250,27 +393,37 @@ describe('data-byte-diagram-tests', () => {
{
binding: 0,
visibility: GPUShaderStage.COMPUTE,
buffer: {},
buffer: {
type: "uniform",
hasDynamicOffset: false,
minBindingSize: 0,
},
},
{
binding: 1,
visibility: GPUShaderStage.COMPUTE,
buffer: {
type: "read-only-storage",
hasDynamicOffset: false,
minBindingSize: 0,
},
},
{
binding: 2,
visibility: GPUShaderStage.COMPUTE,
buffer: {
type: "read-only-storage",
hasDynamicOffset: false,
minBindingSize: 0,
},
},
{
binding: 3,
visibility: GPUShaderStage.COMPUTE,
buffer: {
type: "storage",
hasDynamicOffset: false,
minBindingSize: 0,
},
},
],
Expand All @@ -285,26 +438,26 @@ describe('data-byte-diagram-tests', () => {
visibility: GPUShaderStage.COMPUTE,
storageTexture: {
access: "read-only",
format: "rgba8unorm",
viewDimension: "2d",
format: "rgba8unorm",
},
},
{
binding: 1,
visibility: GPUShaderStage.COMPUTE,
storageTexture: {
access: "write-only",
format: "rgba32float",
viewDimension: "2d",
format: "rgba32float",
},
},
{
binding: 2,
visibility: GPUShaderStage.COMPUTE,
storageTexture: {
access: "read-write",
format: "rgba16uint",
viewDimension: "2d",
format: "rgba16uint",
},
},
],
Expand Down
63 changes: 60 additions & 3 deletions webgpu/lessons/resources/data-byte-diagram.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -369,8 +369,64 @@ return (key === 'visibility')
: value;
}

function bindGroupLayoutDescriptorsToString(bindGroupLayoutDescriptors) {
return JSON.stringify(bindGroupLayoutDescriptors, stringifyBindGroupLayoutDescriptor, 2)
const bindingEntryDefaults = {
buffer: {
type: 'uniform',
hasDynamicOffset: false,
minBindingSize: 0,
},
sampler: {
type: 'filtering',
},
texture: {
sampleType: 'float',
viewDimension: '2d',
multisampled: false,
},
storageTexture: {
access: 'write-only',
viewDimension: '2d',
},
externalTexture: {},
};

function removeDefaultsFromBindGroupLayoutEntry(entry) {
return Object.fromEntries(Object.entries(entry).map(([k, v]) => {
const defaults = bindingEntryDefaults[k];
if (defaults) {
v = Object.fromEntries(Object.entries(v).filter(([k, v]) => v !== defaults[k]));
}
return [k, v];
}));
}

function removeDefaults(bindGroupLayoutDescriptor) {
return {
...bindGroupLayoutDescriptor,
entries: bindGroupLayoutDescriptor.entries.map(removeDefaultsFromBindGroupLayoutEntry),
};
}

function addDefaultsFromBindGroupLayoutEntry(entry) {
return Object.fromEntries(Object.entries(entry).map(([k, v]) => {
const defaults = bindingEntryDefaults[k];
if (defaults) {
v = { ...defaults, ...v };
}
return [k, v];
}));
}

function addDefaults(bindGroupLayoutDescriptor) {
return {
...bindGroupLayoutDescriptor,
entries: bindGroupLayoutDescriptor.entries.map(addDefaultsFromBindGroupLayoutEntry),
};
}

function bindGroupLayoutDescriptorsToString(bindGroupLayoutDescriptors, options) {
const noDefaultsBindGroupLayoutDescriptors = bindGroupLayoutDescriptors.map(options.keepDefaults ? addDefaults : removeDefaults);
return JSON.stringify(noDefaultsBindGroupLayoutDescriptors, stringifyBindGroupLayoutDescriptor, 2)
.replace(/"(\w+)":/g, '$1:') // "key": value -> key: value
.replace(/(}|\]|"|\d|\w)\n/g, '$1,\n') // add trailing commas
.replace(/"(GPUS.*?)"/g, '$1') // remove quotes from GPUShaderStage
Expand All @@ -380,6 +436,7 @@ return JSON.stringify(bindGroupLayoutDescriptors, stringifyBindGroupLayoutDescri
export function makeBindGroupLayoutDescriptorsJS(
defs/*: ShaderDataDefinitions | ShaderDataDefinitions[]*/,
desc/*: PipelineDescriptor*/,
options = {},
) {
return bindGroupLayoutDescriptorsToString(makeBindGroupLayoutDescriptors(defs, desc));
return bindGroupLayoutDescriptorsToString(makeBindGroupLayoutDescriptors(defs, desc), options);
}
8 changes: 8 additions & 0 deletions webgpu/lessons/resources/wgsl-offset-computer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,7 @@
</div>
<div>
<label><input id="bindGroupLayouts" type="checkbox" value="bindGroupLayouts" checked>show bindGroupLayouts</label>
<label><input id="bindGroupLayoutDefaults" type="checkbox" value="bindGroupLayoutDefaults" checked>show defaults</label>
</div>
<div>
<button type="button" id="process">Process</button>
Expand Down Expand Up @@ -411,6 +412,7 @@ <h1>WGSL Offset Computer</h1>
const flattenElem = document.querySelector('#flatten');
const numElementsElem = document.querySelector('#numElements');
const bindGroupLayoutsElem = document.querySelector('#bindGroupLayouts');
const bindGroupLayoutDefaultsElem = document.querySelector('#bindGroupLayoutDefaults');
const helpElem = document.querySelector('#help');
const docsElem = document.querySelector('#docs');
const globals = {};
Expand Down Expand Up @@ -460,6 +462,7 @@ <h1>WGSL Offset Computer</h1>
flatten: flattenElem.checked,
numElements: numElementsElem.value,
bindGroupLayouts: bindGroupLayoutsElem.checked,
bindGroupLayoutsElem: bindGroupLayoutDefaultsElem.checked,
});
compressor.compress(save, 1, function(bytes) {
const hex = convertBytesToHex(bytes);
Expand Down Expand Up @@ -515,6 +518,8 @@ <h1>WGSL Offset Computer</h1>
const js = makeBindGroupLayoutDescriptorsJS(defs, {
vertex: { entryPoint: vsEntryPoints[0].name },
fragment: { entryPoint: fsEntryPoints[0].name },
}, {
keepDefaults: bindGroupLayoutDefaultsElem.checked,
});
epLines.push(`const bindGroupLayoutDescriptors = ${js};`);
} else {
Expand All @@ -531,6 +536,8 @@ <h1>WGSL Offset Computer</h1>
for (const {name} of csEntryPoints) {
const js = makeBindGroupLayoutDescriptorsJS(defs, {
compute: { entryPoint: name },
}, {
keepDefaults: bindGroupLayoutDefaultsElem.checked,
});
epLines.push(`const ${name}BindGroupLayoutDescriptors = ${js};`);
}
Expand Down Expand Up @@ -600,6 +607,7 @@ <h1>WGSL Offset Computer</h1>
styleElem.checked = true;
}
bindGroupLayoutsElem.checked = !(data.bindGroupLayouts === false);
bindGroupLayoutDefaultsElem.checked = !(data.bindGroupLayoutDefaults === false);
editor.setValue(data.x);
resolve();
},
Expand Down

0 comments on commit d93cf1b

Please sign in to comment.