Version: 2018.3 (switch to 2019.1a or 2017.4)
LanguageEnglish
  • C#

Cursor.SetCursor(Texture2D,CursorMode)

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

Description

Sets 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.

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); } }

public static void SetCursor(Texture2D texture, Vector2 hotspot, CursorMode cursorMode);

Parameters

textureThe texture to use for the cursor. To use a texture, you must first import it with `Read/Write`enabled. Alternatively, you can use the default cursor import setting. If you created your cursor texture from code, it must be in RGBA32 format, have alphaIsTransparency enabled, and have no mip chain. To use the default cursor, set the texture to `Null`.
hotspotThe offset from the top left of the texture to use as the target point (must be within the bounds of the cursor).
cursorModeAllow this cursor to render as a hardware cursor on supported platforms, or force software cursor.

Description

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).

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