SpriteRenderer

Description

A component that renders a Sprite.

If a GameObject has a SpriteRenderer component, the component renders the assigned Sprite asset on the screen using the position, rotation and scale from the Transform component.

You can use this to draw characters, items, backgrounds, and other visual elements in a 2D game.

Additional resources: Sprite, Transform, SpriteShapeRenderer, SpriteMask, SpriteAtlas.

using UnityEngine;

// This example script demonstrates how to change the sprite and the sprite color, and flip the sprite horizontally and vertically.
// Attach this script to a GameObject with a SpriteRenderer component and assign a Sprite to the Sprite field in the Inspector.
public class Example : MonoBehaviour
{
    public Sprite sprite;

    private SpriteRenderer m_spriteRenderer;

    private void Awake()
    {
        // Fetch the SpriteRenderer from the GameObject
        m_spriteRenderer = GetComponent<SpriteRenderer>();
    }

    private void Start()
    {
        // Change the sprite to the one in the sprite field
        m_spriteRenderer.sprite = sprite;
        
        // Change the color of the sprite to red
        m_spriteRenderer.color = Color.red;
        
        // Flip the sprite horizontally
        m_spriteRenderer.flipX = true;
        
        // Flip the sprite vertically
        m_spriteRenderer.flipY = true;
    }
}

Properties

Public Methods

Inherited Members