Legacy Documentation: Version 2017.2 (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 var sprite: Sprite;
public Sprite sprite;


The sprite that is used to render this image.

This returns the source Sprite of an Image. This Sprite can also be viewed and changed in the Inspector as part of an Image component. This can also be used to change the Sprite using a script.

no example available in JavaScript
//Attach this script to an Image GameObject and set its Source Image to the Sprite you would like.
//Press the space key to change the Sprite. Remember to assign a second Sprite in this script's section of the Inspector.

using UnityEngine; using UnityEngine.UI;

public class Example : MonoBehaviour { Image m_Image; //Set this in the Inspector public Sprite m_Sprite;

void Start() { //Fetch the Image from the GameObject m_Image = GetComponent<Image>(); }

void Update() { //Press space to change the Sprite of the Image if (Input.GetKey(KeyCode.Space)) { m_Image.sprite = m_Sprite; } } }

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