Version: 2018.3 (switch to 2019.1b or 2017.4)
LanguageEnglish
  • C#

VertexHelper

class in UnityEngine.UI

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

Description

A utility class that can aid in the generation of meshes for the UI.

This class implements IDisposable to aid with memory management.

using UnityEngine;
using UnityEngine.UI;

public class ExampleClass : MonoBehaviour { Mesh m;

void Start() { Color32 color32 = Color.red; using (var vh = new VertexHelper()) { vh.AddVert(new Vector3(0, 0), color32, new Vector2(0f, 0f)); vh.AddVert(new Vector3(0, 100), color32, new Vector2(0f, 1f)); vh.AddVert(new Vector3(100, 100), color32, new Vector2(1f, 1f)); vh.AddVert(new Vector3(100, 0), color32, new Vector2(1f, 0f));

vh.AddTriangle(0, 1, 2); vh.AddTriangle(2, 3, 0); vh.FillMesh(m); } } }

Properties

currentIndexCountGet the number of indices set on the VertexHelper.
currentVertCountCurrent number of vertices in the buffer.

Public Methods

AddTriangleAdd a triangle to the buffer.
AddUIVertexQuadAdd a quad to the stream.
AddUIVertexStreamAdd a stream of custom UIVertex and corresponding indices.
AddUIVertexTriangleStreamAdd a list of triangles to the stream.
AddVertAdd a single vertex to the stream.
ClearClear all vertices from the stream.
DisposeCleanup allocated memory.
FillMeshFill the given mesh with the stream data.
GetUIVertexStreamCreate a stream of UI vertex (in triangles) from the stream.
PopulateUIVertexFill a UIVertex with data from index i of the stream.
SetUIVertexSet a UIVertex at the given index.

Did you find this page useful? Please give it a rating: