Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
ClosenameID | The ID of the property name for the constant buffer in shader code. Use Shader.PropertyToID to get this ID. |
name | The name of the buffer to bind as constant buffer. |
buffer | The buffer to bind as constant buffer. |
offset | The offset in bytes from the beginning of the ComputeBuffer to bind. Must be a multiple of SystemInfo.constantBufferOffsetAlignment, or 0 if that value is 0. |
size | The number of bytes to bind. |
Sets a ComputeBuffer or GraphicsBuffer as a named constant buffer for the ComputeShader.
You can use this method to override all of the parameters in a compute shader constant buffer with the contents of a ComputeBuffer or GraphicsBuffer.
To use this method, the following must be true:
If the above conditions are not met, the buffer might not be bound correctly and so regular parameters will be picked up. Alternatively visual artifacts might occur.
The data layout of the constant buffer may be different depending on the graphics API. This means SetConstantBuffer
might overwrite data or set variables to the wrong values. See Writing shaders for different graphics APIs for more information.
After this function has been called with a non-null ComputeBuffer or GraphicsBuffer, you can no longer manually set the value of a variable inside the overridden constant buffer. Calls to ComputeShader.SetFloat and similar where the given property name ID points to a variable inside the overridden constant buffer will have no effect.
Constant buffers are bound to all kernels in a ComputeShader.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.