You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9Lines changed: 9 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,15 @@ A hardware cursor plugin for the solar2D (formerly corona-sdk) game engine
4
4
# Usage
5
5
Refer to example project in ```Corona/``` directory
6
6
7
+
# Methods
8
+
9
+
-```initPlugin``` - performs setup so the plugin can work as expected
10
+
-```freePlugin``` - detaches the plugin (should be called when preparing to exit)
11
+
-```loadCursor``` - loads a ```.cur``` or ```.ani``` cursor file and sets it as the cursor
12
+
-```showCursor``` - shows the cursor if it was hidden
13
+
-```hideCursor``` - hides the cursor if it was visible
14
+
-```resetCursor``` - resets the cursor to the default arrow cursor
15
+
7
16
# Caveats
8
17
- Only supports windows for now
9
18
- You must call ```cursor.freePlugin()``` some moments before allowing the application to exit. This is to stop the application from crashing as it exits. An example of how this can be done is provided.
0 commit comments