EDIA Core 0.6.0
A Unity XR toolbox for research
Loading...
Searching...
No Matches
Edia.ScreenFader Class Reference

Handles fading the camera view. More...

Public Member Functions

Coroutine StartFadeBlackIn (float fadeSpeed)
 Fade to black with given speed.

Public Attributes

MeshRenderer BlockObject = null
 Represents the mesh renderer used for blocking or fading the camera's view.
Color FadeColor = Color.black
 Defines the color used for screen fading effects.
float FadeSpeed = 1f
 Determines the speed at which the screen fades to and from black.

Detailed Description

Handles fading the camera view.

Member Function Documentation

◆ StartFadeBlackIn()

Coroutine Edia.ScreenFader.StartFadeBlackIn ( float fadeSpeed)
inline

Fade to black with given speed.

Parameters
fadeSpeedDefault = 1

Member Data Documentation

◆ BlockObject

MeshRenderer Edia.ScreenFader.BlockObject = null

Represents the mesh renderer used for blocking or fading the camera's view.

This renderer is utilized in conjunction with the ScreenFader component to display and manage fade effects such as transitioning in or out of scenes. The material of this object is dynamically adjusted during fade operations to manipulate color intensity and transparency. Ensure that this reference is set in the inspector or during runtime to avoid null reference issues.

◆ FadeColor

Color Edia.ScreenFader.FadeColor = Color.black

Defines the color used for screen fading effects.

This color determines the appearance of the fade effect applied by the ScreenFader component. The alpha value of the color is dynamically adjusted during fade transitions to create a smooth effect. By default, the color is set to black.

◆ FadeSpeed

float Edia.ScreenFader.FadeSpeed = 1f

Determines the speed at which the screen fades to and from black.

This value is used by the ScreenFader methods to control the rate of fading transitions. Typically, higher values result in faster fades, while lower values create slower transitions. The default value is 1.0f.


The documentation for this class was generated from the following file:
  • D:/Felix/Projects/EDIA/edia_core/Assets/com.edia.core/Runtime/Base/Scripts/Experiment/ScreenFader.cs