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

Cursor

class in UnityEngine

/

Implemented in:UnityEngine.CoreModule

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

Cursor API for setting the cursor (mouse pointer).

Supports hardware cursors on macOS, Windows and Linux. Falls back to software cursors on unsupported platforms.

Windows Store Apps: Supports only one hardware cursor, set via PlayerSettings.defaultCursor, cursors created at runtime using Cursor.SetCursor are treated as software cursors.

Textures used as cursors should be marked as such in their import settings.

Static Properties

lockStateDetermines whether the hardware pointer is locked to the center of the view, constrained to the window, or not constrained at all.
visibleDetermines whether the hardware pointer is visible or not.

Static Methods

SetCursorSets the mouse cursor to the given texture.

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