Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


DrawGUITexture

Draw a texture in the Scene.
Read time 2 minutesLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule

DrawGUITexture(Rect, Texture, int, int, int, int, Material)

Draw a texture in the Scene.
public static void DrawGUITexture(Rect screenRect, Texture texture, int leftBorder, int rightBorder, int topBorder, int bottomBorder, Material mat)

Parameters

screenRect

The size and position of the texture on the "screen" defined by the XY plane.

texture

The texture to be displayed.

leftBorder

Inset from the rectangle's left edge.

rightBorder

Inset from the rectangle's right edge.

topBorder

Inset from the rectangle's top edge.

bottomBorder

Inset from the rectangle's bottom edge.

An optional material to apply the texture.

Remarks

The chosen texture is drawn in 3D space on a "screen" defined by the XY plane (ie, the plane where the Z coordinate is zero). The values of the texture rectangle are given in Scene units. The optional border values specify an inset from each edge within the rectangle in Scene units; the texture is drawn inside the inset rectangle and the edge pixels are repeated outwards. This is a useful quick way to create a large background region around the main texture when its edges are of a single colour.
This function can be useful for creating GUI backgrounds in conjunction with a camera pointing directly at the texture.

Examples

using UnityEngine;using System.Collections;public class ExampleClass : MonoBehaviour{ public Texture myTexture; void OnDrawGizmosSelected() { // Draw a texture rectangle on the XY plane of the scene Gizmos.DrawGUITexture(new Rect(10, 10, 20, 20), myTexture); }}

DrawGUITexture(Rect, Texture, Material)

Draw a texture in the Scene.
public static void DrawGUITexture(Rect screenRect, Texture texture, Material mat)

Parameters

screenRect

The size and position of the texture on the "screen" defined by the XY plane.

texture

The texture to be displayed.

An optional material to apply the texture.

Remarks

The chosen texture is drawn in 3D space on a "screen" defined by the XY plane (ie, the plane where the Z coordinate is zero). The values of the texture rectangle are given in Scene units. The optional border values specify an inset from each edge within the rectangle in Scene units; the texture is drawn inside the inset rectangle and the edge pixels are repeated outwards. This is a useful quick way to create a large background region around the main texture when its edges are of a single colour.
This function can be useful for creating GUI backgrounds in conjunction with a camera pointing directly at the texture.

Examples

using UnityEngine;using System.Collections;public class ExampleClass : MonoBehaviour{ public Texture myTexture; void OnDrawGizmosSelected() { // Draw a texture rectangle on the XY plane of the scene Gizmos.DrawGUITexture(new Rect(10, 10, 20, 20), myTexture); }}