Legacy Documentation: Version 2017.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Cursor

class in UnityEngine

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 Variables

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 Functions

SetCursorSets the mouse cursor to the given texture.

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