This website uses cookies to improve our services and deliver relevant ads.
By interacting with this site, you agree to this use. For more information, see our Cookies Policy

Unity 1.25 Reference Guide

OVRScreenFade Class Reference

Fades the screen from black after a new scene is loaded.

MonoBehaviour inherited by OVRScreenFade.

Data Fields

float	fadeTime ( )
Color	fadeColor ( )
bool	fadeOnStart ( )

Private Data Fields

float	uiFadeAlpha ( )
MeshRenderer	fadeRenderer ( )
MeshFilter	fadeMesh ( )
Material	fadeMaterial ( )
bool	isFading ( )

Properties

float

currentAlpha ( ) [Get]

Private Member Functions

void	Awake ( )
void	OnLevelFinishedLoading ( int level ) Starts a fade in when a new level is loaded
void	Start ( ) Automatically starts a fade in
void	OnEnable ( )
void	OnDestroy ( ) Cleans up the fade material
IEnumerator	Fade ( float startAlpha, float endAlpha ) Fades alpha from 1.0 to 0.0
void	SetMaterialAlpha ( ) Update material alpha.

Public Member Functions

void	FadeOut ( ) Start a fade out
void	SetUIFade ( float level ) Set the UI fade level - fade due to UI in foreground
void	SetFadeLevel ( float level ) Override current fade level

Detailed Description

Fade can also be controlled mid-scene using SetUIFade and SetFadeLevel

Field Documentation

float OVRScreenFade.fadeTime ( )

Color OVRScreenFade.fadeColor ( )

bool OVRScreenFade.fadeOnStart ( )

Object Data Documentation

float OVRScreenFade.uiFadeAlpha ( )

MeshRenderer OVRScreenFade.fadeRenderer ( )

MeshFilter OVRScreenFade.fadeMesh ( )

Material OVRScreenFade.fadeMaterial ( )

bool OVRScreenFade.isFading ( )

Property Documentation

float OVRScreenFade.currentAlpha ( )

Object Data Documentation

void OVRScreenFade.Awake ( )

void OVRScreenFade.OnLevelFinishedLoading ( int level )

Starts a fade in when a new level is loaded

void OVRScreenFade.Start ( )

Automatically starts a fade in

void OVRScreenFade.OnEnable ( )

void OVRScreenFade.OnDestroy ( )

Cleans up the fade material

IEnumerator OVRScreenFade.Fade ( float startAlpha, float endAlpha )

Fades alpha from 1.0 to 0.0

void OVRScreenFade.SetMaterialAlpha ( )

Update material alpha.

UI fade and the current fade due to fade in/out animations (or explicit control) both affect the fade. (The max is taken)

Member Function Documentation

void OVRScreenFade.FadeOut ( )

Start a fade out

void OVRScreenFade.SetUIFade ( float level )

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

void OVRScreenFade.SetFadeLevel ( float level )

Override current fade level

level

The documentation for this class was generated from the following file: OVR/Scripts/Util/OVRScreenFade.cs