API reference

ComfortVignetteSetting Class

Extends MonoBehaviour
Controls the vignette strength based on locomotion events (turning, acceleration, movement).
Applies the appropriate AnimationCurve to the tunneling component based on comfort level.

Protected Fields

_started : bool
Signature 
bool Oculus.Interaction.Locomotion.ComfortVignetteSetting._started

Fields

ComfortLevel : ReactiveValue< ComfortAssistance >
Vignette intensity level for motion comfort.
Signature 
ReactiveValue<ComfortAssistance> Oculus.Interaction.Locomotion.ComfortVignetteSetting.ComfortLevel

Properties

Comfort : ComfortType
[Get][Set]
Type of movement that triggers the vignette effect.
Signature 
ComfortType Oculus.Interaction.Locomotion.ComfortVignetteSetting.Comfort

Protected Methods

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

Methods

InjectOptionalCurveHigh ( curveHigh )
Signature 
void Oculus.Interaction.Locomotion.ComfortVignetteSetting.InjectOptionalCurveHigh(AnimationCurve curveHigh)
Parameters
curveHigh: AnimationCurve
Returns
void
InjectOptionalCurveLow ( curveLow )
Signature 
void Oculus.Interaction.Locomotion.ComfortVignetteSetting.InjectOptionalCurveLow(AnimationCurve curveLow)
Parameters
curveLow: AnimationCurve
Returns
void
InjectOptionalCurveMedium ( curveMedium )
Signature 
void Oculus.Interaction.Locomotion.ComfortVignetteSetting.InjectOptionalCurveMedium(AnimationCurve curveMedium)
Parameters
curveMedium: AnimationCurve
Returns
void
InjectOptionalCurveOff ( curveOff )
Signature 
void Oculus.Interaction.Locomotion.ComfortVignetteSetting.InjectOptionalCurveOff(AnimationCurve curveOff)
Parameters
curveOff: AnimationCurve
Returns
void
InjectOptionalTunneling ( tunneling )
Signature 
void Oculus.Interaction.Locomotion.ComfortVignetteSetting.InjectOptionalTunneling(LocomotionTunneling tunneling)
Parameters
tunneling: LocomotionTunneling
Returns
void

Inner Enums

ComfortType Enum

Types of movement that trigger the comfort vignette.

Enumeration Constants

Member
Turning
Accelerating
Moving

ComfortAssistance Enum

Intensity levels for the comfort vignette effect.

Enumeration Constants

MemberValue
Off
0
Low
1
Medium
2
High
3
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta