Version: 5.5 (switch to 5.6b)
LanguageEnglish
  • C#
  • JS

Script language

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

Cursor

class in UnityEngine

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 that is used for rendering.

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 will be treated as software cursors.

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

Static Variables

lockStateHow should the cursor be handled?
visibleShould the cursor be visible?

Static Functions

SetCursorChange the mouse cursor to the set texture OnMouseEnter.
Copyright © 2016 Unity Technologies. Publication 5.5-001B
Tutorials Community Answers Knowledge Base Forums Asset Store