Legacy Documentation: Version 2018.1 (Go to current version)
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.


Suggest a change


Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.


Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.



public method CrossFadeAlpha(alpha: float, duration: float, ignoreTimeScale: bool): void;
public void CrossFadeAlpha(float alpha, float duration, bool ignoreTimeScale);


alphaTarget alpha.
durationDuration of the tween in seconds.
ignoreTimeScaleShould ignore Time.scale?


Tweens the alpha of the CanvasRenderer color associated with this Graphic.

Creates a fading effect on a Graphic with a CanvasRenderer attached. Choose an alpha level to fade to, and pick the speed of the fade to see a smooth fade over time. UI Images and Text are some of the elements that you are able to apply this effect to.

no example available in JavaScript
//Attach this script to a GameObject
//Create an Image GameObject by going to Create>UI>Image. Attach this Image to the Image field in your GameObject’s Inspector window.
//This script creates a toggle that fades an Image in and out.
using UnityEngine;
using UnityEngine.UI;

public class Example : MonoBehaviour { //Attach an Image you want to fade in the GameObject's Inspector public Image m_Image; //Use this to tell if the toggle returns true or false bool m_Fading;

void Update() { //If the toggle returns true, fade in the Image if (m_Fading == true) { //Fully fade in Image (1) with the duration of 2 m_Image.CrossFadeAlpha(1, 2.0f, false); } //If the toggle is false, fade out to nothing (0) the Image with a duration of 2 if (m_Fading == false) { m_Image.CrossFadeAlpha(0, 2.0f, false); } }

void OnGUI() { //Fetch the Toggle's state m_Fading = GUI.Toggle(new Rect(0, 0, 100, 30), m_Fading, "Fade In/Out"); } }

Did you find this page useful? Please give it a rating: