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

TunnelingEffect Class

Extends MonoBehaviour
This component draws a vignette at a cameara's near plane.
The direction of the vignette can be controller, it does not need to necesarily centered and can even point backwards to draw a solid circle.

Protected Fields

_started : bool
Signature 
bool Oculus.Interaction.TunnelingEffect._started

Properties

AimingDirection : Vector3
[Get][Set]
Signature 
Vector3 Oculus.Interaction.TunnelingEffect.AimingDirection
AlphaStrength : float
[Get][Set]
Signature 
float Oculus.Interaction.TunnelingEffect.AlphaStrength
ExtraFeatheredFOV : float
[Get][Set]
Signature 
float Oculus.Interaction.TunnelingEffect.ExtraFeatheredFOV
MaskInnerColor : Color
[Get][Set]
Signature 
Color Oculus.Interaction.TunnelingEffect.MaskInnerColor
MaskOuterColor : Color
[Get][Set]
Signature 
Color Oculus.Interaction.TunnelingEffect.MaskOuterColor
PlaneDistance : float
[Get][Set]
Signature 
float Oculus.Interaction.TunnelingEffect.PlaneDistance
UseAimingTarget : bool
[Get][Set]
Signature 
bool Oculus.Interaction.TunnelingEffect.UseAimingTarget
UserFOV : float
[Get][Set]
Signature 
float Oculus.Interaction.TunnelingEffect.UserFOV

Protected Methods

OnDisable ()
Signature 
virtual void Oculus.Interaction.TunnelingEffect.OnDisable()
Returns
void
OnEnable ()
Signature 
virtual void Oculus.Interaction.TunnelingEffect.OnEnable()
Returns
void
Start ()
Signature 
virtual void Oculus.Interaction.TunnelingEffect.Start()
Returns
void

Methods

InjectAllTunnelingEffect ( leftEyeAnchor , rightEyeAnchor , centerEyeCamera , meshFilter )
Signature 
void Oculus.Interaction.TunnelingEffect.InjectAllTunnelingEffect(Transform leftEyeAnchor, Transform rightEyeAnchor, Camera centerEyeCamera, MeshFilter meshFilter)
Parameters
leftEyeAnchor: Transform
rightEyeAnchor: Transform
centerEyeCamera: Camera
meshFilter: MeshFilter
Returns
void
InjectCenterEyeCamera ( centerEyeCamera )
Signature 
void Oculus.Interaction.TunnelingEffect.InjectCenterEyeCamera(Camera centerEyeCamera)
Parameters
centerEyeCamera: Camera
Returns
void
InjectLeftEyeAnchor ( leftEyeAnchor )
Signature 
void Oculus.Interaction.TunnelingEffect.InjectLeftEyeAnchor(Transform leftEyeAnchor)
Parameters
leftEyeAnchor: Transform
Returns
void
InjectMeshFilter ( meshFilter )
Signature 
void Oculus.Interaction.TunnelingEffect.InjectMeshFilter(MeshFilter meshFilter)
Parameters
meshFilter: MeshFilter
Returns
void
InjectRightEyeAnchor ( rightEyeAnchor )
Signature 
void Oculus.Interaction.TunnelingEffect.InjectRightEyeAnchor(Transform rightEyeAnchor)
Parameters
rightEyeAnchor: Transform
Returns
void
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta