|
@@ -215,7 +215,7 @@ __nk_set_user_data__| Utility function to pass user data to draw command
|
|
|
Initializes a `nk_context` struct with a default standard library allocator.
|
|
|
Should be used if you don't want to be bothered with memory management in nuklear.
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API int nk_init_default(struct nk_context *ctx, const struct nk_user_font *font);
|
|
|
+int nk_init_default(struct nk_context *ctx, const struct nk_user_font *font);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|---------------------------------------------------------------
|
|
@@ -229,7 +229,7 @@ Especially recommended for system with little memory or systems with virtual mem
|
|
|
For the later case you can just allocate for example 16MB of virtual memory
|
|
|
and only the required amount of memory will actually be committed.
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API int nk_init_fixed(struct nk_context *ctx, void *memory, nk_size size, const struct nk_user_font *font);
|
|
|
+int nk_init_fixed(struct nk_context *ctx, void *memory, nk_size size, const struct nk_user_font *font);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
!!! Warning
|
|
|
make sure the passed memory block is aligned correctly for `nk_draw_commands`.
|
|
@@ -245,7 +245,7 @@ Initializes a `nk_context` struct with memory allocation callbacks for nuklear t
|
|
|
memory from. Used internally for `nk_init_default` and provides a kitchen sink allocation
|
|
|
interface to nuklear. Can be useful for cases like monitoring memory consumption.
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API int nk_init(struct nk_context *ctx, struct nk_allocator *alloc, const struct nk_user_font *font);
|
|
|
+int nk_init(struct nk_context *ctx, struct nk_allocator *alloc, const struct nk_user_font *font);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|---------------------------------------------------------------
|
|
@@ -258,7 +258,7 @@ Initializes a `nk_context` struct from two different either fixed or growing
|
|
|
buffers. The first buffer is for allocating draw commands while the second buffer is
|
|
|
used for allocating windows, panels and state tables.
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API int nk_init_custom(struct nk_context *ctx, struct nk_buffer *cmds, struct nk_buffer *pool, const struct nk_user_font *font);
|
|
|
+int nk_init_custom(struct nk_context *ctx, struct nk_buffer *cmds, struct nk_buffer *pool, const struct nk_user_font *font);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|---------------------------------------------------------------
|
|
@@ -272,7 +272,7 @@ Resets the context state at the end of the frame. This includes mostly
|
|
|
garbage collector tasks like removing windows or table not called and therefore
|
|
|
used anymore.
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_clear(struct nk_context *ctx);
|
|
|
+void nk_clear(struct nk_context *ctx);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -281,7 +281,7 @@ __ctx__ | Must point to a previously initialized `nk_context` struct
|
|
|
Frees all memory allocated by nuklear. Not needed if context was
|
|
|
initialized with `nk_init_fixed`.
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_free(struct nk_context *ctx);
|
|
|
+void nk_free(struct nk_context *ctx);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -289,7 +289,7 @@ __ctx__ | Must point to a previously initialized `nk_context` struct
|
|
|
#### nk_set_user_data
|
|
|
Sets the currently passed userdata passed down into each draw command.
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_set_user_data(struct nk_context *ctx, nk_handle data);
|
|
|
+void nk_set_user_data(struct nk_context *ctx, nk_handle data);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|--------------------------------------------------------------
|
|
@@ -355,7 +355,7 @@ __nk_input_end__ | Ends the input mirroring process by calculating state chan
|
|
|
Begins the input mirroring process by resetting text, scroll
|
|
|
mouse previous mouse position and movement as well as key state transitions,
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_input_begin(struct nk_context*);
|
|
|
+void nk_input_begin(struct nk_context*);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -363,7 +363,7 @@ __ctx__ | Must point to a previously initialized `nk_context` struct
|
|
|
#### nk_input_motion
|
|
|
Mirrors current mouse position to nuklear
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_input_motion(struct nk_context *ctx, int x, int y);
|
|
|
+void nk_input_motion(struct nk_context *ctx, int x, int y);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -373,7 +373,7 @@ __y__ | Must hold an integer describing the current mouse cursor y-positio
|
|
|
#### nk_input_key
|
|
|
Mirrors state of a specific key to nuklear
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_input_key(struct nk_context*, enum nk_keys key, int down);
|
|
|
+void nk_input_key(struct nk_context*, enum nk_keys key, int down);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -383,7 +383,7 @@ __down__ | Must be 0 for key is up and 1 for key is down
|
|
|
#### nk_input_button
|
|
|
Mirrors the state of a specific mouse button to nuklear
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_input_button(struct nk_context *ctx, enum nk_buttons btn, int x, int y, int down);
|
|
|
+void nk_input_button(struct nk_context *ctx, enum nk_buttons btn, int x, int y, int down);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -396,7 +396,7 @@ __down__ | Must be 0 for key is up and 1 for key is down
|
|
|
Copies the last mouse scroll value to nuklear. Is generally
|
|
|
a scroll value. So does not have to come from mouse and could also originate
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_input_scroll(struct nk_context *ctx, struct nk_vec2 val);
|
|
|
+void nk_input_scroll(struct nk_context *ctx, struct nk_vec2 val);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -409,7 +409,7 @@ nuklear.
|
|
|
!!! Note
|
|
|
Stores up to NK_INPUT_MAX bytes between `nk_input_begin` and `nk_input_end`.
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_input_char(struct nk_context *ctx, char c);
|
|
|
+void nk_input_char(struct nk_context *ctx, char c);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -421,7 +421,7 @@ internal text buffer.
|
|
|
!!! Note
|
|
|
Stores up to NK_INPUT_MAX bytes between `nk_input_begin` and `nk_input_end`.
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_input_glyph(struct nk_context *ctx, const nk_glyph g);
|
|
|
+void nk_input_glyph(struct nk_context *ctx, const nk_glyph g);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -433,7 +433,7 @@ into an internal text buffer.
|
|
|
!!! Note
|
|
|
Stores up to NK_INPUT_MAX bytes between `nk_input_begin` and `nk_input_end`.
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_input_unicode(struct nk_context*, nk_rune rune);
|
|
|
+void nk_input_unicode(struct nk_context*, nk_rune rune);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -443,7 +443,7 @@ __rune__ | UTF-32 unicode codepoint
|
|
|
End the input mirroring process by resetting mouse grabbing
|
|
|
state to ensure the mouse cursor is not grabbed indefinitely.///
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_input_end(struct nk_context *ctx);
|
|
|
+void nk_input_end(struct nk_context *ctx);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -657,7 +657,7 @@ __nk_draw_foreach__ | Iterates over each vertex draw command inside the vertex d
|
|
|
Returns a draw command list iterator to iterate all draw
|
|
|
commands accumulated over one frame.
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API const struct nk_command* nk__begin(struct nk_context*);
|
|
|
+const struct nk_command* nk__begin(struct nk_context*);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -666,7 +666,7 @@ Returns draw command pointer pointing to the first command inside the draw comma
|
|
|
#### nk__next
|
|
|
Returns a draw command list iterator to iterate all draw
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API const struct nk_command* nk__next(struct nk_context*, const struct nk_command*);
|
|
|
+const struct nk_command* nk__next(struct nk_context*, const struct nk_command*);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -689,7 +689,7 @@ three buffers with vertexes, vertex draw commands and vertex indices. The vertex
|
|
|
as well as some other configuration values have to be configured by filling out a
|
|
|
`nk_convert_config` struct.
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API nk_flags nk_convert(struct nk_context *ctx, struct nk_buffer *cmds,
|
|
|
+nk_flags nk_convert(struct nk_context *ctx, struct nk_buffer *cmds,
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -709,7 +709,7 @@ NK_CONVERT_ELEMENT_BUFFER_FULL | The provided buffer for storing indicies is fu
|
|
|
#### nk__draw_begin
|
|
|
Returns a draw vertex command buffer iterator to iterate each the vertex draw command buffer
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API const struct nk_draw_command* nk__draw_begin(const struct nk_context*, const struct nk_buffer*);
|
|
|
+const struct nk_draw_command* nk__draw_begin(const struct nk_context*, const struct nk_buffer*);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -719,7 +719,7 @@ Returns vertex draw command pointer pointing to the first command inside the ver
|
|
|
#### nk__draw_end
|
|
|
Returns the vertex draw command at the end of the vertex draw command buffer
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API const struct nk_draw_command* nk__draw_end(const struct nk_context *ctx, const struct nk_buffer *buf);
|
|
|
+const struct nk_draw_command* nk__draw_end(const struct nk_context *ctx, const struct nk_buffer *buf);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -729,7 +729,7 @@ Returns vertex draw command pointer pointing to the end of the last vertex draw
|
|
|
#### nk__draw_next
|
|
|
Increments the vertex draw command buffer iterator
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API const struct nk_draw_command* nk__draw_next(const struct nk_draw_command*, const struct nk_buffer*, const struct nk_context*);
|
|
|
+const struct nk_draw_command* nk__draw_next(const struct nk_draw_command*, const struct nk_buffer*, const struct nk_context*);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -851,7 +851,7 @@ nk_window_collapse | Collapses the window with given window nam
|
|
|
nk_window_collapse_if | Collapses the window with given window name if the given condition was met
|
|
|
nk_window_show | Hides a visible or reshows a hidden window
|
|
|
nk_window_show_if | Hides/shows a window depending on condition
|
|
|
-#### enum nk_panel_flags
|
|
|
+#### nk_panel_flags
|
|
|
Flag | Description
|
|
|
----------------------------|----------------------------------------
|
|
|
NK_WINDOW_BORDER | Draws a border around the window to visually separate window from the background
|
|
@@ -865,7 +865,7 @@ NK_WINDOW_SCROLL_AUTO_HIDE | Automatically hides the window scrollbar if no use
|
|
|
NK_WINDOW_BACKGROUND | Always keep window in the background
|
|
|
NK_WINDOW_SCALE_LEFT | Puts window scaler in the left-ottom corner instead right-bottom
|
|
|
NK_WINDOW_NO_INPUT | Prevents window of scaling, moving or getting focus
|
|
|
-#### enum nk_collapse_states
|
|
|
+#### nk_collapse_states
|
|
|
State | Description
|
|
|
----------------|-----------------------------------------------------------
|
|
|
__NK_MINIMIZED__| UI section is collased and not visibile until maximized
|
|
@@ -875,21 +875,21 @@ __NK_MAXIMIZED__| UI section is extended and visibile until minimized
|
|
|
Starts a new window; needs to be called every frame for every
|
|
|
window (unless hidden) or otherwise the window gets removed
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API int nk_begin(struct nk_context *ctx, const char *title, struct nk_rect bounds, nk_flags flags);
|
|
|
+int nk_begin(struct nk_context *ctx, const char *title, struct nk_rect bounds, nk_flags flags);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
|
__ctx__ | Must point to an previously initialized `nk_context` struct
|
|
|
__title__ | Window title and identifier. Needs to be persistent over frames to identify the window
|
|
|
__bounds__ | Initial position and window size. However if you do not define `NK_WINDOW_SCALABLE` or `NK_WINDOW_MOVABLE` you can set window position and size every frame
|
|
|
-__flags__ | Window flags defined in `enum nk_panel_flags` with a number of different window behaviors
|
|
|
+__flags__ | Window flags defined in the nk_panel_flags section with a number of different window behaviors
|
|
|
Returns `true(1)` if the window can be filled up with widgets from this point
|
|
|
-until `nk_end or `false(0)` otherwise for example if minimized
|
|
|
+until `nk_end` or `false(0)` otherwise for example if minimized
|
|
|
#### nk_begin_titled
|
|
|
Extended window start with separated title and identifier to allow multiple
|
|
|
windows with same name but not title
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API int nk_begin_titled(struct nk_context *ctx, const char *name, const char *title, struct nk_rect bounds, nk_flags flags);
|
|
|
+int nk_begin_titled(struct nk_context *ctx, const char *name, const char *title, struct nk_rect bounds, nk_flags flags);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -897,14 +897,14 @@ __ctx__ | Must point to an previously initialized `nk_context` struct
|
|
|
__name__ | Window identifier. Needs to be persistent over frames to identify the window
|
|
|
__title__ | Window title displayed inside header if flag `NK_WINDOW_TITLE` or either `NK_WINDOW_CLOSABLE` or `NK_WINDOW_MINIMIZED` was set
|
|
|
__bounds__ | Initial position and window size. However if you do not define `NK_WINDOW_SCALABLE` or `NK_WINDOW_MOVABLE` you can set window position and size every frame
|
|
|
-__flags__ | Window flags defined in `enum nk_panel_flags` with a number of different window behaviors
|
|
|
+__flags__ | Window flags defined in the nk_panel_flags section with a number of different window behaviors
|
|
|
Returns `true(1)` if the window can be filled up with widgets from this point
|
|
|
-until `nk_end or `false(0)` otherwise for example if minimized
|
|
|
+until `nk_end` or `false(0)` otherwise for example if minimized
|
|
|
#### nk_end
|
|
|
Needs to be called at the end of the window building process to process scaling, scrollbars and general cleanup.
|
|
|
All widget calls after this functions will result in asserts or no state changes
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_end(struct nk_context *ctx);
|
|
|
+void nk_end(struct nk_context *ctx);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -912,7 +912,7 @@ __ctx__ | Must point to an previously initialized `nk_context` struct
|
|
|
#### nk_window_find
|
|
|
Finds and returns a window from passed name
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_end(struct nk_context *ctx);
|
|
|
+void nk_end(struct nk_context *ctx);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -925,7 +925,7 @@ Returns a rectangle with screen position and size of the currently processed win
|
|
|
!!! WARNING
|
|
|
Only call this function between calls `nk_begin_xxx` and `nk_end`
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API struct nk_rect nk_window_get_bounds(const struct nk_context *ctx);
|
|
|
+struct nk_rect nk_window_get_bounds(const struct nk_context *ctx);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -936,7 +936,7 @@ Returns the position of the currently processed window.
|
|
|
!!! WARNING
|
|
|
Only call this function between calls `nk_begin_xxx` and `nk_end`
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API struct nk_vec2 nk_window_get_position(const struct nk_context *ctx);
|
|
|
+struct nk_vec2 nk_window_get_position(const struct nk_context *ctx);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -947,7 +947,7 @@ Returns the size with width and height of the currently processed window.
|
|
|
!!! WARNING
|
|
|
Only call this function between calls `nk_begin_xxx` and `nk_end`
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API struct nk_vec2 nk_window_get_size(const struct nk_context *ctx);
|
|
|
+struct nk_vec2 nk_window_get_size(const struct nk_context *ctx);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -958,7 +958,7 @@ Returns the width of the currently processed window.
|
|
|
!!! WARNING
|
|
|
Only call this function between calls `nk_begin_xxx` and `nk_end`
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API float nk_window_get_width(const struct nk_context *ctx);
|
|
|
+float nk_window_get_width(const struct nk_context *ctx);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -969,7 +969,7 @@ Returns the height of the currently processed window.
|
|
|
!!! WARNING
|
|
|
Only call this function between calls `nk_begin_xxx` and `nk_end`
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API float nk_window_get_width(const struct nk_context *ctx);
|
|
|
+float nk_window_get_width(const struct nk_context *ctx);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -982,7 +982,7 @@ Returns the underlying panel which contains all processing state of the current
|
|
|
!!! WARNING
|
|
|
Do not keep the returned panel pointer around it is only valid until `nk_end`
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API struct nk_panel* nk_window_get_panel(struct nk_context *ctx);
|
|
|
+struct nk_panel* nk_window_get_panel(struct nk_context *ctx);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -994,7 +994,7 @@ inside the currently processed window.
|
|
|
!!! WARNING
|
|
|
Only call this function between calls `nk_begin_xxx` and `nk_end`
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API struct nk_rect nk_window_get_content_region(struct nk_context *ctx);
|
|
|
+struct nk_rect nk_window_get_content_region(struct nk_context *ctx);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1007,7 +1007,7 @@ space inside the currently processed window.
|
|
|
!!! WARNING
|
|
|
Only call this function between calls `nk_begin_xxx` and `nk_end`
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API struct nk_vec2 nk_window_get_content_region_min(struct nk_context *ctx);
|
|
|
+struct nk_vec2 nk_window_get_content_region_min(struct nk_context *ctx);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1020,7 +1020,7 @@ non-clipped space inside the currently processed window.
|
|
|
!!! WARNING
|
|
|
Only call this function between calls `nk_begin_xxx` and `nk_end`
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API struct nk_vec2 nk_window_get_content_region_max(struct nk_context *ctx);
|
|
|
+struct nk_vec2 nk_window_get_content_region_max(struct nk_context *ctx);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1033,7 +1033,7 @@ currently processed window
|
|
|
!!! WARNING
|
|
|
Only call this function between calls `nk_begin_xxx` and `nk_end`
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API struct nk_vec2 nk_window_get_content_region_size(struct nk_context *ctx);
|
|
|
+struct nk_vec2 nk_window_get_content_region_size(struct nk_context *ctx);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1046,7 +1046,7 @@ Returns the draw command buffer. Can be used to draw custom widgets
|
|
|
!!! WARNING
|
|
|
Do not keep the returned command buffer pointer around it is only valid until `nk_end`
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API struct nk_command_buffer* nk_window_get_canvas(struct nk_context *ctx);
|
|
|
+struct nk_command_buffer* nk_window_get_canvas(struct nk_context *ctx);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1058,7 +1058,7 @@ Returns if the currently processed window is currently active
|
|
|
!!! WARNING
|
|
|
Only call this function between calls `nk_begin_xxx` and `nk_end`
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API int nk_window_has_focus(const struct nk_context *ctx);
|
|
|
+int nk_window_has_focus(const struct nk_context *ctx);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1069,7 +1069,7 @@ Return if the current window is being hovered
|
|
|
!!! WARNING
|
|
|
Only call this function between calls `nk_begin_xxx` and `nk_end`
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API int nk_window_is_hovered(struct nk_context *ctx);
|
|
|
+int nk_window_is_hovered(struct nk_context *ctx);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1078,7 +1078,7 @@ Returns `true(1)` if current window is hovered or `false(0)` otherwise
|
|
|
#### nk_window_is_collapsed
|
|
|
Returns if the window with given name is currently minimized/collapsed
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API int nk_window_is_collapsed(struct nk_context *ctx, const char *name);
|
|
|
+int nk_window_is_collapsed(struct nk_context *ctx, const char *name);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1089,7 +1089,7 @@ found or is not minimized
|
|
|
#### nk_window_is_closed
|
|
|
Returns if the window with given name was closed by calling `nk_close`
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API int nk_window_is_closed(struct nk_context *ctx, const char *name);
|
|
|
+int nk_window_is_closed(struct nk_context *ctx, const char *name);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1099,7 +1099,7 @@ Returns `true(1)` if current window was closed or `false(0)` window not found or
|
|
|
#### nk_window_is_hidden
|
|
|
Returns if the window with given name is hidden
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API int nk_window_is_hidden(struct nk_context *ctx, const char *name);
|
|
|
+int nk_window_is_hidden(struct nk_context *ctx, const char *name);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1109,7 +1109,7 @@ Returns `true(1)` if current window is hidden or `false(0)` window not found or
|
|
|
#### nk_window_is_active
|
|
|
Same as nk_window_has_focus for some reason
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API int nk_window_is_active(struct nk_context *ctx, const char *name);
|
|
|
+int nk_window_is_active(struct nk_context *ctx, const char *name);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1119,7 +1119,7 @@ Returns `true(1)` if current window is active or `false(0)` window not found or
|
|
|
#### nk_window_is_any_hovered
|
|
|
Returns if the any window is being hovered
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API int nk_window_is_any_hovered(struct nk_context*);
|
|
|
+int nk_window_is_any_hovered(struct nk_context*);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1130,7 +1130,7 @@ Returns if the any window is being hovered or any widget is currently active.
|
|
|
Can be used to decide if input should be processed by UI or your specific input handling.
|
|
|
Example could be UI and 3D camera to move inside a 3D space.
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API int nk_item_is_any_active(struct nk_context*);
|
|
|
+int nk_item_is_any_active(struct nk_context*);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1139,7 +1139,7 @@ Returns `true(1)` if any window is hovered or any item is active or `false(0)` o
|
|
|
#### nk_window_set_bounds
|
|
|
Updates position and size of window with passed in name
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_window_set_bounds(struct nk_context*, const char *name, struct nk_rect bounds);
|
|
|
+void nk_window_set_bounds(struct nk_context*, const char *name, struct nk_rect bounds);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1149,7 +1149,7 @@ __bounds__ | Must point to a `nk_rect` struct with the new position and size
|
|
|
#### nk_window_set_position
|
|
|
Updates position of window with passed name
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_window_set_position(struct nk_context*, const char *name, struct nk_vec2 pos);
|
|
|
+void nk_window_set_position(struct nk_context*, const char *name, struct nk_vec2 pos);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1159,7 +1159,7 @@ __pos__ | Must point to a `nk_vec2` struct with the new position
|
|
|
#### nk_window_set_size
|
|
|
Updates size of window with passed in name
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_window_set_size(struct nk_context*, const char *name, struct nk_vec2);
|
|
|
+void nk_window_set_size(struct nk_context*, const char *name, struct nk_vec2);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1169,7 +1169,7 @@ __size__ | Must point to a `nk_vec2` struct with new window size
|
|
|
#### nk_window_set_focus
|
|
|
Sets the window with given name as active
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_window_set_focus(struct nk_context*, const char *name);
|
|
|
+void nk_window_set_focus(struct nk_context*, const char *name);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1178,7 +1178,7 @@ __name__ | Identifier of the window to set focus on
|
|
|
#### nk_window_close
|
|
|
Closes a window and marks it for being freed at the end of the frame
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_window_close(struct nk_context *ctx, const char *name);
|
|
|
+void nk_window_close(struct nk_context *ctx, const char *name);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1187,28 +1187,28 @@ __name__ | Identifier of the window to close
|
|
|
#### nk_window_collapse
|
|
|
Updates collapse state of a window with given name
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_window_collapse(struct nk_context*, const char *name, enum nk_collapse_states state);
|
|
|
+void nk_window_collapse(struct nk_context*, const char *name, enum nk_collapse_states state);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
|
__ctx__ | Must point to an previously initialized `nk_context` struct
|
|
|
__name__ | Identifier of the window to close
|
|
|
-__state__ | value out of `enum nk_collapse_states`
|
|
|
+__state__ | value out of nk_collapse_states section
|
|
|
#### nk_window_collapse_if
|
|
|
Updates collapse state of a window with given name if given condition is met
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_window_collapse_if(struct nk_context*, const char *name, enum nk_collapse_states, int cond);
|
|
|
+void nk_window_collapse_if(struct nk_context*, const char *name, enum nk_collapse_states, int cond);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
|
__ctx__ | Must point to an previously initialized `nk_context` struct
|
|
|
__name__ | Identifier of the window to either collapse or maximize
|
|
|
-__state__ | value out of `enum nk_collapse_states` the window should be put into
|
|
|
+__state__ | value out of nk_collapse_states section the window should be put into
|
|
|
__cond__ | condition that has to be met to actually commit the collapse state change
|
|
|
#### nk_window_show
|
|
|
updates visibility state of a window with given name
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_window_show(struct nk_context*, const char *name, enum nk_show_states);
|
|
|
+void nk_window_show(struct nk_context*, const char *name, enum nk_show_states);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1218,7 +1218,7 @@ __state__ | state with either visible or hidden to modify the window with
|
|
|
#### nk_window_show_if
|
|
|
Updates visibility state of a window with given name if a given condition is met
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_window_show_if(struct nk_context*, const char *name, enum nk_show_states, int cond);
|
|
|
+void nk_window_show_if(struct nk_context*, const char *name, enum nk_show_states, int cond);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1473,7 +1473,7 @@ Sets the currently used minimum row height.
|
|
|
The passed height needs to include both your preferred row height
|
|
|
as well as padding. No internal padding is added.
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_layout_set_min_row_height(struct nk_context*, float height);
|
|
|
+void nk_layout_set_min_row_height(struct nk_context*, float height);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1482,7 +1482,7 @@ __height__ | New minimum row height to be used for auto generating the row heig
|
|
|
#### nk_layout_reset_min_row_height
|
|
|
Reset the currently used minimum row height back to `font_height + text_padding + padding`
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_layout_reset_min_row_height(struct nk_context*);
|
|
|
+void nk_layout_reset_min_row_height(struct nk_context*);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1490,7 +1490,7 @@ __ctx__ | Must point to an previously initialized `nk_context` struct after
|
|
|
#### nk_layout_widget_bounds
|
|
|
Returns the width of the next row allocate by one of the layouting functions
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API struct nk_rect nk_layout_widget_bounds(struct nk_context*);
|
|
|
+struct nk_rect nk_layout_widget_bounds(struct nk_context*);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1499,7 +1499,7 @@ Return `nk_rect` with both position and size of the next row
|
|
|
#### nk_layout_ratio_from_pixel
|
|
|
Utility functions to calculate window ratio from pixel size
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API float nk_layout_ratio_from_pixel(struct nk_context*, float pixel_width);
|
|
|
+float nk_layout_ratio_from_pixel(struct nk_context*, float pixel_width);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1511,7 +1511,7 @@ Sets current row layout to share horizontal space
|
|
|
between @cols number of widgets evenly. Once called all subsequent widget
|
|
|
calls greater than @cols will allocate a new row with same layout.
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_layout_row_dynamic(struct nk_context *ctx, float height, int cols);
|
|
|
+void nk_layout_row_dynamic(struct nk_context *ctx, float height, int cols);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1523,7 +1523,7 @@ Sets current row layout to fill @cols number of widgets
|
|
|
in row with same @item_width horizontal size. Once called all subsequent widget
|
|
|
calls greater than @cols will allocate a new row with same layout.
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_layout_row_static(struct nk_context *ctx, float height, int item_width, int cols);
|
|
|
+void nk_layout_row_static(struct nk_context *ctx, float height, int item_width, int cols);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1534,7 +1534,7 @@ __columns__ | Number of widget inside row
|
|
|
#### nk_layout_row_begin
|
|
|
Starts a new dynamic or fixed row with given height and columns.
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_layout_row_begin(struct nk_context *ctx, enum nk_layout_format fmt, float row_height, int cols);
|
|
|
+void nk_layout_row_begin(struct nk_context *ctx, enum nk_layout_format fmt, float row_height, int cols);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1545,7 +1545,7 @@ __columns__ | Number of widget inside row
|
|
|
#### nk_layout_row_push
|
|
|
Specifies either window ratio or width of a single column
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_layout_row_push(struct nk_context*, float value);
|
|
|
+void nk_layout_row_push(struct nk_context*, float value);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1554,7 +1554,7 @@ __value__ | either a window ratio or fixed width depending on @fmt in previous
|
|
|
#### nk_layout_row_end
|
|
|
Finished previously started row
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_layout_row_end(struct nk_context*);
|
|
|
+void nk_layout_row_end(struct nk_context*);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1562,7 +1562,7 @@ __ctx__ | Must point to an previously initialized `nk_context` struct after
|
|
|
#### nk_layout_row
|
|
|
Specifies row columns in array as either window ratio or size
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_layout_row(struct nk_context*, enum nk_layout_format, float height, int cols, const float *ratio);
|
|
|
+void nk_layout_row(struct nk_context*, enum nk_layout_format, float height, int cols, const float *ratio);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1573,7 +1573,7 @@ __columns__ | Number of widget inside row
|
|
|
#### nk_layout_row_template_begin
|
|
|
Begins the row template declaration
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_layout_row_template_begin(struct nk_context*, float row_height);
|
|
|
+void nk_layout_row_template_begin(struct nk_context*, float row_height);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1582,7 +1582,7 @@ __height__ | Holds height of each widget in row or zero for auto layouting
|
|
|
#### nk_layout_row_template_push_dynamic
|
|
|
Adds a dynamic column that dynamically grows and can go to zero if not enough space
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_layout_row_template_push_dynamic(struct nk_context*);
|
|
|
+void nk_layout_row_template_push_dynamic(struct nk_context*);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1591,7 +1591,7 @@ __height__ | Holds height of each widget in row or zero for auto layouting
|
|
|
#### nk_layout_row_template_push_variable
|
|
|
Adds a variable column that dynamically grows but does not shrink below specified pixel width
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_layout_row_template_push_variable(struct nk_context*, float min_width);
|
|
|
+void nk_layout_row_template_push_variable(struct nk_context*, float min_width);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1600,7 +1600,7 @@ __width__ | Holds the minimum pixel width the next column must always be
|
|
|
#### nk_layout_row_template_push_static
|
|
|
Adds a static column that does not grow and will always have the same size
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_layout_row_template_push_static(struct nk_context*, float width);
|
|
|
+void nk_layout_row_template_push_static(struct nk_context*, float width);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1609,7 +1609,7 @@ __width__ | Holds the absolute pixel width value the next column must be
|
|
|
#### nk_layout_row_template_end
|
|
|
Marks the end of the row template
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_layout_row_template_end(struct nk_context*);
|
|
|
+void nk_layout_row_template_end(struct nk_context*);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1617,7 +1617,7 @@ __ctx__ | Must point to an previously initialized `nk_context` struct after
|
|
|
#### nk_layout_space_begin
|
|
|
Begins a new layouting space that allows to specify each widgets position and size.
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_layout_space_begin(struct nk_context*, enum nk_layout_format, float height, int widget_count);
|
|
|
+void nk_layout_space_begin(struct nk_context*, enum nk_layout_format, float height, int widget_count);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1628,7 +1628,7 @@ __columns__ | Number of widgets inside row
|
|
|
#### nk_layout_space_push
|
|
|
Pushes position and size of the next widget in own coordinate space either as pixel or ratio
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_layout_space_push(struct nk_context *ctx, struct nk_rect bounds);
|
|
|
+void nk_layout_space_push(struct nk_context *ctx, struct nk_rect bounds);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1637,7 +1637,7 @@ __bounds__ | Position and size in laoyut space local coordinates
|
|
|
#### nk_layout_space_end
|
|
|
Marks the end of the layout space
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_layout_space_end(struct nk_context*);
|
|
|
+void nk_layout_space_end(struct nk_context*);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1645,7 +1645,7 @@ __ctx__ | Must point to an previously initialized `nk_context` struct after
|
|
|
#### nk_layout_space_bounds
|
|
|
Utility function to calculate total space allocated for `nk_layout_space`
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API struct nk_rect nk_layout_space_bounds(struct nk_context*);
|
|
|
+struct nk_rect nk_layout_space_bounds(struct nk_context*);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1654,7 +1654,7 @@ Returns `nk_rect` holding the total space allocated
|
|
|
#### nk_layout_space_to_screen
|
|
|
Converts vector from nk_layout_space coordinate space into screen space
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API struct nk_vec2 nk_layout_space_to_screen(struct nk_context*, struct nk_vec2);
|
|
|
+struct nk_vec2 nk_layout_space_to_screen(struct nk_context*, struct nk_vec2);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1664,7 +1664,7 @@ Returns transformed `nk_vec2` in screen space coordinates
|
|
|
#### nk_layout_space_to_screen
|
|
|
Converts vector from layout space into screen space
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API struct nk_vec2 nk_layout_space_to_local(struct nk_context*, struct nk_vec2);
|
|
|
+struct nk_vec2 nk_layout_space_to_local(struct nk_context*, struct nk_vec2);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1674,7 +1674,7 @@ Returns transformed `nk_vec2` in layout space coordinates
|
|
|
#### nk_layout_space_rect_to_screen
|
|
|
Converts rectangle from screen space into layout space
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API struct nk_rect nk_layout_space_rect_to_screen(struct nk_context*, struct nk_rect);
|
|
|
+struct nk_rect nk_layout_space_rect_to_screen(struct nk_context*, struct nk_rect);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1684,7 +1684,7 @@ Returns transformed `nk_rect` in screen space coordinates
|
|
|
#### nk_layout_space_rect_to_local
|
|
|
Converts rectangle from layout space into screen space
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API struct nk_rect nk_layout_space_rect_to_local(struct nk_context*, struct nk_rect);
|
|
|
+struct nk_rect nk_layout_space_rect_to_local(struct nk_context*, struct nk_rect);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1769,30 +1769,30 @@ nk_group_scrolled_end | Ends a group with manual scrollbar handling. S
|
|
|
#### nk_group_begin
|
|
|
Starts a new widget group. Requires a previous layouting function to specify a pos/size.
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API int nk_group_begin(struct nk_context*, const char *title, nk_flags);
|
|
|
+int nk_group_begin(struct nk_context*, const char *title, nk_flags);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
|
__ctx__ | Must point to an previously initialized `nk_context` struct
|
|
|
__title__ | Must be an unique identifier for this group that is also used for the group header
|
|
|
-__flags__ | Window flags defined in `enum nk_panel_flags` with a number of different group behaviors
|
|
|
+__flags__ | Window flags defined in the nk_panel_flags section with a number of different group behaviors
|
|
|
Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise
|
|
|
#### nk_group_begin_titled
|
|
|
Starts a new widget group. Requires a previous layouting function to specify a pos/size.
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API int nk_group_begin_titled(struct nk_context*, const char *name, const char *title, nk_flags);
|
|
|
+int nk_group_begin_titled(struct nk_context*, const char *name, const char *title, nk_flags);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
|
__ctx__ | Must point to an previously initialized `nk_context` struct
|
|
|
__id__ | Must be an unique identifier for this group
|
|
|
__title__ | Group header title
|
|
|
-__flags__ | Window flags defined in `enum nk_panel_flags` with a number of different group behaviors
|
|
|
+__flags__ | Window flags defined in the nk_panel_flags section with a number of different group behaviors
|
|
|
Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise
|
|
|
#### nk_group_end
|
|
|
Ends a widget group
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_group_end(struct nk_context*);
|
|
|
+void nk_group_end(struct nk_context*);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1801,7 +1801,7 @@ __ctx__ | Must point to an previously initialized `nk_context` struct
|
|
|
starts a new widget group. requires a previous layouting function to specify
|
|
|
a size. Does not keep track of scrollbar.
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API int nk_group_scrolled_offset_begin(struct nk_context*, nk_uint *x_offset, nk_uint *y_offset, const char *title, nk_flags flags);
|
|
|
+int nk_group_scrolled_offset_begin(struct nk_context*, nk_uint *x_offset, nk_uint *y_offset, const char *title, nk_flags flags);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
@@ -1809,29 +1809,213 @@ __ctx__ | Must point to an previously initialized `nk_context` struct
|
|
|
__x_offset__| Scrollbar x-offset to offset all widgets inside the group horizontally.
|
|
|
__y_offset__| Scrollbar y-offset to offset all widgets inside the group vertically
|
|
|
__title__ | Window unique group title used to both identify and display in the group header
|
|
|
-__flags__ | Window flags from `enum nk_panel_flags`
|
|
|
+__flags__ | Window flags from the nk_panel_flags section
|
|
|
Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise
|
|
|
#### nk_group_scrolled_begin
|
|
|
Starts a new widget group. requires a previous
|
|
|
layouting function to specify a size. Does not keep track of scrollbar.
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API int nk_group_scrolled_begin(struct nk_context*, struct nk_scroll *off, const char *title, nk_flags);
|
|
|
+int nk_group_scrolled_begin(struct nk_context*, struct nk_scroll *off, const char *title, nk_flags);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
|
__ctx__ | Must point to an previously initialized `nk_context` struct
|
|
|
__off__ | Both x- and y- scroll offset. Allows for manual scrollbar control
|
|
|
__title__ | Window unique group title used to both identify and display in the group header
|
|
|
-__flags__ | Window flags from `enum nk_panel_flags`
|
|
|
+__flags__ | Window flags from nk_panel_flags section
|
|
|
Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise
|
|
|
#### nk_group_scrolled_end
|
|
|
Ends a widget group after calling nk_group_scrolled_offset_begin or nk_group_scrolled_begin.
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
-NK_API void nk_group_scrolled_end(struct nk_context*);
|
|
|
+void nk_group_scrolled_end(struct nk_context*);
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
Parameter | Description
|
|
|
------------|-----------------------------------------------------------
|
|
|
__ctx__ | Must point to an previously initialized `nk_context` struct
|
|
|
+### Tree
|
|
|
+Trees represent two different concept. First the concept of a collapsable
|
|
|
+UI section that can be either in a hidden or visibile state. They allow the UI
|
|
|
+user to selectively minimize the current set of visible UI to comprehend.
|
|
|
+The second concept are tree widgets for visual UI representation of trees.<br /><br />
|
|
|
+Trees thereby can be nested for tree representations and multiple nested
|
|
|
+collapsable UI sections. All trees are started by calling of the
|
|
|
+`nk_tree_xxx_push_tree` functions and ended by calling one of the
|
|
|
+`nk_tree_xxx_pop_xxx()` functions. Each starting functions takes a title label
|
|
|
+and optionally an image to be displayed and the initial collapse state from
|
|
|
+the nk_collapse_states section.<br /><br />
|
|
|
+The runtime state of the tree is either stored outside the library by the caller
|
|
|
+or inside which requires a unique ID. The unique ID can either be generated
|
|
|
+automatically from `__FILE__` and `__LINE__` with function `nk_tree_push`,
|
|
|
+by `__FILE__` and a user provided ID generated for example by loop index with
|
|
|
+function `nk_tree_push_id` or completely provided from outside by user with
|
|
|
+function `nk_tree_push_hashed`.
|
|
|
+#### Usage
|
|
|
+To create a tree you have to call one of the seven `nk_tree_xxx_push_xxx`
|
|
|
+functions to start a collapsable UI section and `nk_tree_xxx_pop` to mark the
|
|
|
+end.
|
|
|
+Each starting function will either return `false(0)` if the tree is collapsed
|
|
|
+or hidden and therefore does not need to be filled with content or `true(1)`
|
|
|
+if visible and required to be filled.
|
|
|
+!!! Note
|
|
|
+ The tree header does not require and layouting function and instead
|
|
|
+ calculates a auto height based on the currently used font size
|
|
|
+The tree ending functions only need to be called if the tree content is
|
|
|
+actually visible. So make sure the tree push function is guarded by `if`
|
|
|
+and the pop call is only taken if the tree is visible.
|
|
|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
+if (nk_tree_push(ctx, NK_TREE_TAB, "Tree", NK_MINIMIZED)) {
|
|
|
+ nk_layout_row_dynamic(...);
|
|
|
+ nk_widget(...);
|
|
|
+ nk_tree_pop(ctx);
|
|
|
+}
|
|
|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
+#### Reference
|
|
|
+Function | Description
|
|
|
+----------------------------|-------------------------------------------
|
|
|
+nk_tree_push | Start a collapsable UI section with internal state management
|
|
|
+nk_tree_push_id | Start a collapsable UI section with internal state management callable in a look
|
|
|
+nk_tree_push_hashed | Start a collapsable UI section with internal state management with full control over internal unique ID use to store state
|
|
|
+nk_tree_image_push | Start a collapsable UI section with image and label header
|
|
|
+nk_tree_image_push_id | Start a collapsable UI section with image and label header and internal state management callable in a look
|
|
|
+nk_tree_image_push_hashed | Start a collapsable UI section with image and label header and internal state management with full control over internal unique ID use to store state
|
|
|
+nk_tree_pop | Ends a collapsable UI section
|
|
|
+nk_tree_state_push | Start a collapsable UI section with external state management
|
|
|
+nk_tree_state_image_push | Start a collapsable UI section with image and label header and external state management
|
|
|
+nk_tree_state_pop | Ends a collapsabale UI section
|
|
|
+#### nk_tree_type
|
|
|
+Flag | Description
|
|
|
+----------------|----------------------------------------
|
|
|
+NK_TREE_NODE | Highlighted tree header to mark a collapsable UI section
|
|
|
+NK_TREE_TAB | Non-highighted tree header closer to tree representations
|
|
|
+#### nk_tree_push
|
|
|
+Starts a collapsable UI section with internal state management
|
|
|
+!!! WARNING
|
|
|
+ To keep track of the runtime tree collapsable state this function uses
|
|
|
+ defines `__FILE__` and `__LINE__` to generate a unique ID. If you want
|
|
|
+ to call this function in a loop please use `nk_tree_push_id` or
|
|
|
+ `nk_tree_push_hashed` instead.
|
|
|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
+#define nk_tree_push(ctx, type, title, state)
|
|
|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
+Parameter | Description
|
|
|
+------------|-----------------------------------------------------------
|
|
|
+__ctx__ | Must point to an previously initialized `nk_context` struct
|
|
|
+__type__ | Value from the nk_tree_type section to visually mark a tree node header as either a collapseable UI section or tree node
|
|
|
+__title__ | Label printed in the tree header
|
|
|
+__state__ | Initial tree state value out of nk_collapse_states
|
|
|
+#### nk_tree_push_id
|
|
|
+Starts a collapsable UI section with internal state management callable in a look
|
|
|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
+#define nk_tree_push_id(ctx, type, title, state, id)
|
|
|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
+Parameter | Description
|
|
|
+------------|-----------------------------------------------------------
|
|
|
+__ctx__ | Must point to an previously initialized `nk_context` struct
|
|
|
+__type__ | Value from the nk_tree_type section to visually mark a tree node header as either a collapseable UI section or tree node
|
|
|
+__title__ | Label printed in the tree header
|
|
|
+__state__ | Initial tree state value out of nk_collapse_states
|
|
|
+__id__ | Loop counter index if this function is called in a loop
|
|
|
+#### nk_tree_push_hashed
|
|
|
+Start a collapsable UI section with internal state management with full
|
|
|
+control over internal unique ID used to store state
|
|
|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
+int nk_tree_push_hashed(struct nk_context*, enum nk_tree_type, const char *title, enum nk_collapse_states initial_state, const char *hash, int len,int seed);
|
|
|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
+Parameter | Description
|
|
|
+------------|-----------------------------------------------------------
|
|
|
+__ctx__ | Must point to an previously initialized `nk_context` struct
|
|
|
+__type__ | Value from the nk_tree_type section to visually mark a tree node header as either a collapseable UI section or tree node
|
|
|
+__title__ | Label printed in the tree header
|
|
|
+__state__ | Initial tree state value out of nk_collapse_states
|
|
|
+__hash__ | Memory block or string to generate the ID from
|
|
|
+__len__ | Size of passed memory block or string in __hash__
|
|
|
+__seed__ | Seeding value if this function is called in a loop or default to `0`
|
|
|
+#### nk_tree_image_push
|
|
|
+Start a collapsable UI section with image and label header
|
|
|
+!!! WARNING
|
|
|
+ To keep track of the runtime tree collapsable state this function uses
|
|
|
+ defines `__FILE__` and `__LINE__` to generate a unique ID. If you want
|
|
|
+ to call this function in a loop please use `nk_tree_image_push_id` or
|
|
|
+ `nk_tree_image_push_hashed` instead.
|
|
|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
+#define nk_tree_image_push(ctx, type, img, title, state)
|
|
|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
+Parameter | Description
|
|
|
+------------|-----------------------------------------------------------
|
|
|
+__ctx__ | Must point to an previously initialized `nk_context` struct
|
|
|
+__type__ | Value from the nk_tree_type section to visually mark a tree node header as either a collapseable UI section or tree node
|
|
|
+__img__ | Image to display inside the header on the left of the label
|
|
|
+__title__ | Label printed in the tree header
|
|
|
+__state__ | Initial tree state value out of nk_collapse_states
|
|
|
+#### nk_tree_image_push_id
|
|
|
+Start a collapsable UI section with image and label header and internal state
|
|
|
+management callable in a look
|
|
|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
+#define nk_tree_image_push_id(ctx, type, img, title, state, id)
|
|
|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
+Parameter | Description
|
|
|
+------------|-----------------------------------------------------------
|
|
|
+__ctx__ | Must point to an previously initialized `nk_context` struct
|
|
|
+__type__ | Value from the nk_tree_type section to visually mark a tree node header as either a collapseable UI section or tree node
|
|
|
+__img__ | Image to display inside the header on the left of the label
|
|
|
+__title__ | Label printed in the tree header
|
|
|
+__state__ | Initial tree state value out of nk_collapse_states
|
|
|
+__id__ | Loop counter index if this function is called in a loop
|
|
|
+#### nk_tree_image_push_hashed
|
|
|
+Start a collapsable UI section with internal state management with full
|
|
|
+control over internal unique ID used to store state
|
|
|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
+int nk_tree_image_push_hashed(struct nk_context*, enum nk_tree_type, struct nk_image, const char *title, enum nk_collapse_states initial_state, const char *hash, int len,int seed);
|
|
|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
+Parameter | Description
|
|
|
+------------|-----------------------------------------------------------
|
|
|
+__ctx__ | Must point to an previously initialized `nk_context` struct
|
|
|
+__type__ | Value from the nk_tree_type section to visually mark a tree node header as either a collapseable UI section or tree node
|
|
|
+__img__ | Image to display inside the header on the left of the label
|
|
|
+__title__ | Label printed in the tree header
|
|
|
+__state__ | Initial tree state value out of nk_collapse_states
|
|
|
+__hash__ | Memory block or string to generate the ID from
|
|
|
+__len__ | Size of passed memory block or string in __hash__
|
|
|
+__seed__ | Seeding value if this function is called in a loop or default to `0`
|
|
|
+#### nk_tree_pop
|
|
|
+Ends a collapsabale UI section
|
|
|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
+void nk_tree_pop(struct nk_context*);
|
|
|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
+Parameter | Description
|
|
|
+------------|-----------------------------------------------------------
|
|
|
+__ctx__ | Must point to an previously initialized `nk_context` struct after calling `nk_tree_xxx_push_xxx`
|
|
|
+#### nk_tree_state_push
|
|
|
+Start a collapsable UI section with external state management
|
|
|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
+int nk_tree_state_push(struct nk_context*, enum nk_tree_type, const char *title, enum nk_collapse_states *state);
|
|
|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
+Parameter | Description
|
|
|
+------------|-----------------------------------------------------------
|
|
|
+__ctx__ | Must point to an previously initialized `nk_context` struct after calling `nk_tree_xxx_push_xxx`
|
|
|
+__type__ | Value from the nk_tree_type section to visually mark a tree node header as either a collapseable UI section or tree node
|
|
|
+__title__ | Label printed in the tree header
|
|
|
+__state__ | Persistent state to update
|
|
|
+#### nk_tree_state_image_push
|
|
|
+Start a collapsable UI section with image and label header and external state management
|
|
|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
+int nk_tree_state_image_push(struct nk_context*, enum nk_tree_type, struct nk_image, const char *title, enum nk_collapse_states *state);
|
|
|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
+Parameter | Description
|
|
|
+------------|-----------------------------------------------------------
|
|
|
+__ctx__ | Must point to an previously initialized `nk_context` struct after calling `nk_tree_xxx_push_xxx`
|
|
|
+__img__ | Image to display inside the header on the left of the label
|
|
|
+__type__ | Value from the nk_tree_type section to visually mark a tree node header as either a collapseable UI section or tree node
|
|
|
+__title__ | Label printed in the tree header
|
|
|
+__state__ | Persistent state to update
|
|
|
+#### nk_tree_state_pop
|
|
|
+Ends a collapsabale UI section
|
|
|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
|
|
+void nk_tree_state_pop(struct nk_context*);
|
|
|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
+Parameter | Description
|
|
|
+------------|-----------------------------------------------------------
|
|
|
+__ctx__ | Must point to an previously initialized `nk_context` struct after calling `nk_tree_xxx_push_xxx`
|
|
|
scores --------- */
|
|
|
-XXX.XXX- X...X - X...X -X....X - X....X"
|
|
|
X...XXXXXXXXXXXXX...X - "
|
|
@@ -1887,6 +2071,7 @@ Offset --*/
|
|
|
- [x]: Major version with API and library breaking
|
|
|
- [yy]: Minor version with non-breaking API and library changes
|
|
|
- [zz]: Bug fix version with no direct changes to API
|
|
|
+- 2017/01/12 (3.00.2) - Added `nk_group_begin_titled` for separed group identifier and title
|
|
|
- 2017/01/07 (3.00.1) - Started to change documentation style
|
|
|
- 2017/01/05 (3.00.0) - BREAKING CHANGE: The previous color picker API was broken
|
|
|
because of conversions between float and byte color representation.
|