API reference

CanvasMeshRenderer Class

Extends MonoBehaviour
Maps a RenderTexture to a Mesh Renderer.
There are two types of CanvasRenderer components included in the Interaction SDK, CanvasMeshRenderer and OVRCanvasMeshRenderer.

Protected Fields

_canvasRenderTexture : CanvasRenderTexture
The canvas texture that will be rendered.
Signature 
CanvasRenderTexture _canvasRenderTexture
_material : Material
Signature 
Material _material
_meshRenderer : MeshRenderer
The mesh renderer that will be driven.
Signature 
MeshRenderer _meshRenderer
_renderingMode : int
Determines the shader used for rendering.
For details on these rendering modes, see https://developer.oculus.com/documentation/unity/unity-isdk-curved-canvases/#rendermodes.
Signature 
int _renderingMode
_started : bool
Signature 
bool _started

Protected Methods

GetAlphaCutoutThreshold ()
Signature 
virtual float GetAlphaCutoutThreshold()
Returns
float
GetShaderName ()
Signature 
virtual string GetShaderName()
Returns
string
HandleUpdateRenderTexture ( texture )
Signature 
virtual void HandleUpdateRenderTexture(Texture texture)
Parameters
texture: Texture
Returns
void
OnDisable ()
Signature 
virtual void OnDisable()
Returns
void
OnEnable ()
Signature 
virtual void OnEnable()
Returns
void
SetAdditionalProperties ( block )
Signature 
virtual void SetAdditionalProperties(MaterialPropertyBlock block)
Parameters
block: MaterialPropertyBlock
Returns
void
Start ()
Signature 
virtual void Start()
Returns
void

Methods

InjectAllCanvasMeshRenderer ( canvasRenderTexture , meshRenderer )
Signature 
void InjectAllCanvasMeshRenderer(CanvasRenderTexture canvasRenderTexture, MeshRenderer meshRenderer)
Parameters
canvasRenderTexture: CanvasRenderTexture
meshRenderer: MeshRenderer
Returns
void
InjectCanvasRenderTexture ( canvasRenderTexture )
Signature 
void InjectCanvasRenderTexture(CanvasRenderTexture canvasRenderTexture)
Parameters
canvasRenderTexture: CanvasRenderTexture
Returns
void
InjectMeshRenderer ( meshRenderer )
Signature 
void InjectMeshRenderer(MeshRenderer meshRenderer)
Parameters
meshRenderer: MeshRenderer
Returns
void
InjectOptionalAlphaCutoutThreshold ( alphaCutoutThreshold )
Signature 
void InjectOptionalAlphaCutoutThreshold(float alphaCutoutThreshold)
Parameters
alphaCutoutThreshold: float
Returns
void
InjectOptionalRenderingMode ( renderingMode )
Signature 
void InjectOptionalRenderingMode(RenderingMode renderingMode)
Parameters
renderingMode: RenderingMode
Returns
void
InjectOptionalUseAlphaToMask ( useAlphaToMask )
Signature 
void InjectOptionalUseAlphaToMask(bool useAlphaToMask)
Parameters
useAlphaToMask: bool
Returns
void

Inner Class

Properties Class

Static Fields

AlphaCutoutThreshold : readonly string
Signature 
readonly string AlphaCutoutThreshold
RenderingMode : readonly string
Signature 
readonly string RenderingMode
UseAlphaToMask : readonly string
Signature 
readonly string UseAlphaToMask
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta