API reference
API reference
Select your platform
No SDKs available
No versions available

OVROverlayCanvas Class

Extends OVRRayTransformer

Fields

curveRadius : float
Signature 
float OVROverlayCanvas.curveRadius
expensive : bool
Signature 
bool OVROverlayCanvas.expensive
layer : int
Signature 
int OVROverlayCanvas.layer
maxTextureSize : int
Signature 
int OVROverlayCanvas.maxTextureSize
opacity : DrawMode
Signature 
DrawMode OVROverlayCanvas.opacity
overrideDefaultCanvasMaterial : bool
Signature 
bool OVROverlayCanvas.overrideDefaultCanvasMaterial
renderInterval : int
Signature 
int OVROverlayCanvas.renderInterval
renderIntervalFrameOffset : int
Signature 
int OVROverlayCanvas.renderIntervalFrameOffset
shape : CanvasShape
Signature 
CanvasShape OVROverlayCanvas.shape

Properties

overlayEnabled : bool
[Get][Set]
Signature 
bool OVROverlayCanvas.overlayEnabled

Protected Methods

ShouldRender ()
Signature 
virtual bool OVROverlayCanvas.ShouldRender()
Returns
bool

Methods

TransformRay ( ray )
Signature 
override Ray OVROverlayCanvas.TransformRay(Ray ray)
Parameters
ray: Ray
Returns
override Ray

Inner Enums

DrawMode Enum

Enumeration Constants

Member
Opaque
OpaqueWithClip
TransparentDefaultAlpha
TransparentCorrectAlpha

CanvasShape Enum

Enumeration Constants

Member
Flat
Curved
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta