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

OVROverlayCanvas Class

Extends OVRRayTransformer

Fields

curveRadius : float
Signature 
float curveRadius
expensive : bool
Signature 
bool expensive
layer : int
Signature 
int layer
maxTextureSize : int
Signature 
int maxTextureSize
opacity : DrawMode
Signature 
DrawMode opacity
overlapMask : bool
Signature 
bool overlapMask
renderInterval : int
Signature 
int renderInterval
renderIntervalFrameOffset : int
Signature 
int renderIntervalFrameOffset
shape : CanvasShape
Signature 
CanvasShape shape

Properties

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

Protected Methods

ShouldRender ()
Signature 
virtual bool ShouldRender()
Returns
bool

Methods

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

Inner Enums

DrawMode Enum

Enumeration Constants

Member
Opaque
OpaqueWithClip
TransparentDefaultAlpha
TransparentCorrectAlpha
AlphaToMask

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