API reference

OVRCanvasMeshRenderer Class

Extends Oculus.Interaction.UnityCanvas.CanvasMeshRenderer
Uses OVROverlay to enable Underlay and Overlay rendering of a UI canvas.

Protected Fields

_canvasMesh : CanvasMesh
Signature 
CanvasMesh Oculus.Interaction.UnityCanvas.OVRCanvasMeshRenderer._canvasMesh
_enableSuperSampling : bool
Signature 
bool Oculus.Interaction.UnityCanvas.OVRCanvasMeshRenderer._enableSuperSampling
_overlay : OVROverlay
Signature 
OVROverlay Oculus.Interaction.UnityCanvas.OVRCanvasMeshRenderer._overlay
_runtimeOffset : Vector3
Signature 
Vector3 Oculus.Interaction.UnityCanvas.OVRCanvasMeshRenderer._runtimeOffset

Properties

ShouldUseOVROverlay : bool
[Get]
Signature 
bool Oculus.Interaction.UnityCanvas.OVRCanvasMeshRenderer.ShouldUseOVROverlay

Protected Methods

CreateChildObject ( name )
Signature 
GameObject Oculus.Interaction.UnityCanvas.OVRCanvasMeshRenderer.CreateChildObject(string name)
Parameters
name: string
Returns
GameObject
GetAlphaCutoutThreshold ()
Signature 
override float Oculus.Interaction.UnityCanvas.OVRCanvasMeshRenderer.GetAlphaCutoutThreshold()
Returns
override float
GetShaderName ()
Signature 
override string Oculus.Interaction.UnityCanvas.OVRCanvasMeshRenderer.GetShaderName()
Returns
override string
HandleUpdateRenderTexture ( texture )
Signature 
override void Oculus.Interaction.UnityCanvas.OVRCanvasMeshRenderer.HandleUpdateRenderTexture(Texture texture)
Parameters
texture: Texture
Returns
override void
Start ()
Signature 
override void Oculus.Interaction.UnityCanvas.OVRCanvasMeshRenderer.Start()
Returns
override void
UpdateOverlay ( texture )
Signature 
void Oculus.Interaction.UnityCanvas.OVRCanvasMeshRenderer.UpdateOverlay(Texture texture)
Parameters
texture: Texture
Returns
void

Methods

InjectAllOVRCanvasMeshRenderer ( canvasRenderTexture , meshRenderer , canvasMesh )
Signature 
void Oculus.Interaction.UnityCanvas.OVRCanvasMeshRenderer.InjectAllOVRCanvasMeshRenderer(CanvasRenderTexture canvasRenderTexture, MeshRenderer meshRenderer, CanvasMesh canvasMesh)
Parameters
canvasRenderTexture: CanvasRenderTexture
meshRenderer: MeshRenderer
canvasMesh: CanvasMesh
Returns
void
InjectCanvasMesh ( canvasMesh )
Signature 
void Oculus.Interaction.UnityCanvas.OVRCanvasMeshRenderer.InjectCanvasMesh(CanvasMesh canvasMesh)
Parameters
canvasMesh: CanvasMesh
Returns
void
InjectOptionalDoUnderlayAntiAliasing ( doUnderlayAntiAliasing )
Signature 
void Oculus.Interaction.UnityCanvas.OVRCanvasMeshRenderer.InjectOptionalDoUnderlayAntiAliasing(bool doUnderlayAntiAliasing)
Parameters
doUnderlayAntiAliasing: bool
Returns
void
InjectOptionalEnableSuperSampling ( enableSuperSampling )
Signature 
void Oculus.Interaction.UnityCanvas.OVRCanvasMeshRenderer.InjectOptionalEnableSuperSampling(bool enableSuperSampling)
Parameters
enableSuperSampling: bool
Returns
void
InjectOptionalRenderingMode ( ovrRenderingMode )
Signature 
void Oculus.Interaction.UnityCanvas.OVRCanvasMeshRenderer.InjectOptionalRenderingMode(OVRRenderingMode ovrRenderingMode)
Parameters
ovrRenderingMode: OVRRenderingMode
Returns
void

Inner Class

Properties Class

Static Fields

CanvasMesh : readonly string
Signature 
readonly string Oculus.Interaction.UnityCanvas.OVRCanvasMeshRenderer.Properties.CanvasMesh
CanvasRenderTexture : readonly string
Signature 
readonly string Oculus.Interaction.UnityCanvas.OVRCanvasMeshRenderer.Properties.CanvasRenderTexture
DoUnderlayAntiAliasing : readonly string
Signature 
readonly string Oculus.Interaction.UnityCanvas.OVRCanvasMeshRenderer.Properties.DoUnderlayAntiAliasing
EmulateWhileInEditor : readonly string
Signature 
readonly string Oculus.Interaction.UnityCanvas.OVRCanvasMeshRenderer.Properties.EmulateWhileInEditor
EnableSuperSampling : readonly string
Signature 
readonly string Oculus.Interaction.UnityCanvas.OVRCanvasMeshRenderer.Properties.EnableSuperSampling
RuntimeOffset : readonly string
Signature 
readonly string Oculus.Interaction.UnityCanvas.OVRCanvasMeshRenderer.Properties.RuntimeOffset
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta