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

WebGPURenderer: Read/Write Only Storage Buffer Creation #28435

Merged
merged 30 commits into from
Jun 25, 2024

Conversation

cmhhelgeson
Copy link
Contributor

Re-do of pull request #28400 without pinging multiple people from an accidental merge commit.

@RenaudRohlinger
Copy link
Collaborator

As mentioned in #28400 I think it would be more interesting to add a more general API with an access mode property instead.

Storage Buffers are not the only type of ressources in WebGPU with an access property. For example GPUStorageTexture since Chrome r124 now includes this feature too:

enum GPUStorageTextureAccess {
    "write-only",
    "read-only",
    "read-write",
};

So storage,read-write would be the default for Storage Buffers (read-write access), read-only would be your newly introduced access mode and we can add in the same PR or a separate one read-only and read-write access to StorageTexture too.

@mrdoob mrdoob requested a review from sunag May 20, 2024 07:49
@sunag
Copy link
Collaborator

sunag commented May 20, 2024

What will we use write-only buffering for?

@cmhhelgeson
Copy link
Contributor Author

As mentioned in #28400 I think it would be more interesting to add a more general API with an access mode property instead.

Storage Buffers are not the only type of ressources in WebGPU with an access property. For example GPUStorageTexture since Chrome r124 now includes this feature too:

enum GPUStorageTextureAccess {
    "write-only",
    "read-only",
    "read-write",
};

So storage,read-write would be the default for Storage Buffers (read-write access), read-only would be your newly introduced access mode and we can add in the same PR or a separate one read-only and read-write access to StorageTexture too.

I can change the property in StorageBufferNode from readOnly to access, and assign GPUBufferBindingTypes to this new access property. For the case of storage buffers, I'm not sure how useful this would be given that there are currently only two relevant access types for storage buffers ('read-only' and 'read-write'), but it would align the code more closely with the relevant WGSL and WebGPU syntax.

Regarding texture access, I think that might be better tackled in a separate pull request. I'm personally not aware of all the considerations that would have to be made for texture access, but I think a good place to start would be providing similar functionality to StorageBufferNode that allows the user to explicitly specify that they would like the texture to be accessed in a read-only context. Perhaps we could also separate out the functionality from within textureStore that allows the user to pass a storage texture to a wgslFunction into its own function as well.

@RenaudRohlinger
Copy link
Collaborator

What will we use write-only buffering for?

Write-only buffering can be used to reduce bandwidth in deferred rendering, generate procedural content such as textures and landscapes, and for intermediate storage in GPGPU tasks.

We can continue using the readOnly attribute, but I am concerned about the upcoming PR that introduces writeOnly. How will it be integrated? Additionally, for GPUStorageTexture, an access property would be more logical. cc @sunag

but it would align the code more closely with the relevant WGSL and WebGPU syntax.

As mentioned here by @cmhhelgeson, I believe that this approach is more intuitive for developers since it matches what is sent to the shader and the correct binding properties. (storageTexture: { access: 'write-only' } } for example)

@sunag
Copy link
Collaborator

sunag commented May 21, 2024

I think we could follow this names bellow and the change for setAccess() in this PR. For other PR we can certainly do checks at the AssignNode, *ElementNode and any other TSL level.

export const storageReadOnly = ( value, type, count ) => storage( value, type, count ).setAccess( 'read' );
export const storageWriteOnly = ( value, type, count ) => storage( value, type, count ).setAccess( 'write' );

@cmhhelgeson
Copy link
Contributor Author

cmhhelgeson commented May 21, 2024

I think we could follow this names bellow and the change for setAccess() in this PR. For other PR we can certainly do checks at the AssignNode, *ElementNode and any other TSL level.

export const storageReadOnly = ( value, type, count ) => storage( value, type, count ).setAccess( 'read' );
export const storageWriteOnly = ( value, type, count ) => storage( value, type, count ).setAccess( 'write' );

I'll change the function in StorageBufferNode to setAccess, but is this comment referring to storage buffers or storage textures? According to the WebGPU Working Draft, storage buffers can not be created with the write-only modifier, only storage textures, so the name storageWriteOnly wouldn't be accurate to the storage buffers access restrictions.

EDIT: Although I suppose if write-only storage buffers do get implemented in a future pr, it wouldn't hurt to have the ability to specify it.

@cmhhelgeson
Copy link
Contributor Author

There's currently a discontinuity in the way I've architected this code versus the rest of the WebGPU code. I've currently set up the access property to take a value that corresponds to the WGSL syntax rather than the WebGPU syntax, with translation between WGSL shader syntax to WebGPU binding syntax occurring within WebGPUBindingUtils.ts. When I get the chance, I'll re-edit the code to have it better match the existing architecture.

cmhhelgeson and others added 4 commits June 9, 2024 15:22
…ilder, added considerations for hypothetical write-only buffer access mode mentioned in PR conversation, added readOnly and writeOnly commands for creating a storageObject
@cmhhelgeson
Copy link
Contributor Author

@sunag Is there anything else I should do for this pull request in terms of formatting and syntax?

@sunag sunag added this to the r166 milestone Jun 20, 2024
@sunag sunag changed the title WebGPURenderer: Read Only Storage Buffer Creation WebGPURenderer: Read/Write Only Storage Buffer Creation Jun 25, 2024
@sunag sunag merged commit 0d5e6d6 into mrdoob:dev Jun 25, 2024
11 checks passed
@cmhhelgeson cmhhelgeson deleted the webgpu_readonly_storage_branch branch July 15, 2024 17:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants