Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


Gizmos

Gizmos are used to give visual debugging or setup aids in the Scene view.
Read time 2 minutesLast updated 4 days ago

Definition

  • Type: Class
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule
public sealed class Gizmos

Remarks

All gizmo drawing has to be done in either MonoBehaviour.OnDrawGizmos() or MonoBehaviour.OnDrawGizmosSelected() functions of the script. MonoBehaviour.OnDrawGizmos() is called when the Scene view or Game view is repainted. All gizmos that render in MonoBehaviour.OnDrawGizmos() are pickable. MonoBehaviour.OnDrawGizmosSelected() is called only if the object the script is attached to is selected.

Static Properties

Property

Description

colorSets the Color of the gizmos that are drawn next.
exposureSet a texture that contains the exposure correction for LightProbe gizmos. The value is sampled from the red channel in the middle of the texture.
matrixSets the Matrix4x4 that the Unity Editor uses to draw Gizmos.
probeSizeSet a scale for Light Probe gizmos. This scale will be used to render the spherical harmonic preview spheres.

Static Methods

Method

Description

CalculateLODDetermines the appropriate level of detail for a gizmo in the Scene view at a specified position with a specified radius.
DrawCubeDraw a solid box at center with size.
DrawFrustumDraw a camera frustum using the currently set Gizmos.matrix for its location and rotation.
DrawGUITextureDraw a texture in the Scene.
DrawIconDraw an icon at a position in the Scene view.
DrawLineDraws a line starting at from towards to.
DrawLineListDraws multiple lines between pairs of points.
DrawLineStripDraws a line between each point in the supplied span.
DrawMeshDraws a mesh.
DrawRayDraws a ray starting at from to from + direction.
DrawSphereDraws a solid sphere with center and radius.
DrawWireCubeDraw a wireframe box with center and size.
DrawWireMeshDraws a wireframe mesh.
DrawWireSphereDraws a wireframe sphere with center and radius.