Version: 2017.3 (switch to 2017.4)
LanguageEnglish
  • C#
  • JS

Script language

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

GUI.DrawTexture

Other Versions
Leave feedback
Suggest a change

Success!

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.

Close

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.

Close

Cancel

public static method DrawTexture(position: Rect, image: Texture): void;
public static void DrawTexture(Rect position, Texture image);
public static method DrawTexture(position: Rect, image: Texture, scaleMode: ScaleMode): void;
public static void DrawTexture(Rect position, Texture image, ScaleMode scaleMode);
public static method DrawTexture(position: Rect, image: Texture, scaleMode: ScaleMode, alphaBlend: bool): void;
public static void DrawTexture(Rect position, Texture image, ScaleMode scaleMode, bool alphaBlend);
public static method DrawTexture(position: Rect, image: Texture, scaleMode: ScaleMode, alphaBlend: bool, imageAspect: float): void;
public static void DrawTexture(Rect position, Texture image, ScaleMode scaleMode, bool alphaBlend, float imageAspect);

Parameters

position Rectangle on the screen to draw the texture within.
image Texture to display.
scaleMode How to scale the image when the aspect ratio of it doesn't fit the aspect ratio to be drawn within.
alphaBlend Whether to apply alpha blending when drawing the image (enabled by default).
imageAspect Aspect ratio to use for the source image. If 0 (the default), the aspect ratio from the image is used. Pass in w/h for the desired aspect ratio. This allows the aspect ratio of the source image to be adjusted without changing the pixel width and height.

Description

Draw a texture within a rectangle.

See Also: GUI.color, GUI.contentColor.

    // Draws a texture in the left corner of the screen.
    // The texture is drawn in a window 60x60 pixels.
    // The source texture is given an aspect ratio of 10x1
    // and scaled to fit in the 60x60 rectangle.  Because
    // the aspect ratio is preserved, the texture will fit
    // inside a 60x10 pixel area of the screen rectangle.
    var aTexture : Texture;

    function OnGUI() {
        if(!aTexture){
            Debug.LogError("Assign a Texture in the inspector.");
            return;
        }
        GUI.DrawTexture(Rect(10,10,60,60), aTexture, ScaleMode.ScaleToFit, true, 10.0f);
    }

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public Texture aTexture;
    void OnGUI() {
        if (!aTexture) {
            Debug.LogError("Assign a Texture in the inspector.");
            return;
        }
        GUI.DrawTexture(new Rect(10, 10, 60, 60), aTexture, ScaleMode.ScaleToFit, true, 10.0F);
    }
}
public static method DrawTexture(position: Rect, image: Texture, scaleMode: ScaleMode, alphaBlend: bool, imageAspect: float, color: Color, borderWidth: float, borderRadius: float): void;
public static void DrawTexture(Rect position, Texture image, ScaleMode scaleMode, bool alphaBlend, float imageAspect, Color color, float borderWidth, float borderRadius);
public static method DrawTexture(position: Rect, image: Texture, scaleMode: ScaleMode, alphaBlend: bool, imageAspect: float, color: Color, borderWidths: Vector4, borderRadius: float): void;
public static void DrawTexture(Rect position, Texture image, ScaleMode scaleMode, bool alphaBlend, float imageAspect, Color color, Vector4 borderWidths, float borderRadius);

Parameters

position Rectangle on the screen to draw the texture within.
image Texture to display.
scaleMode How to scale the image when the aspect ratio of it doesn't fit the aspect ratio to be drawn within.
alphaBlend Whether to apply alpha blending when drawing the image (enabled by default).
imageAspect Aspect ratio to use for the source image. If 0 (the default), the aspect ratio from the image is used. Pass in w/h for the desired aspect ratio. This allows the aspect ratio of the source image to be adjusted without changing the pixel width and height.
color A tint color to apply on the texture.
borderWidth The width of the border. If 0, the full texture is drawn.
borderWidths The width of the borders (left, top, right and bottom). If Vector4.zero, the full texture is drawn.
borderRadius The radius for rounded corners. If 0, corners will not be rounded.
borderRadiuses The radiuses for rounded corners (top-left, top-right, bottom-right and bottom-left). If Vector4.zero, corners will not be rounded.

Description

Draws a border with rounded corners within a rectangle. The texture is used to pattern the border. Note that this method only works on shader model 2.5 and above.

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

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2018 Unity Technologies. Publication: 2017.3-002A. Built: 2018-04-04.
Tutorials Community Answers Knowledge Base Forums Asset Store LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information