Select your preferred scripting language. All code snippets will be displayed in this language.
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.
CloseFor 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.
CloseSets the mouse cursor to the given texture.
Call this method with a Texture2D to change the appearance of the hardware pointer (mouse cursor).
The cursorMode parameter allows you to use hardware cursors on supported platforms, or force software rendering of the cursor.
In the following example, the mouse cursor is changed to a given texture when OnMouseEnter is called, and reset to default when OnMouseExit is called.
#pragma strict public var cursorTexture: Texture2D; public var cursorMode: CursorMode = CursorMode.Auto; public var hotSpot: Vector2 = Vector2.zero; function OnMouseEnter() { Cursor.SetCursor(cursorTexture, hotSpot, cursorMode); } function OnMouseExit() { Cursor.SetCursor(null, Vector2.zero, cursorMode); }
using UnityEngine; using System.Collections;
public class ExampleClass : MonoBehaviour { public Texture2D cursorTexture; public CursorMode cursorMode = CursorMode.Auto; public Vector2 hotSpot = Vector2.zero; void OnMouseEnter() { Cursor.SetCursor(cursorTexture, hotSpot, cursorMode); }
void OnMouseExit() { Cursor.SetCursor(null, Vector2.zero, cursorMode); } }
| texture | The texture to use for the cursor or null to set the default cursor. Note that a texture needs to be imported with "Read/Write enabled" in the texture importer (or using the "Cursor" defaults), in order to be used as a cursor. |
| hotspot | The offset from the top left of the texture to use as the target point (must be within the bounds of the cursor). |
| cursorMode | Allow this cursor to render as a hardware cursor on supported platforms, or force software cursor. |
Specify a custom cursor that you wish to use as a cursor.
Call this method with a Texture2D to change the appearance of the hardware pointer (mouse cursor).