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

OVROverlayCanvas Class

Fields

curveRadius : float
Signature
float curveRadius
expensive : bool
Signature
bool expensive
layer : int
Signature
int layer
manualRedraw : bool
Signature
bool manualRedraw
maxTextureSize : int
Signature
int maxTextureSize
opacity : DrawMode
Signature
DrawMode opacity
overlapMask : bool
Signature
bool overlapMask
Signature
OVROverlay.OverlayType overlayType
rectTransform : RectTransform
Signature
RectTransform rectTransform
renderInterval : int
Signature
int renderInterval
renderIntervalFrameOffset : int
Signature
int renderIntervalFrameOffset
shape : CanvasShape
Signature
CanvasShape shape

Properties

IsCanvasPriority : bool
[Get]
Signature
virtual bool IsCanvasPriority
Overlay : OVROverlay
[Get]
Signature
OVROverlay Overlay
overlayEnabled : bool
[Get][Set]
Signature
bool overlayEnabled
ShouldShowImposter : bool
[Get]
Signature
bool ShouldShowImposter

Protected Methods

ShouldRender ()
Signature
virtual bool ShouldRender()
Returns
bool

Methods

GetViewPriorityScore ()
Signature
float? GetViewPriorityScore()
Returns
float?
SetCanvasLayer ( layer , forceUpdate )
Signature
void SetCanvasLayer(int layer, bool forceUpdate)
Parameters
layer: int
forceUpdate: bool
Returns
void
SetFrameDirty ()
Signature
void SetFrameDirty()
Returns
void
TransformRay ( ray )
Signature
override Ray TransformRay(Ray ray)
Parameters
ray: Ray
Returns
override Ray
UpdateOverlaySettings ()
Signature
void UpdateOverlaySettings()
Returns
void

Inner Struct

ScopedCallback Struct

Extends IDisposable

Events

OnDispose : Action
Signature
Action OnDispose

Methods

Dispose ()
Signature
void IDisposable. Dispose()
Returns
void IDisposable.

Inner Enums

DrawMode Enum

Enumeration Constants

MemberValue
Opaque
0
OpaqueWithClip
1
Transparent
2
TransparentDefaultAlpha
2
TransparentCorrectAlpha
3
AlphaToMask
4

CanvasShape Enum

Enumeration Constants

Member
Flat
Curved