Update documentation
Marius Petcu
parent
d8a572aef6
commit
34afa54b47
139
README.md
139
README.md
|
|
@ -6,47 +6,116 @@ Currently uses Native Extension for macOS, Windows and HTML5. Contribute!
|
|||
## Installation
|
||||
You can use DefOS in your own project by adding this project as a [Defold library dependency](http://www.defold.com/manuals/libraries/). Open your game.project file and in the dependencies field under project add:
|
||||
|
||||
https://github.com/subsoap/defos/archive/master.zip
|
||||
https://github.com/subsoap/defos/archive/master.zip
|
||||
|
||||
## Methods
|
||||
|
||||
Use DefOS module methods via
|
||||
Customize title bar accessories and title.
|
||||
|
||||
```lua
|
||||
defos.disable_maximize_button()
|
||||
defos.disable_minimize_button()
|
||||
defos.disable_window_resize()
|
||||
defos.set_window_title("I set this title using Defos")
|
||||
```
|
||||
|
||||
Toggle maximize and full screen modes.
|
||||
|
||||
```lua
|
||||
defos.toggle_maximize()
|
||||
bool_value = defos.is_maximized()
|
||||
defos.toggle_fullscreen()
|
||||
bool_value = defos.is_fullscreen()
|
||||
```
|
||||
|
||||
Get/set the window's size and position in screen coordinates. The window is
|
||||
inclusive of title bar, so the actual contained game view area might be smaller.
|
||||
|
||||
Screen coordinates start at (0, 0) in the top-left corner of the main display.
|
||||
X axis goes right. Y axis goes down.
|
||||
|
||||
```lua
|
||||
x, y, w, h = defos.get_window_size()
|
||||
defos.set_window_size(x, y, w, h)
|
||||
```
|
||||
|
||||
Set the game view size and position in screen coordinates. This adjusts
|
||||
the window so that its containing game view is at the desired size and position.
|
||||
|
||||
```lua
|
||||
defos.set_view_size(x, y, w, h)
|
||||
```
|
||||
|
||||
Show/hide the mouse cursor.
|
||||
|
||||
```lua
|
||||
defos.disable_mouse_cursor()
|
||||
defos.enable_mouse_cursor()
|
||||
```
|
||||
|
||||
Respond to the mouse entering and leaving the game view area.
|
||||
|
||||
```lua
|
||||
bool_value = defos.is_mouse_inside_window()
|
||||
defos.on_mouse_enter(function ()
|
||||
print("Mouse entered view")
|
||||
end)
|
||||
defos.on_mouse_leave(function ()
|
||||
print("Mouse left view")
|
||||
end)
|
||||
```
|
||||
|
||||
Move the cursor programatically.
|
||||
|
||||
```lua
|
||||
defos.set_cursor_pos(x, y) -- In screen coordinates
|
||||
defos.move_cursor_to(x, y) -- In game view coordinates
|
||||
```
|
||||
|
||||
Clip cursor to current game view area. Windows only.
|
||||
|
||||
```lua
|
||||
defos.clip_cursor()
|
||||
defos.restore_cursor_clip()
|
||||
```
|
||||
|
||||
Set custom hardware cursors. `cursor` can be one of the following:
|
||||
* `nil`: Resets the cursor to default. Equivalent to `defos.reset_cursor()`.
|
||||
* `defos.CURSOR_ARROW`
|
||||
* `defos.CURSOR_HAND`
|
||||
* `defos.CURSOR_CROSSHAIR`
|
||||
* `defos.CURSOR_IBEAM`
|
||||
* On Windows, a path to an `.ani` or `.cur` file on the file system.
|
||||
* On macOS, a table of the form:
|
||||
```lua
|
||||
{
|
||||
image = resource.load("cursor.tiff"),
|
||||
hot_spot_x = 18,
|
||||
hot_spot_x = 2,
|
||||
}
|
||||
```
|
||||
|
||||
On macOS, custom cursors can be any image file supported by `NSImage`, but it's highly recommended to
|
||||
[create a TIFF](https://developer.apple.com/library/content/documentation/GraphicsAnimation/Conceptual/HighResolutionOSX/Optimizing/Optimizing.html#//apple_ref/doc/uid/TP40012302-CH7-SW27)
|
||||
with two images, one at 72DPI (for low density displays) and another at 144DPI (for Retina displays).
|
||||
|
||||
The hotspot is an anchor point within the image that will overlap with the functional position of the mouse pointer (eg. the tip of the arrow).
|
||||
|
||||
```
|
||||
function init(self)
|
||||
defos.disable_maximize_button()
|
||||
defos.disable_minimize_button()
|
||||
defos.disable_window_resize()
|
||||
defos.disable_mouse_cursor()
|
||||
defos.enable_mouse_cursor()
|
||||
defos.get_window_size()
|
||||
defos.set_window_size(10, 10, 800, 600)
|
||||
defos.set_window_title("I set this title using Defos")
|
||||
defos.toggle_maximize()
|
||||
defos.is_maximized()
|
||||
defos.toggle_fullscreen()
|
||||
defos.is_fullscreen()
|
||||
defos.on_mouse_enter(function ()
|
||||
print("Mouse entered window")
|
||||
end)
|
||||
defos.on_mouse_leave(function ()
|
||||
print("Mouse left window")
|
||||
end)
|
||||
defos.get_window_size()
|
||||
-- on screen coordinates on Windows
|
||||
defos.set_cursor_pos(100, 100)
|
||||
-- on window client coordinates on Windows
|
||||
defos.move_cursor_to(100, 100)
|
||||
-- clip cursor to current window area
|
||||
defos.clip_cursor()
|
||||
defos.restore_cursor_clip()
|
||||
-- support .ani and .cur file for Windows
|
||||
defos.set_cursor("path/to/cursor")
|
||||
-- restore the cursor to default one
|
||||
defos.reset_cursor()
|
||||
end
|
||||
defos.set_cursor(cursor)
|
||||
defos.reset_cursor()
|
||||
```
|
||||
Use issues for feature requests.
|
||||
|
||||
On Windows only, show/hide the console window. Only works when not running
|
||||
from the Editor.
|
||||
|
||||
```
|
||||
defos.show_console()
|
||||
defos.hide_console()
|
||||
bool_value = defos.is_console_visible()
|
||||
```
|
||||
|
||||
If you'd like to see any other feature, open an issue.
|
||||
|
||||
## Example
|
||||
An example is made using [DirtyLarry](https://github.com/andsve/dirtylarry)
|
||||
|
|
|
|||
Loading…
Reference in New Issue