len0rd/love-nuklear
1
0
Fork 0
mirror of https://github.com/keharriso/love-nuklear.git synced 2025-09-11 00:27:48 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated Documentation (markdown)

Kevin Harrison 2016-11-14 21:39:02 -05:00
parent 2db2716e10
commit 23906d3b21
1 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

16
Documentation.md

@ -64,9 +64,9 @@ End the current frame. Call this once every [love.update](https://love2d.org/wik
## Window ## Window
#### open = nk.window_begin(title, x, y, width, height, flags...) #### open = nk.window_begin(title, x, y, width, height, [flags](#flags)...)
#### open = nk.window_begin(name, title, x, y, width, height, flags...) #### open = nk.window_begin(name, title, x, y, width, height, [flags](#flags)...)
Create or update a window with the given `name`. The `name` is a unique identifier used internally to differentiate between windows. If unspecified, the `name` defaults to the `title`. The `x`, `y`, `width`, and `height` parameters describe the window's initial bounds. All additional arguments are interpreted as window flags. Create or update a window with the given `name`. The `name` is a unique identifier used internally to differentiate between windows. If unspecified, the `name` defaults to the `title`. The `x`, `y`, `width`, and `height` parameters describe the window's initial bounds. All additional arguments are interpreted as window [flags](#flags).
Returns `true` if the window is open and `false` if it is closed or collapsed. Returns `true` if the window is open and `false` if it is closed or collapsed.
@ -235,7 +235,7 @@ Convert a pixel width to a ratio suitable for a dynamic layout.
### Groups ### Groups
#### open = nk.group_begin(title, flags...) #### open = nk.group_begin(title, [flags](#flags)...)
Start a group. Groups can have titles and scrollbars just like windows. Start a group. Groups can have titles and scrollbars just like windows.
Return `true` if the group is open and `false` otherwise. Return `true` if the group is open and `false` otherwise.
@ -261,8 +261,8 @@ Ends a tree. Call this at the end of an open tree item.
### Popups ### Popups
#### open = nk.popup_begin('dynamic'/'static', title, x, y, width, height, flags...) #### open = nk.popup_begin('dynamic'/'static', title, x, y, width, height, [flags](#flags)...)
Start a popup with the given size and flags. Bounds can be given as either dynamic ratios or static pixel counts. Start a popup with the given size and [flags](#flags). Bounds can be given as either dynamic ratios or static pixel counts.
Return `true` if the popup is open, and `false` otherwise. Return `true` if the popup is open, and `false` otherwise.
@ -276,8 +276,8 @@ End a popup. Be sure to call this when ending an open popup.
### Context Menus ### Context Menus
#### open = nk.contextual_begin(width, height, trigger_x, trigger_y, trigger_width, trigger_height, flags...) #### open = nk.contextual_begin(width, height, trigger_x, trigger_y, trigger_width, trigger_height, [flags](#flags)...)
Set up a context menu of the given size and trigger bounds. Also takes window flags. Set up a context menu of the given size and trigger bounds. Also takes window [flags](#flags).
Return `true` if the context menu is open, and `false` otherwise. Return `true` if the context menu is open, and `false` otherwise.