computeBufferStartIndex | Offset in number of elements to which the write operation will occur |
count | Maximum number of elements which will be written |
NativeArray<T> A NativeArray of size count
Begins a write operation to the buffer
Use this to begin a write operation on the buffer. Using this method results in fewer memory copies than using ComputeBuffer.SetData, and is therefore faster. For compatibility reasons, you can only call this method on buffers where the ComputeBufferMode is ComputeBufferMode.SubUpdates. If you call this method on a buffer with a different ComputeBufferMode, Unity will throw an exception.
The returned native array points directly to GPU memory if possible. If it it not possible to write directly to GPU memory, the returned native array points to a temporary buffer in CPU memory. Whether it is possible to write directly to GPU memory depends on many factors, including buffer mode, active graphics device, and hardware support.
Because of this, the contents of the returned array are not guaranteed to reflect the data content of the GPU side buffer. You should therefore use the returned array only for writing to, and not for reading from.
When you have written to the array, call ComputeBuffer.EndWrite to complete the operation and mark the returned NativeArray as unusable.
The performance of this method will vary depending on whether it can write directly to GPU memory or not, but it will always result in fewer memory copies than using SetData.
The data written to the returned native array must follow the data layout rules of the graphics API in use. See Compute Shaders for cross-platform compatibility information.
See Also: ComputeBuffer.SetData, ComputeBuffer.EndWrite
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.