index | Vertex data stream index to get the buffer for. |
GraphicsBuffer The mesh vertex buffer as a GraphicsBuffer.
Retrieves a GraphicsBuffer that provides direct acces to the GPU vertex buffer.
Most of the Mesh
methods work on a CPU copy of the mesh data, which Unity then uploads to the GPU. For
example, SetIndexBufferData modifies CPU copy of the data, and UploadMeshData sends the CPU copy of the data to the GPU.
You can access the GPU copy of the vertex buffer directly using GetVertexBuff
. This allows more direct manipulation of the mesh index data on the GPU, which can potentially improve performance. However, any modifications that you make to the index data this way will not be reflected in the CPU copy of the mesh data.
You can also use this method to make the vertex buffer available for reading or writing in a ComputeShader. To do that, first request an appropriate buffer binding target via vertexBufferTarget, then get the mesh data using GetVertexBuffer
, and then set it up as a parameter for your shaders using ComputeBuffer.SetBuffer, Material.SetBuffer and similar methods.
GetVertexBufferStride, GetVertexAttributeOffset and related methods can be used to query the exact mesh
vertex data layout and format, so that the compute shader can access it properly.
If you modify the CPU copy of the data, this can cause the GPU vertex buffers to be re-created; in that case, you must call GetVertexBuffer
again.
using UnityEngine;
public class ExampleScript : MonoBehaviour { public Mesh mesh; public ComputeShader computeShader; void Start() { // Mark the vertex buffer as needing "Raw" // (ByteAddressBuffer, RWByteAddressBuffer in HLSL shaders) // access. mesh.vertexBufferTarget |= GraphicsBuffer.Target.Raw; // Get the vertex buffer of the Mesh, and set it up // as a buffer parameter to a compute shader. var vertexBuffer = mesh.GetVertexBuffer(0); computeShader.SetBuffer(0, "MeshVertexBuffer", vertexBuffer); vertexBuffer.Dispose(); } }
See Also: GetIndexBuffer, vertexBufferTarget.
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.