fix #718 by moving all the changes to src/nuklear.h
This commit is contained in:
parent
956d33b89a
commit
5cea113a9c
|
@ -300,8 +300,8 @@ __data__ | Handle with either pointer or index to be passed into every draw c
|
||||||
### Input
|
### Input
|
||||||
The input API is responsible for holding the current input state composed of
|
The input API is responsible for holding the current input state composed of
|
||||||
mouse, key and text input states.
|
mouse, key and text input states.
|
||||||
It is worth noting that no direct os or window handling is done in nuklear.
|
It is worth noting that no direct OS or window handling is done in nuklear.
|
||||||
Instead all input state has to be provided by platform specific code. This in one hand
|
Instead all input state has to be provided by platform specific code. This on one hand
|
||||||
expects more work from the user and complicates usage but on the other hand
|
expects more work from the user and complicates usage but on the other hand
|
||||||
provides simple abstraction over a big number of platforms, libraries and other
|
provides simple abstraction over a big number of platforms, libraries and other
|
||||||
already provided functionality.
|
already provided functionality.
|
||||||
|
@ -317,7 +317,7 @@ while (GetEvent(&evt)) {
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
#### Usage
|
#### Usage
|
||||||
Input state needs to be provided to nuklear by first calling `nk_input_begin`
|
Input state needs to be provided to nuklear by first calling `nk_input_begin`
|
||||||
which resets internal state like delta mouse position and button transitions.
|
which resets internal state like delta mouse position and button transistions.
|
||||||
After `nk_input_begin` all current input state needs to be provided. This includes
|
After `nk_input_begin` all current input state needs to be provided. This includes
|
||||||
mouse motion, button and key pressed and released, text input and scrolling.
|
mouse motion, button and key pressed and released, text input and scrolling.
|
||||||
Both event- or state-based input handling are supported by this API
|
Both event- or state-based input handling are supported by this API
|
||||||
|
@ -355,7 +355,7 @@ __nk_input_unicode__| Adds a single unicode rune into an internal text buffer
|
||||||
__nk_input_end__ | Ends the input mirroring process by calculating state changes. Don't call any `nk_input_xxx` function referenced above after this call
|
__nk_input_end__ | Ends the input mirroring process by calculating state changes. Don't call any `nk_input_xxx` function referenced above after this call
|
||||||
#### nk_input_begin
|
#### nk_input_begin
|
||||||
Begins the input mirroring process by resetting text, scroll
|
Begins the input mirroring process by resetting text, scroll
|
||||||
mouse previous mouse position and movement as well as key state transitions,
|
mouse, previous mouse position and movement as well as key state transitions,
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
||||||
void nk_input_begin(struct nk_context*);
|
void nk_input_begin(struct nk_context*);
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
@ -373,7 +373,7 @@ __ctx__ | Must point to a previously initialized `nk_context` struct
|
||||||
__x__ | Must hold an integer describing the current mouse cursor x-position
|
__x__ | Must hold an integer describing the current mouse cursor x-position
|
||||||
__y__ | Must hold an integer describing the current mouse cursor y-position
|
__y__ | Must hold an integer describing the current mouse cursor y-position
|
||||||
#### nk_input_key
|
#### nk_input_key
|
||||||
Mirrors state of a specific key to nuklear
|
Mirrors the state of a specific key to nuklear
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
||||||
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);
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
@ -397,6 +397,7 @@ __down__ | Must be 0 for key is up and 1 for key is down
|
||||||
#### nk_input_scroll
|
#### nk_input_scroll
|
||||||
Copies the last mouse scroll value to nuklear. Is generally
|
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
|
a scroll value. So does not have to come from mouse and could also originate
|
||||||
|
TODO finish this sentence
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
||||||
void nk_input_scroll(struct nk_context *ctx, struct nk_vec2 val);
|
void nk_input_scroll(struct nk_context *ctx, struct nk_vec2 val);
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
@ -443,7 +444,7 @@ __ctx__ | Must point to a previously initialized `nk_context` struct
|
||||||
__rune__ | UTF-32 unicode codepoint
|
__rune__ | UTF-32 unicode codepoint
|
||||||
#### nk_input_end
|
#### nk_input_end
|
||||||
End the input mirroring process by resetting mouse grabbing
|
End the input mirroring process by resetting mouse grabbing
|
||||||
state to ensure the mouse cursor is not grabbed indefinitely.///
|
state to ensure the mouse cursor is not grabbed indefinitely.
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
||||||
void nk_input_end(struct nk_context *ctx);
|
void nk_input_end(struct nk_context *ctx);
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
@ -666,7 +667,7 @@ Parameter | Description
|
||||||
__ctx__ | must point to an previously initialized `nk_context` struct at the end of a frame
|
__ctx__ | must point to an previously initialized `nk_context` struct at the end of a frame
|
||||||
Returns draw command pointer pointing to the first command inside the draw command list
|
Returns draw command pointer pointing to the first command inside the draw command list
|
||||||
#### nk__next
|
#### nk__next
|
||||||
Returns a draw command list iterator to iterate all draw
|
Returns draw command pointer pointing to the next command inside the draw command list
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
||||||
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*);
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
@ -684,7 +685,7 @@ Parameter | Description
|
||||||
------------|-----------------------------------------------------------
|
------------|-----------------------------------------------------------
|
||||||
__ctx__ | Must point to an previously initialized `nk_context` struct at the end of a frame
|
__ctx__ | Must point to an previously initialized `nk_context` struct at the end of a frame
|
||||||
__cmd__ | Command pointer initialized to NULL
|
__cmd__ | Command pointer initialized to NULL
|
||||||
Returns draw command pointer pointing to the next command inside the draw command list
|
Iterates over each draw command inside the context draw command list
|
||||||
#### nk_convert
|
#### nk_convert
|
||||||
Converts all internal draw commands into vertex draw commands and fills
|
Converts all internal draw commands into vertex draw commands and fills
|
||||||
three buffers with vertexes, vertex draw commands and vertex indices. The vertex format
|
three buffers with vertexes, vertex draw commands and vertex indices. The vertex format
|
||||||
|
@ -709,7 +710,7 @@ NK_CONVERT_COMMAND_BUFFER_FULL | The provided buffer for storing draw commands
|
||||||
NK_CONVERT_VERTEX_BUFFER_FULL | The provided buffer for storing vertices is full or failed to allocate more memory
|
NK_CONVERT_VERTEX_BUFFER_FULL | The provided buffer for storing vertices is full or failed to allocate more memory
|
||||||
NK_CONVERT_ELEMENT_BUFFER_FULL | The provided buffer for storing indicies is full or failed to allocate more memory
|
NK_CONVERT_ELEMENT_BUFFER_FULL | The provided buffer for storing indicies is full or failed to allocate more memory
|
||||||
#### nk__draw_begin
|
#### nk__draw_begin
|
||||||
Returns a draw vertex command buffer iterator to iterate each the vertex draw command buffer
|
Returns a draw vertex command buffer iterator to iterate over the vertex draw command buffer
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
||||||
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*);
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
@ -752,7 +753,7 @@ __ctx__ | Must point to an previously initialized `nk_context` struct at the
|
||||||
### Window
|
### Window
|
||||||
Windows are the main persistent state used inside nuklear and are life time
|
Windows are the main persistent state used inside nuklear and are life time
|
||||||
controlled by simply "retouching" (i.e. calling) each window each frame.
|
controlled by simply "retouching" (i.e. calling) each window each frame.
|
||||||
All widgets inside nuklear can only be added inside function pair `nk_begin_xxx`
|
All widgets inside nuklear can only be added inside the function pair `nk_begin_xxx`
|
||||||
and `nk_end`. Calling any widgets outside these two functions will result in an
|
and `nk_end`. Calling any widgets outside these two functions will result in an
|
||||||
assert in debug or no state change in release mode.<br /><br />
|
assert in debug or no state change in release mode.<br /><br />
|
||||||
Each window holds frame persistent state like position, size, flags, state tables,
|
Each window holds frame persistent state like position, size, flags, state tables,
|
||||||
|
@ -889,7 +890,7 @@ 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
|
#### nk_begin_titled
|
||||||
Extended window start with separated title and identifier to allow multiple
|
Extended window start with separated title and identifier to allow multiple
|
||||||
windows with same name but not title
|
windows with same title but not name
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
||||||
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);
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
@ -921,7 +922,7 @@ Parameter | Description
|
||||||
__ctx__ | Must point to an previously initialized `nk_context` struct
|
__ctx__ | Must point to an previously initialized `nk_context` struct
|
||||||
__name__ | Window identifier
|
__name__ | Window identifier
|
||||||
Returns a `nk_window` struct pointing to the identified window or NULL if
|
Returns a `nk_window` struct pointing to the identified window or NULL if
|
||||||
no window with given name was found
|
no window with the given name was found
|
||||||
#### nk_window_get_bounds
|
#### nk_window_get_bounds
|
||||||
Returns a rectangle with screen position and size of the currently processed window
|
Returns a rectangle with screen position and size of the currently processed window
|
||||||
!!! WARNING
|
!!! WARNING
|
||||||
|
@ -933,7 +934,7 @@ Parameter | Description
|
||||||
------------|-----------------------------------------------------------
|
------------|-----------------------------------------------------------
|
||||||
__ctx__ | Must point to an previously initialized `nk_context` struct
|
__ctx__ | Must point to an previously initialized `nk_context` struct
|
||||||
Returns a `nk_rect` struct with window upper left window position and size
|
Returns a `nk_rect` struct with window upper left window position and size
|
||||||
#### nk_window_get_bounds
|
#### nk_window_get_position
|
||||||
Returns the position of the currently processed window.
|
Returns the position of the currently processed window.
|
||||||
!!! WARNING
|
!!! WARNING
|
||||||
Only call this function between calls `nk_begin_xxx` and `nk_end`
|
Only call this function between calls `nk_begin_xxx` and `nk_end`
|
||||||
|
@ -982,7 +983,7 @@ Returns the underlying panel which contains all processing state of the current
|
||||||
!!! WARNING
|
!!! WARNING
|
||||||
Only call this function between calls `nk_begin_xxx` and `nk_end`
|
Only call this function between calls `nk_begin_xxx` and `nk_end`
|
||||||
!!! WARNING
|
!!! WARNING
|
||||||
Do not keep the returned panel pointer around it is only valid until `nk_end`
|
Do not keep the returned panel pointer around, it is only valid until `nk_end`
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
||||||
struct nk_panel* nk_window_get_panel(struct nk_context *ctx);
|
struct nk_panel* nk_window_get_panel(struct nk_context *ctx);
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
@ -1520,7 +1521,7 @@ Parameter | Description
|
||||||
__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx`
|
__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx`
|
||||||
__height__ | Holds height of each widget in row or zero for auto layouting
|
__height__ | Holds height of each widget in row or zero for auto layouting
|
||||||
__columns__ | Number of widget inside row
|
__columns__ | Number of widget inside row
|
||||||
#### nk_layout_row_dynamic
|
#### nk_layout_row_static
|
||||||
Sets current row layout to fill @cols number of widgets
|
Sets current row layout to fill @cols number of widgets
|
||||||
in row with same @item_width horizontal size. Once called all subsequent widget
|
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.
|
calls greater than @cols will allocate a new row with same layout.
|
||||||
|
@ -1663,7 +1664,7 @@ Parameter | Description
|
||||||
__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_layout_space_begin`
|
__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_layout_space_begin`
|
||||||
__vec__ | Position to convert from layout space into screen coordinate space
|
__vec__ | Position to convert from layout space into screen coordinate space
|
||||||
Returns transformed `nk_vec2` in screen space coordinates
|
Returns transformed `nk_vec2` in screen space coordinates
|
||||||
#### nk_layout_space_to_screen
|
#### nk_layout_space_to_local
|
||||||
Converts vector from layout space into screen space
|
Converts vector from layout space into screen space
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
||||||
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);
|
||||||
|
|
|
@ -1083,6 +1083,12 @@ NK_API void nk_input_end(struct nk_context*);
|
||||||
///
|
///
|
||||||
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
||||||
/// // fill configuration
|
/// // fill configuration
|
||||||
|
// struct your_vertex
|
||||||
|
// {
|
||||||
|
// float pos[2]; // important to keep it to 2 floats
|
||||||
|
// float uv[2];
|
||||||
|
// unsigned char col[4];
|
||||||
|
// };
|
||||||
/// struct nk_convert_config cfg = {};
|
/// struct nk_convert_config cfg = {};
|
||||||
/// static const struct nk_draw_vertex_layout_element vertex_layout[] = {
|
/// static const struct nk_draw_vertex_layout_element vertex_layout[] = {
|
||||||
/// {NK_VERTEX_POSITION, NK_FORMAT_FLOAT, NK_OFFSETOF(struct your_vertex, pos)},
|
/// {NK_VERTEX_POSITION, NK_FORMAT_FLOAT, NK_OFFSETOF(struct your_vertex, pos)},
|
||||||
|
@ -1426,7 +1432,7 @@ NK_API const struct nk_draw_command* nk__draw_next(const struct nk_draw_command*
|
||||||
/// NK_WINDOW_TITLE | Forces a header at the top at the window showing the title
|
/// NK_WINDOW_TITLE | Forces a header at the top at the window showing the title
|
||||||
/// NK_WINDOW_SCROLL_AUTO_HIDE | Automatically hides the window scrollbar if no user interaction: also requires delta time in `nk_context` to be set each frame
|
/// NK_WINDOW_SCROLL_AUTO_HIDE | Automatically hides the window scrollbar if no user interaction: also requires delta time in `nk_context` to be set each frame
|
||||||
/// NK_WINDOW_BACKGROUND | Always keep window in the background
|
/// 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_SCALE_LEFT | Puts window scaler in the left-bottom corner instead right-bottom
|
||||||
/// NK_WINDOW_NO_INPUT | Prevents window of scaling, moving or getting focus
|
/// NK_WINDOW_NO_INPUT | Prevents window of scaling, moving or getting focus
|
||||||
///
|
///
|
||||||
/// #### nk_collapse_states
|
/// #### nk_collapse_states
|
||||||
|
|
|
@ -455,8 +455,8 @@ NK_API void nk_set_user_data(struct nk_context*, nk_handle handle);
|
||||||
/*/// ### Input
|
/*/// ### Input
|
||||||
/// The input API is responsible for holding the current input state composed of
|
/// The input API is responsible for holding the current input state composed of
|
||||||
/// mouse, key and text input states.
|
/// mouse, key and text input states.
|
||||||
/// It is worth noting that no direct os or window handling is done in nuklear.
|
/// It is worth noting that no direct OS or window handling is done in nuklear.
|
||||||
/// Instead all input state has to be provided by platform specific code. This in one hand
|
/// Instead all input state has to be provided by platform specific code. This on one hand
|
||||||
/// expects more work from the user and complicates usage but on the other hand
|
/// expects more work from the user and complicates usage but on the other hand
|
||||||
/// provides simple abstraction over a big number of platforms, libraries and other
|
/// provides simple abstraction over a big number of platforms, libraries and other
|
||||||
/// already provided functionality.
|
/// already provided functionality.
|
||||||
|
@ -557,7 +557,7 @@ enum nk_buttons {
|
||||||
};
|
};
|
||||||
/*/// #### nk_input_begin
|
/*/// #### nk_input_begin
|
||||||
/// Begins the input mirroring process by resetting text, scroll
|
/// Begins the input mirroring process by resetting text, scroll
|
||||||
/// mouse previous mouse position and movement as well as key state transitions,
|
/// mouse, previous mouse position and movement as well as key state transitions,
|
||||||
///
|
///
|
||||||
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
||||||
/// void nk_input_begin(struct nk_context*);
|
/// void nk_input_begin(struct nk_context*);
|
||||||
|
@ -583,7 +583,7 @@ NK_API void nk_input_begin(struct nk_context*);
|
||||||
*/
|
*/
|
||||||
NK_API void nk_input_motion(struct nk_context*, int x, int y);
|
NK_API void nk_input_motion(struct nk_context*, int x, int y);
|
||||||
/*/// #### nk_input_key
|
/*/// #### nk_input_key
|
||||||
/// Mirrors state of a specific key to nuklear
|
/// Mirrors the state of a specific key to nuklear
|
||||||
///
|
///
|
||||||
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
||||||
/// 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);
|
||||||
|
@ -615,6 +615,7 @@ NK_API void nk_input_button(struct nk_context*, enum nk_buttons, int x, int y, i
|
||||||
/*/// #### nk_input_scroll
|
/*/// #### nk_input_scroll
|
||||||
/// Copies the last mouse scroll value to nuklear. Is generally
|
/// 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
|
/// a scroll value. So does not have to come from mouse and could also originate
|
||||||
|
/// TODO finish this sentence
|
||||||
///
|
///
|
||||||
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
||||||
/// void nk_input_scroll(struct nk_context *ctx, struct nk_vec2 val);
|
/// void nk_input_scroll(struct nk_context *ctx, struct nk_vec2 val);
|
||||||
|
@ -679,7 +680,7 @@ NK_API void nk_input_glyph(struct nk_context*, const nk_glyph);
|
||||||
NK_API void nk_input_unicode(struct nk_context*, nk_rune);
|
NK_API void nk_input_unicode(struct nk_context*, nk_rune);
|
||||||
/*/// #### nk_input_end
|
/*/// #### nk_input_end
|
||||||
/// End the input mirroring process by resetting mouse grabbing
|
/// End the input mirroring process by resetting mouse grabbing
|
||||||
/// state to ensure the mouse cursor is not grabbed indefinitely.///
|
/// state to ensure the mouse cursor is not grabbed indefinitely.
|
||||||
///
|
///
|
||||||
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
||||||
/// void nk_input_end(struct nk_context *ctx);
|
/// void nk_input_end(struct nk_context *ctx);
|
||||||
|
@ -953,7 +954,7 @@ struct nk_convert_config {
|
||||||
*/
|
*/
|
||||||
NK_API const struct nk_command* nk__begin(struct nk_context*);
|
NK_API const struct nk_command* nk__begin(struct nk_context*);
|
||||||
/*/// #### nk__next
|
/*/// #### nk__next
|
||||||
/// Returns a draw command list iterator to iterate all draw
|
/// Returns draw command pointer pointing to the next command inside the draw command list
|
||||||
///
|
///
|
||||||
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
||||||
/// 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*);
|
||||||
|
@ -979,7 +980,7 @@ NK_API const struct nk_command* nk__next(struct nk_context*, const struct nk_com
|
||||||
/// __ctx__ | Must point to an previously initialized `nk_context` struct at the end of a frame
|
/// __ctx__ | Must point to an previously initialized `nk_context` struct at the end of a frame
|
||||||
/// __cmd__ | Command pointer initialized to NULL
|
/// __cmd__ | Command pointer initialized to NULL
|
||||||
///
|
///
|
||||||
/// Returns draw command pointer pointing to the next command inside the draw command list
|
/// Iterates over each draw command inside the context draw command list
|
||||||
*/
|
*/
|
||||||
#define nk_foreach(c, ctx) for((c) = nk__begin(ctx); (c) != 0; (c) = nk__next(ctx,c))
|
#define nk_foreach(c, ctx) for((c) = nk__begin(ctx); (c) != 0; (c) = nk__next(ctx,c))
|
||||||
#ifdef NK_INCLUDE_VERTEX_BUFFER_OUTPUT
|
#ifdef NK_INCLUDE_VERTEX_BUFFER_OUTPUT
|
||||||
|
@ -1014,7 +1015,7 @@ NK_API const struct nk_command* nk__next(struct nk_context*, const struct nk_com
|
||||||
*/
|
*/
|
||||||
NK_API nk_flags nk_convert(struct nk_context*, struct nk_buffer *cmds, struct nk_buffer *vertices, struct nk_buffer *elements, const struct nk_convert_config*);
|
NK_API nk_flags nk_convert(struct nk_context*, struct nk_buffer *cmds, struct nk_buffer *vertices, struct nk_buffer *elements, const struct nk_convert_config*);
|
||||||
/*/// #### nk__draw_begin
|
/*/// #### nk__draw_begin
|
||||||
/// Returns a draw vertex command buffer iterator to iterate each the vertex draw command buffer
|
/// Returns a draw vertex command buffer iterator to iterate over the vertex draw command buffer
|
||||||
///
|
///
|
||||||
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
||||||
/// 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*);
|
||||||
|
@ -1082,7 +1083,7 @@ NK_API const struct nk_draw_command* nk__draw_next(const struct nk_draw_command*
|
||||||
/// ### Window
|
/// ### Window
|
||||||
/// Windows are the main persistent state used inside nuklear and are life time
|
/// Windows are the main persistent state used inside nuklear and are life time
|
||||||
/// controlled by simply "retouching" (i.e. calling) each window each frame.
|
/// controlled by simply "retouching" (i.e. calling) each window each frame.
|
||||||
/// All widgets inside nuklear can only be added inside function pair `nk_begin_xxx`
|
/// All widgets inside nuklear can only be added inside the function pair `nk_begin_xxx`
|
||||||
/// and `nk_end`. Calling any widgets outside these two functions will result in an
|
/// and `nk_end`. Calling any widgets outside these two functions will result in an
|
||||||
/// assert in debug or no state change in release mode.<br /><br />
|
/// assert in debug or no state change in release mode.<br /><br />
|
||||||
///
|
///
|
||||||
|
@ -1209,7 +1210,7 @@ NK_API const struct nk_draw_command* nk__draw_next(const struct nk_draw_command*
|
||||||
/// NK_WINDOW_TITLE | Forces a header at the top at the window showing the title
|
/// NK_WINDOW_TITLE | Forces a header at the top at the window showing the title
|
||||||
/// NK_WINDOW_SCROLL_AUTO_HIDE | Automatically hides the window scrollbar if no user interaction: also requires delta time in `nk_context` to be set each frame
|
/// NK_WINDOW_SCROLL_AUTO_HIDE | Automatically hides the window scrollbar if no user interaction: also requires delta time in `nk_context` to be set each frame
|
||||||
/// NK_WINDOW_BACKGROUND | Always keep window in the background
|
/// 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_SCALE_LEFT | Puts window scaler in the left-bottom corner instead right-bottom
|
||||||
/// NK_WINDOW_NO_INPUT | Prevents window of scaling, moving or getting focus
|
/// NK_WINDOW_NO_INPUT | Prevents window of scaling, moving or getting focus
|
||||||
///
|
///
|
||||||
/// #### nk_collapse_states
|
/// #### nk_collapse_states
|
||||||
|
@ -1253,7 +1254,7 @@ enum nk_panel_flags {
|
||||||
NK_API int nk_begin(struct nk_context *ctx, const char *title, struct nk_rect bounds, nk_flags flags);
|
NK_API int nk_begin(struct nk_context *ctx, const char *title, struct nk_rect bounds, nk_flags flags);
|
||||||
/*/// #### nk_begin_titled
|
/*/// #### nk_begin_titled
|
||||||
/// Extended window start with separated title and identifier to allow multiple
|
/// Extended window start with separated title and identifier to allow multiple
|
||||||
/// windows with same name but not title
|
/// windows with same title but not name
|
||||||
///
|
///
|
||||||
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
||||||
/// 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);
|
||||||
|
@ -1297,12 +1298,12 @@ NK_API void nk_end(struct nk_context *ctx);
|
||||||
/// __name__ | Window identifier
|
/// __name__ | Window identifier
|
||||||
///
|
///
|
||||||
/// Returns a `nk_window` struct pointing to the identified window or NULL if
|
/// Returns a `nk_window` struct pointing to the identified window or NULL if
|
||||||
/// no window with given name was found
|
/// no window with the given name was found
|
||||||
*/
|
*/
|
||||||
NK_API struct nk_window *nk_window_find(struct nk_context *ctx, const char *name);
|
NK_API struct nk_window *nk_window_find(struct nk_context *ctx, const char *name);
|
||||||
/*/// #### nk_window_get_bounds
|
/*/// #### nk_window_get_bounds
|
||||||
///
|
|
||||||
/// Returns a rectangle with screen position and size of the currently processed window
|
/// Returns a rectangle with screen position and size of the currently processed window
|
||||||
|
///
|
||||||
/// !!! WARNING
|
/// !!! WARNING
|
||||||
/// Only call this function between calls `nk_begin_xxx` and `nk_end`
|
/// Only call this function between calls `nk_begin_xxx` and `nk_end`
|
||||||
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
||||||
|
@ -1316,9 +1317,9 @@ NK_API struct nk_window *nk_window_find(struct nk_context *ctx, const char *name
|
||||||
/// Returns a `nk_rect` struct with window upper left window position and size
|
/// Returns a `nk_rect` struct with window upper left window position and size
|
||||||
*/
|
*/
|
||||||
NK_API struct nk_rect nk_window_get_bounds(const struct nk_context *ctx);
|
NK_API struct nk_rect nk_window_get_bounds(const struct nk_context *ctx);
|
||||||
/*/// #### nk_window_get_bounds
|
/*/// #### nk_window_get_position
|
||||||
///
|
|
||||||
/// Returns the position of the currently processed window.
|
/// Returns the position of the currently processed window.
|
||||||
|
///
|
||||||
/// !!! WARNING
|
/// !!! WARNING
|
||||||
/// Only call this function between calls `nk_begin_xxx` and `nk_end`
|
/// Only call this function between calls `nk_begin_xxx` and `nk_end`
|
||||||
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
||||||
|
@ -1333,8 +1334,8 @@ NK_API struct nk_rect nk_window_get_bounds(const struct nk_context *ctx);
|
||||||
*/
|
*/
|
||||||
NK_API struct nk_vec2 nk_window_get_position(const struct nk_context *ctx);
|
NK_API struct nk_vec2 nk_window_get_position(const struct nk_context *ctx);
|
||||||
/*/// #### nk_window_get_size
|
/*/// #### nk_window_get_size
|
||||||
///
|
|
||||||
/// Returns the size with width and height of the currently processed window.
|
/// Returns the size with width and height of the currently processed window.
|
||||||
|
///
|
||||||
/// !!! WARNING
|
/// !!! WARNING
|
||||||
/// Only call this function between calls `nk_begin_xxx` and `nk_end`
|
/// Only call this function between calls `nk_begin_xxx` and `nk_end`
|
||||||
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
||||||
|
@ -1349,8 +1350,8 @@ NK_API struct nk_vec2 nk_window_get_position(const struct nk_context *ctx);
|
||||||
*/
|
*/
|
||||||
NK_API struct nk_vec2 nk_window_get_size(const struct nk_context*);
|
NK_API struct nk_vec2 nk_window_get_size(const struct nk_context*);
|
||||||
/*/// #### nk_window_get_width
|
/*/// #### nk_window_get_width
|
||||||
///
|
|
||||||
/// Returns the width of the currently processed window.
|
/// Returns the width of the currently processed window.
|
||||||
|
///
|
||||||
/// !!! WARNING
|
/// !!! WARNING
|
||||||
/// Only call this function between calls `nk_begin_xxx` and `nk_end`
|
/// Only call this function between calls `nk_begin_xxx` and `nk_end`
|
||||||
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
||||||
|
@ -1365,8 +1366,8 @@ NK_API struct nk_vec2 nk_window_get_size(const struct nk_context*);
|
||||||
*/
|
*/
|
||||||
NK_API float nk_window_get_width(const struct nk_context*);
|
NK_API float nk_window_get_width(const struct nk_context*);
|
||||||
/*/// #### nk_window_get_height
|
/*/// #### nk_window_get_height
|
||||||
///
|
|
||||||
/// Returns the height of the currently processed window.
|
/// Returns the height of the currently processed window.
|
||||||
|
///
|
||||||
/// !!! WARNING
|
/// !!! WARNING
|
||||||
/// Only call this function between calls `nk_begin_xxx` and `nk_end`
|
/// Only call this function between calls `nk_begin_xxx` and `nk_end`
|
||||||
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
||||||
|
@ -1381,12 +1382,12 @@ NK_API float nk_window_get_width(const struct nk_context*);
|
||||||
*/
|
*/
|
||||||
NK_API float nk_window_get_height(const struct nk_context*);
|
NK_API float nk_window_get_height(const struct nk_context*);
|
||||||
/*/// #### nk_window_get_panel
|
/*/// #### nk_window_get_panel
|
||||||
///
|
|
||||||
/// Returns the underlying panel which contains all processing state of the current window.
|
/// Returns the underlying panel which contains all processing state of the current window.
|
||||||
|
///
|
||||||
/// !!! WARNING
|
/// !!! WARNING
|
||||||
/// Only call this function between calls `nk_begin_xxx` and `nk_end`
|
/// Only call this function between calls `nk_begin_xxx` and `nk_end`
|
||||||
/// !!! WARNING
|
/// !!! WARNING
|
||||||
/// Do not keep the returned panel pointer around it is only valid until `nk_end`
|
/// Do not keep the returned panel pointer around, it is only valid until `nk_end`
|
||||||
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
||||||
/// struct nk_panel* nk_window_get_panel(struct nk_context *ctx);
|
/// struct nk_panel* nk_window_get_panel(struct nk_context *ctx);
|
||||||
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
@ -1399,9 +1400,9 @@ NK_API float nk_window_get_height(const struct nk_context*);
|
||||||
*/
|
*/
|
||||||
NK_API struct nk_panel* nk_window_get_panel(struct nk_context*);
|
NK_API struct nk_panel* nk_window_get_panel(struct nk_context*);
|
||||||
/*/// #### nk_window_get_content_region
|
/*/// #### nk_window_get_content_region
|
||||||
///
|
|
||||||
/// Returns the position and size of the currently visible and non-clipped space
|
/// Returns the position and size of the currently visible and non-clipped space
|
||||||
/// inside the currently processed window.
|
/// inside the currently processed window.
|
||||||
|
///
|
||||||
/// !!! WARNING
|
/// !!! WARNING
|
||||||
/// Only call this function between calls `nk_begin_xxx` and `nk_end`
|
/// Only call this function between calls `nk_begin_xxx` and `nk_end`
|
||||||
///
|
///
|
||||||
|
@ -1418,9 +1419,9 @@ NK_API struct nk_panel* nk_window_get_panel(struct nk_context*);
|
||||||
*/
|
*/
|
||||||
NK_API struct nk_rect nk_window_get_content_region(struct nk_context*);
|
NK_API struct nk_rect nk_window_get_content_region(struct nk_context*);
|
||||||
/*/// #### nk_window_get_content_region_min
|
/*/// #### nk_window_get_content_region_min
|
||||||
///
|
|
||||||
/// Returns the upper left position of the currently visible and non-clipped
|
/// Returns the upper left position of the currently visible and non-clipped
|
||||||
/// space inside the currently processed window.
|
/// space inside the currently processed window.
|
||||||
|
///
|
||||||
/// !!! WARNING
|
/// !!! WARNING
|
||||||
/// Only call this function between calls `nk_begin_xxx` and `nk_end`
|
/// Only call this function between calls `nk_begin_xxx` and `nk_end`
|
||||||
///
|
///
|
||||||
|
@ -1437,9 +1438,9 @@ NK_API struct nk_rect nk_window_get_content_region(struct nk_context*);
|
||||||
*/
|
*/
|
||||||
NK_API struct nk_vec2 nk_window_get_content_region_min(struct nk_context*);
|
NK_API struct nk_vec2 nk_window_get_content_region_min(struct nk_context*);
|
||||||
/*/// #### nk_window_get_content_region_max
|
/*/// #### nk_window_get_content_region_max
|
||||||
///
|
|
||||||
/// Returns the lower right screen position of the currently visible and
|
/// Returns the lower right screen position of the currently visible and
|
||||||
/// non-clipped space inside the currently processed window.
|
/// non-clipped space inside the currently processed window.
|
||||||
|
///
|
||||||
/// !!! WARNING
|
/// !!! WARNING
|
||||||
/// Only call this function between calls `nk_begin_xxx` and `nk_end`
|
/// Only call this function between calls `nk_begin_xxx` and `nk_end`
|
||||||
///
|
///
|
||||||
|
@ -1456,9 +1457,9 @@ NK_API struct nk_vec2 nk_window_get_content_region_min(struct nk_context*);
|
||||||
*/
|
*/
|
||||||
NK_API struct nk_vec2 nk_window_get_content_region_max(struct nk_context*);
|
NK_API struct nk_vec2 nk_window_get_content_region_max(struct nk_context*);
|
||||||
/*/// #### nk_window_get_content_region_size
|
/*/// #### nk_window_get_content_region_size
|
||||||
///
|
|
||||||
/// Returns the size of the currently visible and non-clipped space inside the
|
/// Returns the size of the currently visible and non-clipped space inside the
|
||||||
/// currently processed window
|
/// currently processed window
|
||||||
|
///
|
||||||
/// !!! WARNING
|
/// !!! WARNING
|
||||||
/// Only call this function between calls `nk_begin_xxx` and `nk_end`
|
/// Only call this function between calls `nk_begin_xxx` and `nk_end`
|
||||||
///
|
///
|
||||||
|
@ -2066,7 +2067,7 @@ NK_API float nk_layout_ratio_from_pixel(struct nk_context*, float pixel_width);
|
||||||
/// __columns__ | Number of widget inside row
|
/// __columns__ | Number of widget inside row
|
||||||
*/
|
*/
|
||||||
NK_API void nk_layout_row_dynamic(struct nk_context *ctx, float height, int cols);
|
NK_API void nk_layout_row_dynamic(struct nk_context *ctx, float height, int cols);
|
||||||
/*/// #### nk_layout_row_dynamic
|
/*/// #### nk_layout_row_static
|
||||||
/// Sets current row layout to fill @cols number of widgets
|
/// Sets current row layout to fill @cols number of widgets
|
||||||
/// in row with same @item_width horizontal size. Once called all subsequent widget
|
/// 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.
|
/// calls greater than @cols will allocate a new row with same layout.
|
||||||
|
@ -2256,7 +2257,7 @@ NK_API struct nk_rect nk_layout_space_bounds(struct nk_context*);
|
||||||
/// Returns transformed `nk_vec2` in screen space coordinates
|
/// Returns transformed `nk_vec2` in screen space coordinates
|
||||||
*/
|
*/
|
||||||
NK_API struct nk_vec2 nk_layout_space_to_screen(struct nk_context*, struct nk_vec2);
|
NK_API struct nk_vec2 nk_layout_space_to_screen(struct nk_context*, struct nk_vec2);
|
||||||
/*/// #### nk_layout_space_to_screen
|
/*/// #### nk_layout_space_to_local
|
||||||
/// Converts vector from layout space into screen space
|
/// Converts vector from layout space into screen space
|
||||||
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
|
||||||
/// 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);
|
||||||
|
|
Loading…
Reference in New Issue