Fades the screen from black after a new scene is loaded. Fade can also be controlled mid-scene using SetUIFade and SetFadeLevel More...

Inheritance diagram for OVRScreenFade:

Public Member Functions
void	FadeIn ()
	Start a fade in More...

void	FadeOut ()
	Start a fade out More...

void	SetUIFade (float level)
	Set the UI fade level - fade due to UI in foreground More...

void	SetExplicitFade (float level)
	Override current fade level More...

Public Attributes
float	fadeTime = 2.0f

Color	fadeColor = new Color(0.01f, 0.01f, 0.01f, 1.0f)

bool	fadeOnStart = true

int	renderQueue = 5000
	The render queue used by the fade mesh. Reduce this if you need to render on top of it. More...

Properties
static OVRScreenFade	instance `[get]`

float	currentAlpha `[get]`
	Renders the current alpha value being used to fade the screen. More...

Detailed Description

Fades the screen from black after a new scene is loaded. Fade can also be controlled mid-scene using SetUIFade and SetFadeLevel

Member Function Documentation

◆ FadeIn()

void OVRScreenFade.FadeIn ( )

Start a fade in

◆ FadeOut()

void OVRScreenFade.FadeOut ( )

Start a fade out

◆ SetExplicitFade()

void OVRScreenFade.SetExplicitFade ( float level )

Override current fade level

Parameters

level

◆ SetUIFade()

void OVRScreenFade.SetUIFade ( float level )

Set the UI fade level - fade due to UI in foreground

Member Data Documentation

◆ fadeColor

Color OVRScreenFade.fadeColor = new Color(0.01f, 0.01f, 0.01f, 1.0f)

◆ fadeOnStart

bool OVRScreenFade.fadeOnStart = true

◆ fadeTime

float OVRScreenFade.fadeTime = 2.0f

◆ renderQueue

int OVRScreenFade.renderQueue = 5000

The render queue used by the fade mesh. Reduce this if you need to render on top of it.

Property Documentation

◆ currentAlpha

float OVRScreenFade.currentAlpha

get

Renders the current alpha value being used to fade the screen.

◆ instance

OVRScreenFade OVRScreenFade.instance

staticget

The documentation for this class was generated from the following file:

Oculus/VR/Scripts/Util/OVRScreenFade.cs

Public Member Functions

Public Attributes

Properties