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.
Android and ChromeOS: Support 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.
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. |
SetCursor | Sets a custom cursor to use as your cursor. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.