Class VignetteParameters

Represents the parameters to control the tunneling vignette material and customize its effects.

Inheritance

object

VignetteParameters

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: UnityEngine.XR.Interaction.Toolkit

Assembly: solution.dll

Syntax

[Serializable]
public sealed class VignetteParameters

Remarks

TunnelingVignetteController, ITunnelingVignetteProvider, LocomotionVignetteProvider

Properties

Name	Description
apertureSize	The diameter of the inner transparent circle of the tunneling vignette.
apertureVerticalPosition	The vertical position offset of the vignette. Changing this value will change the local y-position of the GameObject that this script is attached to.
easeInTime	The transition time (in seconds) of easing in the tunneling vignette. Set this to a non-zero value to reduce the potential distraction from instantaneously changing the user's field of view when beginning the vignette.
easeInTimeLock	Persists the easing-in transition until it is complete. Enable this option if you want the easing-in transition to persist until it is complete. This can be useful for instant changes, such as snap turn and teleportation, to trigger the full tunneling effect without easing out the vignette partway through the easing in process.
easeOutDelayTime	The delay time (in seconds) before starting to ease out of the tunneling vignette.
easeOutTime	The transition time (in seconds) of easing out the tunneling vignette. Set this to a non-zero value to reduce the potential distraction from instantaneously changing the user's field of view when ending the vignette.
featheringEffect	The degree of smoothly blending the edges between the aperture and full visual cut-off. Set this to a non-zero value to add a gradual transition from the transparent aperture to the black vignette edges.
vignetteColor	The primary color of the visual cut-off area of the vignette.
vignetteColorBlend	The optional color to add color blending to the visual cut-off area of the vignette.

Methods

Name	Description
CopyFrom(VignetteParameters)	Copies the parameter values from the given VignetteParameters.