Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

Cursor

Namespace: UnityEngine

Description

Cursor API for setting the cursor that is used for rendering.

Supports Hardware Cursors on OSX, Windows, Linux, and Flash falls back to software cursors on unsupported platforms.

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

OSX Webplayer note: Due to sandboxing, Hardware Cursors can only be updated intermittently (when the cursor is moving) the best way to ensure correct behavior if to use OnMouseEnter and OnMouseExit to set the hardware cursors. This is not an issue for software cursors.

Static Functions

SetCursorChange the mouse cursor to the set texture OnMouseEnter.