Version: Unity 6.2 (6000.2)
LanguageEnglish
  • C#

Mesh.vertexBufferTarget

Suggest a change

Success!

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.

Close

Submission failed

For 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.

Close

Cancel

Switch to Manual
public GraphicsBuffer.Target vertexBufferTarget;

Description

The intended target usage of the Mesh GPU vertex buffer.

By default, Mesh vertex buffers have GraphicsBuffer.Target.Vertex usage target. If you want to access the mesh vertex buffer from a compute shader, additional targets need to be requested, for example GraphicsBuffer.Target.Raw.

When setting this property to a new value, Unity destroys the existing buffer, and creates a new buffer with the specified target. In order for the new buffer to be correctly populated with data, the mesh data must reside on the CPU. You can check the Mesh.isReadable property to determine whether the mesh data is accessible on the CPU.

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(); } }

Additional resources: Target, GetVertexBuffer, indexBufferTarget.