Cursor
Cursor API for setting the cursor (mouse pointer).
Read time 1 minuteLast updated 4 days ago
Definition
- Type: Class
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
public class Cursor
Remarks
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.
Android: Supports custom hardware cursors on version 7.0 and later. There is no hardware or software custom cursor support before 7.0.
Textures used as cursors should be marked as such in their import settings.
Static Properties
Property | Description |
|---|---|
| lockState | Determines whether the hardware pointer is locked to the center of the view, constrained to the window, or not constrained at all. |
| visible | Determines whether the hardware pointer is visible or not. |
Static Methods
Method | Description |
|---|---|
| SetCursor | Sets a custom cursor to use as your cursor. |