Skip to content

Commit bfdb54e

Browse files
committed
Update README.md
1 parent e326407 commit bfdb54e

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@ A hardware cursor plugin for the solar2D (formerly corona-sdk) game engine
44
# Usage
55
Refer to example project in ```Corona/``` directory
66

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+
716
# Caveats
817
- Only supports windows for now
918
- 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

Comments
 (0)