API reference

CanvasMesh Class

Extends MonoBehaviour
Dynamically creates and resizes a mesh to fit a Unity canvas.
There are two types of CanvasMesh components included in the Interaction SDK, <cref="CanvasCylinder" /> and <cref="CanvasRect" />.

Protected Fields

_canvasRenderTexture : CanvasRenderTexture
Mesh construction will be driven by this texture.
Signature 
CanvasRenderTexture _canvasRenderTexture
_meshCollider : MeshCollider
Optional mesh collider that will be driven.
Signature 
MeshCollider _meshCollider
_meshFilter : MeshFilter
The mesh filter that will be driven.
Signature 
MeshFilter _meshFilter
_started : bool
Signature 
bool _started

Protected Methods

GenerateMesh ( verts , tris , uvs )
Signature 
abstract void GenerateMesh(out List< Vector3 > verts, out List< int > tris, out List< Vector2 > uvs)
Parameters
verts: out List< Vector3 >
tris: out List< int >
uvs: out List< Vector2 >
Returns
abstract void
HandleUpdateRenderTexture ( texture )
Signature 
virtual void HandleUpdateRenderTexture(Texture texture)
Parameters
texture: Texture
Returns
void
MeshInverseTransform ( localPosition )
Signature 
abstract Vector3 MeshInverseTransform(Vector3 localPosition)
Parameters
localPosition: Vector3
Returns
abstract Vector3
OnDisable ()
Signature 
virtual void OnDisable()
Returns
void
OnEnable ()
Signature 
virtual void OnEnable()
Returns
void
Start ()
Signature 
virtual void Start()
Returns
void
UpdateImposter ()
Signature 
virtual void UpdateImposter()
Returns
void

Methods

ImposterToCanvasTransformPoint ( worldPosition )
Transform a position in world space relative to the imposter to an associated position relative to the original canvas in world space.
Signature 
Vector3 ImposterToCanvasTransformPoint(Vector3 worldPosition)
Parameters
worldPosition: Vector3
Returns
Vector3
InjectAllCanvasMesh ( canvasRenderTexture , meshFilter )
Signature 
void InjectAllCanvasMesh(CanvasRenderTexture canvasRenderTexture, MeshFilter meshFilter)
Parameters
canvasRenderTexture: CanvasRenderTexture
meshFilter: MeshFilter
Returns
void
InjectCanvasRenderTexture ( canvasRenderTexture )
Signature 
void InjectCanvasRenderTexture(CanvasRenderTexture canvasRenderTexture)
Parameters
canvasRenderTexture: CanvasRenderTexture
Returns
void
InjectMeshFilter ( meshFilter )
Signature 
void InjectMeshFilter(MeshFilter meshFilter)
Parameters
meshFilter: MeshFilter
Returns
void
InjectOptionalMeshCollider ( meshCollider )
Signature 
void InjectOptionalMeshCollider(MeshCollider meshCollider)
Parameters
meshCollider: MeshCollider
Returns
void
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta