Class ScreenFadeEffect

Screen fade effect by using a custom shader modifying the cameraToFade(s) rendered image

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

UnitySingleton<ScreenFadeEffect>

ScreenFadeEffect

Inherited Members

UnitySingleton<ScreenFadeEffect>.ShouldNotDestroyOnLoad

UnitySingleton<ScreenFadeEffect>.OnApplicationQuit()

UnitySingleton<ScreenFadeEffect>.OnDestroy()

UnitySingleton<ScreenFadeEffect>.Instance

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.destroyCancellationToken

MonoBehaviour.useGUILayout

MonoBehaviour.didStart

MonoBehaviour.didAwake

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.GetComponentIndex()

Component.CompareTag(string)

Component.CompareTag(TagHandle)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Xareus.Unity

Assembly: Xareus.Unity.Libraries.dll

Syntax

[DisallowMultipleComponent]
public class ScreenFadeEffect : UnitySingleton<ScreenFadeEffect>

Fields

LastUsedPipelineType

Declaration

protected ScreenFadeEffect.PipelineType LastUsedPipelineType

Field Value

Type	Description
ScreenFadeEffect.PipelineType

LastUsedRenderPipelineAsset

Declaration

protected RenderPipelineAsset LastUsedRenderPipelineAsset

Field Value

Type	Description
RenderPipelineAsset

MustStopFading

Whether the fading must be stopped (used to stop the fading when a new fade command is given while a fading is already in progress)

Declaration

public bool MustStopFading

Field Value

Type	Description
bool

OnFadeFinished

Action to call when a fade routine is finished

Declaration

public Action OnFadeFinished

Field Value

Type	Description
Action

currentFadeBackend

Declaration

protected IScreenFadeBackend currentFadeBackend

Field Value

Type	Description
IScreenFadeBackend

fadeValue

Current fade value

Declaration

protected float fadeValue

Field Value

Type	Description
float

Methods

GetScreenFade(Camera)

Get the effect component (add the necessary elements if needed)

Declaration

protected static ScreenFadeEffect GetScreenFade(Camera camera)

Parameters

Type	Name	Description
Camera	camera

Returns

Type	Description
ScreenFadeEffect

Exceptions

Type	Condition
ArgumentNullException

SetFade(Camera[], float)

Instant Fade using current color

Declaration

public static void SetFade(Camera[] cameras, float fade)

Parameters

Type	Name	Description
Camera[]	cameras	Cameras on which the fade effect must be applied
float	fade	Fade value (1 : solid color, 0 : cameraToFade render)

SetFade(Camera[], float, Color)

Instant Fade using the specified color

Declaration

public static void SetFade(Camera[] cameras, float fade, Color color)

Parameters

Type	Name	Description
Camera[]	cameras	Cameras on which the fade effect must be applied
float	fade	Fade value (1 : solid color, 0 : cameraToFade render)
Color	color	Color to use for the fade effect

SmoothFade(Camera[], float, float, Action)

Fade over time. The fade will be applied using the current color of the effect

Declaration

public static void SmoothFade(Camera[] cameras, float fade, float fadeDuration, Action finishedCallback = null)

Parameters

Type	Name	Description
Camera[]	cameras	Cameras on which the fade effect must be applied
float	fade	Fade value (1 : solid color, 0 : cameraToFade render)
float	fadeDuration	Fade duration in seconds
Action	finishedCallback

SmoothFade(Camera[], float, float, Color, Action)

Fade over time using the specified color. The color will be lerped from the current effect color

Declaration

public static void SmoothFade(Camera[] cameras, float fade, float fadeDuration, Color color, Action finishedCallback = null)

Parameters

Type	Name	Description
Camera[]	cameras	Cameras on which the fade effect must be applied
float	fade	Fade value (1 : solid color, 0 : cameraToFade render)
float	fadeDuration	Fade duration in seconds
Color	color	Color to use for the fade effect.
Action	finishedCallback