Skip to content

Home

Jump to bottom
github-actions[bot] edited this page May 16, 2026 · 2 revisions

API Reference

Name Description
nk_console
nk_console_message
nk_console_key_data Data specifically used for the Key widget.
nk_console_row_data
nk_console_top_data
nk_console_file_data Custom data for the file widget.
nk_console_knob_data Data for Property and Slider widgets.
nk_console_tree_data
nk_console_color_data
nk_console_file_entry A single file or directory entry stored for the file widget's list view.
nk_console_image_data
nk_console_input_data Data specifically used for the input widget.
nk_console_radio_data Data for the radio button.
nk_console_button_data
nk_console_checkbox_data
nk_console_combobox_data Data for Combobox widgets.
nk_console_event_handler
nk_console_progress_data
nk_console_property_data Data for Property and Slider widgets.
nk_console_textedit_data
nk_console_list_view_data Data associated with a List View Widget.
nk_console_rule_horizontal_data Data for the horizontal rule widget.
nk_console_axis_channel Time accumulator since the last repeated up/down move. State for one analog axis navigation channel (up/down or left/right).

Macros

NK_CONSOLE_TEXTEDIT_MASKED_LENGTH

NK_CONSOLE_TEXTEDIT_MASKED_LENGTH()

How long masked text should be when displayed.

Enumerations

nk_console_event_type

enum nk_console_event_type
Value Description
NK_CONSOLE_EVENT_DESTROYED
NK_CONSOLE_EVENT_CHANGED Triggered when the widget is destroyed.
NK_CONSOLE_EVENT_CLICKED Triggered when the value for the widget is changed.
NK_CONSOLE_EVENT_POST_RENDER_ONCE Triggered when the widget is clicked.
NK_CONSOLE_EVENT_PRE_PARENT_RENDER Triggered after all the widgets have rendered, and the event is removed.
NK_CONSOLE_EVENT_FOCUS Triggered before the parent widget is rendered.
NK_CONSOLE_EVENT_BLUR Triggered when the widget gains focus/becomes the active widget.
NK_CONSOLE_EVENT_BACK Triggered when the widget loses focus/is no longer the active widget.

The type of events that can be triggered.

See also: nk_console_add_event()

nk_console_widget_type

enum nk_console_widget_type
Value Description
NK_CONSOLE_UNKNOWN
NK_CONSOLE_PARENT
NK_CONSOLE_LABEL
NK_CONSOLE_BUTTON
NK_CONSOLE_CHECKBOX
NK_CONSOLE_PROGRESS
NK_CONSOLE_COMBOBOX
NK_CONSOLE_PROPERTY_INT
NK_CONSOLE_PROPERTY_FLOAT
NK_CONSOLE_SLIDER_INT
NK_CONSOLE_SLIDER_FLOAT
NK_CONSOLE_ROW
NK_CONSOLE_TEXTEDIT
NK_CONSOLE_TEXTEDIT_TEXT
NK_CONSOLE_FILE
NK_CONSOLE_IMAGE
NK_CONSOLE_SPACING
NK_CONSOLE_COLOR
NK_CONSOLE_INPUT
NK_CONSOLE_INPUT_ACTIVE
NK_CONSOLE_KEY
NK_CONSOLE_KEY_ACTIVE
NK_CONSOLE_RADIO
NK_CONSOLE_KNOB_INT
NK_CONSOLE_KNOB_FLOAT
NK_CONSOLE_RULE_HORIZONTAL
NK_CONSOLE_TREE
NK_CONSOLE_LIST_VIEW

Typedefs

nk_console_event

using nk_console_event = void(*

Event handler for a console widget.

Parameters

  • widget The widget that was acted upon.

  • user_data Custom user data that is associated with the event.

See also: nk_console_add_event()

See also: nk_console_add_event_handler()

See also: nk_console_trigger_event()

nk_console_event_handler

using nk_console_event_handler = struct nk_console_event_handler

nk_console_render_event

using nk_console_render_event = struct nk_rect(*

A callback to render the given widget.

Parameters

  • widget The widget that is being rendered.

Returns

The bounds of the widget.

nk_console_message

using nk_console_message = struct nk_console_message

nk_console

using nk_console = struct nk_console

nk_console_top_data

using nk_console_top_data = struct nk_console_top_data

nk_console_key_data

using nk_console_key_data = struct nk_console_key_data

Data specifically used for the Key widget.

Stored value convention for out_key: 0 = NK_KEY_NONE (nothing captured) 1 .. NK_KEY_MAX = nk_keys special key (arrows, Enter, Backspace, etc.) NK_KEY_MAX = Unicode codepoint of a typed character

See also: nk_console_key()

nk_console_row_data

using nk_console_row_data = struct nk_console_row_data

nk_console_file_entry

using nk_console_file_entry = struct nk_console_file_entry

A single file or directory entry stored for the file widget's list view.

nk_console_file_data

using nk_console_file_data = struct nk_console_file_data

Custom data for the file widget.

nk_console_knob_data

using nk_console_knob_data = struct nk_console_knob_data

Data for Property and Slider widgets.

nk_console_tree_data

using nk_console_tree_data = struct nk_console_tree_data

nk_console_color_data

using nk_console_color_data = struct nk_console_color_data

nk_console_image_data

using nk_console_image_data = struct nk_console_image_data

nk_console_input_data

using nk_console_input_data = struct nk_console_input_data

Data specifically used for the input widget.

See also: nk_console_input()

nk_console_radio_data

using nk_console_radio_data = struct nk_console_radio_data

Data for the radio button.

See also: nk_console_radio()

nk_console_button_data

using nk_console_button_data = struct nk_console_button_data

nk_console_checkbox_data

using nk_console_checkbox_data = struct nk_console_checkbox_data

nk_console_combobox_data

using nk_console_combobox_data = struct nk_console_combobox_data

Data for Combobox widgets.

nk_console_progress_data

using nk_console_progress_data = struct nk_console_progress_data

nk_console_property_data

using nk_console_property_data = struct nk_console_property_data

Data for Property and Slider widgets.

nk_console_textedit_data

using nk_console_textedit_data = struct nk_console_textedit_data

nk_console_list_view_get_label

using nk_console_list_view_get_label = const char *(*

Callback that will be used to retrieve the label of a given list view item.

Parameters

  • list_view The list view widget.

  • index Which row to get the label for.

Returns

The label for the item.

See also: nk_console_list_view_data

nk_console_list_view_data

using nk_console_list_view_data = struct nk_console_list_view_data

Data associated with a List View Widget.

nk_console_rule_horizontal_data

using nk_console_rule_horizontal_data = struct nk_console_rule_horizontal_data

Data for the horizontal rule widget.

See also: nk_console_rule_horizontal()

Functions

nk_console_init

NK_API nk_console * nk_console_init(struct nk_context * context)

nk_console_free

NK_API void nk_console_free(nk_console * console)

nk_console_render

NK_API void nk_console_render(nk_console * console)

nk_console_render_window

NK_API struct nk_rect nk_console_render_window(nk_console * console, const char * title, struct nk_rect bounds, nk_uint flags)

nk_console_get_top

NK_API nk_console * nk_console_get_top(nk_console * widget)

nk_console_get_widget_index

NK_API int nk_console_get_widget_index(nk_console * widget)

nk_console_check_tooltip

NK_API void nk_console_check_tooltip(nk_console * console)

nk_console_check_up_down

NK_API void nk_console_check_up_down(nk_console * widget)

nk_console_is_active_widget

NK_API nk_bool nk_console_is_active_widget(nk_console * widget)

nk_console_active_parent

NK_API nk_console * nk_console_active_parent(nk_console * console)

nk_console_set_active_parent

NK_API void nk_console_set_active_parent(nk_console * new_parent)

nk_console_set_active_widget

NK_API void nk_console_set_active_widget(nk_console * widget)

nk_console_get_active_widget

NK_API nk_console * nk_console_get_active_widget(nk_console * widget)

nk_console_malloc

NK_API void * nk_console_malloc(nk_handle unused, void * old, nk_size size)

nk_console_mfree

NK_API void nk_console_mfree(nk_handle unused, void * ptr)

nk_console_button_pushed

NK_API nk_bool nk_console_button_pushed(nk_console * console, int button)

nk_console_button_down

NK_API nk_bool nk_console_button_down(nk_console * console, int button)

nk_console_set_gamepads

NK_API void nk_console_set_gamepads(nk_console * console, struct nk_gamepads * gamepads)

nk_console_get_gamepads

NK_API struct nk_gamepads * nk_console_get_gamepads(nk_console * console)

nk_console_set_gamepad_num

NK_API void nk_console_set_gamepad_num(nk_console * console, int num)

nk_console_get_gamepad_num

NK_API int nk_console_get_gamepad_num(nk_console * console)

nk_console_set_tooltip

NK_API void nk_console_set_tooltip(nk_console * widget, const char * tooltip)

nk_console_set_label

NK_API void nk_console_set_label(nk_console * widget, const char * label, int label_length)

nk_console_get_label

NK_API const char * nk_console_get_label(nk_console * widget)

nk_console_free_children

NK_API void nk_console_free_children(nk_console * console)

nk_console_layout_widget

NK_API void nk_console_layout_widget(nk_console * widget)

nk_console_add_child

NK_API void nk_console_add_child(nk_console * parent, nk_console * child)

nk_console_set_height

NK_API void nk_console_set_height(nk_console * widget, int height)

nk_console_height

NK_API int nk_console_height(nk_console * widget)

nk_console_selectable

NK_API nk_bool nk_console_selectable(nk_console * widget)

nk_console_trigger_event

NK_API nk_bool nk_console_trigger_event(nk_console * widget, nk_console_event_type type)

nk_console_add_event

NK_API void nk_console_add_event(nk_console * widget, nk_console_event_type type, nk_console_event callback)

nk_console_add_event_handler

NK_API void nk_console_add_event_handler(nk_console * widget, nk_console_event_type type, nk_console_event callback, void * user_data, nk_console_event destructor)

nk_console_event_handler_destroy

NK_API void nk_console_event_handler_destroy(nk_console * widget, nk_console_event_handler * handler)

nk_console_user_data

NK_API void * nk_console_user_data(nk_console * console)

Get the user data for the top-level console.

Parameters

  • console Any widget within the console family.

Returns

The custom user data.

nk_console_set_user_data

NK_API void nk_console_set_user_data(nk_console * console, void * user_data)

Set the user data for the top-level console.

Parameters

  • console Any widget within the console family.

  • user_data The custom user data to set.

nk_console_navigate_back

NK_API void nk_console_navigate_back(nk_console * leaving_parent)

Navigate back from the given widget to its parent, triggering NK_CONSOLE_EVENT_BACK.

The event is triggered after the new parent is selected.

Parameters

  • leaving_parent The active parent widget being navigated away from.

See also: NK_CONSOLE_EVENT_BACK

See also: nk_console_button_back()

nk_console_find_by_path

NK_API nk_console * nk_console_find_by_path(nk_console * console, const char * path)

Get a widget by a slash-separated path of labels, starting from the top-level console.

Example: nk_console_find_by_path(console, "Widgets/Labels") A leading slash is optional: "/Widgets" and "Widgets" are equivalent.

Parameters

  • console Any widget within the console family.

  • path Slash-separated widget labels (e.g. "Widgets/Labels").

Returns

The matching widget, or NULL if not found.

nk_console_navigate_to_path

NK_API nk_bool nk_console_navigate_to_path(nk_console * console, const char * path)

Navigate to a widget by a slash-separated path of labels.

If the target widget has children, it becomes the active parent. If it has no children, its parent becomes the active parent and the widget is selected as the active widget.

Example: nk_console_navigate_to_path(console, "Widgets/Labels")

Parameters

  • console Any widget within the console family.

  • path Slash-separated widget labels (e.g. "Widgets/Labels").

Returns

nk_true if navigation succeeded, nk_false if the path was not found.

nk_console_key

NK_API nk_console * nk_console_key(nk_console * parent, const char * label, nk_rune * out_key)

Create a new Key widget to capture a keyboard key or typed character.

Parameters

  • parent The parent console.

  • label The label to display.

  • out_key Where to store the captured key.

Returns

The new key widget.

nk_console_key_render

NK_API struct nk_rect nk_console_key_render(nk_console * widget)

nk_console_key_name

NK_API const char * nk_console_key_name(nk_rune key)

Retrieves the name of the of the given Nuklear rune.

nk_console_key_set_default

NK_API void nk_console_key_set_default(nk_console * widget, nk_rune key)

Set the default key value assigned to out_key when the capture prompt times out. Defaults to NK_KEY_NONE.

nk_console_key_get_default

NK_API nk_rune nk_console_key_get_default(nk_console * widget)

Get the default key value assigned to out_key when the capture prompt times out.

nk_console_row_begin

NK_API nk_console * nk_console_row_begin(nk_console * parent)

Begin a new row in the console.

Parameters

  • parent The parent of which to create the new row.

Returns

The new row.

nk_console_row_end

NK_API void nk_console_row_end(nk_console * row)

End the current row in the console.

Parameters

  • row The row to end.

nk_console_row_render

NK_API struct nk_rect nk_console_row_render(nk_console * console)

nk_console_sdl_update_text_input

NK_API void nk_console_sdl_update_text_input(nk_console * console, SDL_Window * window)

Call once per frame after rendering to sync SDL text input state with the active console widget. Starts text input when a textedit field is active, stops it otherwise.

Compatible with both SDL2 and SDL3. For SDL2, window may be NULL.

nk_console_file

NK_API nk_console * nk_console_file(nk_console * parent, const char * label, char * file_path_buffer, int file_path_buffer_size)

Creates a file widget that allows the user to select a file.

Parameters

  • parent The parent widget.

  • label The label for the file widget. For example: "Select a file".

  • file_path_buffer The buffer to store the file path.

  • file_path_buffer_size The size of the buffer.

Returns

The new file widget.

nk_console_dir

NK_API nk_console * nk_console_dir(nk_console * parent, const char * label, char * dir_buffer, int dir_buffer_size)

Creates a directory widget that allows the user to select a directory.

Parameters

  • parent The parent widget.

  • label The label for the file widget. For example: "Select a directory".

  • dir_buffer The buffer to store the directory path.

  • dir_buffer_size The size of the buffer.

Returns

The new file widget.

nk_console_file_action

NK_API nk_console * nk_console_file_action(nk_console * parent, const char * label, char * file_path_buffer, int file_path_buffer_size)

Creates a file action widget that shows a single full-width button. The label is used as the button text before a file is selected; afterwards the button shows the chosen filename.

Parameters

  • parent The parent widget.

  • label The button label. For example: "Select a file". Pass NULL for the default text.

  • file_path_buffer The buffer to store the file path.

  • file_path_buffer_size The size of the buffer.

Returns

The new file action widget.

nk_console_dir_action

NK_API nk_console * nk_console_dir_action(nk_console * parent, const char * label, char * dir_buffer, int dir_buffer_size)

Creates a directory action widget that shows a single full-width button. The label is used as the button text before a directory is selected; afterwards the button shows the chosen directory.

Parameters

  • parent The parent widget.

  • label The button label. For example: "Select a directory". Pass NULL for the default text.

  • dir_buffer The buffer to store the directory path.

  • dir_buffer_size The size of the buffer.

Returns

The new directory action widget.

nk_console_file_render

NK_API struct nk_rect nk_console_file_render(nk_console * widget)

Render callback to display the file widget.

nk_console_file_set_file_user_data

NK_API void nk_console_file_set_file_user_data(nk_console * file, void * user_data)

Sets any custom user data specifically for the file widget.

This can be helpful for storing additional file system data for the file widget.

Parameters

  • file The file widget.

  • user_data The custom user data.

nk_console_file_get_file_user_data

NK_API void * nk_console_file_get_file_user_data(nk_console * file)

Gets the custom user data specifically for the file widget.

Parameters

  • file The file widget.

Returns

The custom user data.

nk_console_file_add_entry

NK_API nk_console * nk_console_file_add_entry(nk_console * parent, const char * path, nk_bool is_directory)

Add an individual file or directory entry to the given file widget's list view.

This should be called from the file system callbacks. See [nuklear_console_file_system.h](#nuklear_console_file_systemh) for examples.

Parameters

  • parent The file widget.

  • path The path to the file or directory.

  • is_directory True if the path is a directory. False otherwise.

Returns

Non-NULL if the entry was successfully added, NULL otherwise.

See also: nk_console_file_add_files_tinydir()

See also: nk_console_file_add_files_raylib()

nk_console_file_set_list_view

NK_API void nk_console_file_set_list_view(nk_console * file, nk_bool use_list_view)

Sets whether the file/directory widget uses a list view or buttons for file selection.

Parameters

  • file The file widget.

  • use_list_view True to use a list view, false to use buttons (the default).

nk_console_file_get_list_view

NK_API nk_bool nk_console_file_get_list_view(nk_console * file)

Gets whether the file/directory widget is using a list view for file selection.

Parameters

  • file The file widget.

Returns

True if using a list view, false if using buttons (the default).

nk_console_file_set_directory

NK_API void nk_console_file_set_directory(nk_console * file, const char * directory)

Sets the starting directory the file browser opens at when activated.

When set, this overrides the directory derived from the buffer value. Pass NULL or an empty string to clear and revert to buffer-derived behavior.

Parameters

  • file The file widget.

  • directory The starting directory path.

nk_console_file_get_directory

NK_API const char * nk_console_file_get_directory(nk_console * file)

Gets the starting directory set via nk_console_file_set_directory().

Parameters

  • file The file widget.

Returns

The starting directory, or an empty string if not set.

nk_console_file_refresh

NK_API void nk_console_file_refresh(nk_console * widget, void * user_data)

Refreshes the file widget with the contents with its given directory.

nk_console_knob_int

NK_API nk_console * nk_console_knob_int(nk_console * parent, const char * label, int min, int * val, int max, int step, float inc_per_pixel)

Creates a Knob widget using an integer value.

nk_console_knob_float

NK_API nk_console * nk_console_knob_float(nk_console * parent, const char * label, float min, float * val, float max, float step, float inc_per_pixel)

Creates a Knob widget using a float value.

nk_console_tree

NK_API nk_console * nk_console_tree(nk_console * parent, const char * label, nk_bool expanded)

Create a Tree widget.

Parameters

  • parent The parent widget.

  • label The label for the widget

  • expanded The starting state of whether or not the tree should be expanded.

Returns

The created widget.

nk_console_tree_expanded

NK_API nk_bool nk_console_tree_expanded(nk_console * tree)

Retrieves whether or not the given tree is expanded.

Parameters

  • tree The tree widget to check against.

Returns

True if the tree is opened, false otherwise.

nk_console_tree_set_expanded

NK_API nk_bool nk_console_tree_set_expanded(nk_console * tree, nk_bool expanded)

Expand or collapse the given tree.

Parameters

  • tree The tree widget to expand/collapse.

  • expanded True to expand the tree, false to collapse.

Returns

True if the tree is now opened, false otherwise.

nk_console_color

NK_API nk_console * nk_console_color(nk_console * parent, const char * label, struct nk_colorf * color, enum nk_color_format format)

Create a color picker widget.

Parameters

  • parent The parent widget.

  • label The label for the widget

  • color A pointer to where the color should be held.

  • format Whether the color should be in RGB or RGBA format.

Returns

The created widget.

nk_console_color_render

NK_API struct nk_rect nk_console_color_render(nk_console * widget)

Render callback to display a color widget.

nk_console_image

NK_API nk_console * nk_console_image(nk_console * parent, struct nk_image image)

nk_console_image_color

NK_API nk_console * nk_console_image_color(nk_console * parent, struct nk_image image, struct nk_color color)

nk_console_image_render

NK_API struct nk_rect nk_console_image_render(nk_console * widget)

nk_console_image_set_image

NK_API void nk_console_image_set_image(nk_console * widget, struct nk_image image)

nk_console_image_get_image

NK_API struct nk_image nk_console_image_get_image(nk_console * widget)

nk_console_image_set_color

NK_API void nk_console_image_set_color(nk_console * widget, struct nk_color color)

nk_console_image_get_color

NK_API struct nk_color nk_console_image_get_color(nk_console * widget)

nk_console_input

NK_API nk_console * nk_console_input(nk_console * parent, const char * label, int gamepad_number, int * out_gamepad_number, enum nk_gamepad_button * out_gamepad_button)

Create a new input widget to get a gamepad button.

Parameters

  • parent The parent console of where to add the widget.

  • label The label to display.

  • gamepad_number The gamepad number to expect input from. Provide -1 for any gamepad.

  • out_gamepad_number When the user enters a button, this is where the gamepad number that was used to press the button.

  • out_gamepad_button When the user enters a button, this is where the gamepad button will be stored.

Todo: Input: Add Keyboard support?

Returns

The new input widget.

nk_console_input_render

NK_API struct nk_rect nk_console_input_render(nk_console * widget)

nk_console_input_set_default

NK_API void nk_console_input_set_default(nk_console * widget, enum nk_gamepad_button gamepad_button)

Set the default gamepad button assigned to out_gamepad_button when the capture prompt times out. Defaults to NK_GAMEPAD_BUTTON_INVALID.

nk_console_input_get_default

NK_API enum nk_gamepad_button nk_console_input_get_default(nk_console * widget)

Get the default gamepad button assigned to out_gamepad_button when the capture prompt times out.

nk_console_label

NK_API nk_console * nk_console_label(nk_console * parent, const char * text)

nk_console_label_render

NK_API struct nk_rect nk_console_label_render(nk_console * widget)

nk_console_radio

NK_API nk_console * nk_console_radio(nk_console * parent, const char * label, int * selected)

Creates a radio button. Use the same selected pointer to indicate the same radio buttons within the radio group.

Parameters

  • parent The parent widget.

  • label The label for the radio button.

  • selected The selected index for the radio button. Provide the same selected index for all radio buttons in the group.

Returns

The radio button widget.

nk_console_radio_render

NK_API struct nk_rect nk_console_radio_render(nk_console * widget)

Renders the radio button.

Parameters

  • widget The radio button widget.

Returns

The bounds of the radio button.

nk_console_radio_is_selected

NK_API nk_bool nk_console_radio_is_selected(nk_console * widget)

Returns true if the radio button is the selected radio in the group.

Parameters

  • widget The radio button widget.

Returns

True if the radio button is selected.

nk_console_radio_index

NK_API int nk_console_radio_index(nk_console * widget)

Returns the index of the radio button in the group.

Parameters

  • widget The radio button widget.

Returns

The index of the radio button.

nk_console_button

NK_API nk_console * nk_console_button(nk_console * parent, const char * text)

nk_console_button_render

NK_API struct nk_rect nk_console_button_render(nk_console * console)

nk_console_button_back

NK_API void nk_console_button_back(nk_console * button, void * user_data)

nk_console_button_onclick

NK_API nk_console * nk_console_button_onclick(nk_console * parent, const char * text, nk_console_event onclick)

nk_console_button_onclick_handler

NK_API nk_console * nk_console_button_onclick_handler(nk_console * parent, const char * text, nk_console_event callback, void * data, nk_console_event destructor)

nk_console_button_get_symbol

NK_API enum nk_symbol_type nk_console_button_get_symbol(nk_console * button)

nk_console_button_set_symbol

NK_API void nk_console_button_set_symbol(nk_console * button, enum nk_symbol_type symbol)

nk_console_button_set_image

NK_API void nk_console_button_set_image(nk_console * button, struct nk_image image)

nk_console_button_get_image

NK_API struct nk_image nk_console_button_get_image(nk_console * button)

nk_console_show_message

NK_API void nk_console_show_message(nk_console * console, const char * text)

Displays a notification message on the screen.

Parameters

  • console The active console system.

  • text The text to display.

nk_console_spacing

NK_API nk_console * nk_console_spacing(nk_console * parent, int cols)

nk_console_spacing_render

NK_API struct nk_rect nk_console_spacing_render(nk_console * widget)

nk_console_checkbox

NK_API nk_console * nk_console_checkbox(nk_console * parent, const char * text, nk_bool * active)

nk_console_checkbox_render

NK_API struct nk_rect nk_console_checkbox_render(nk_console * console)

nk_console_combobox

NK_API nk_console * nk_console_combobox(nk_console * parent, const char * label, const char * items_separated_by_separator, int separator, int * selected)

nk_console_combobox_render

NK_API struct nk_rect nk_console_combobox_render(nk_console * console)

nk_console_combobox_button_click

NK_API void nk_console_combobox_button_click(nk_console * button, void * user_data)

nk_console_combobox_button_main_click

NK_API void nk_console_combobox_button_main_click(nk_console * button, void * user_data)

nk_console_combobox_update

NK_API void nk_console_combobox_update(nk_console * combobox, const char * label, const char * items_separated_by_separator, int separator, int * selected)

nk_console_progress

NK_API nk_console * nk_console_progress(nk_console * parent, const char * text, nk_size * current, nk_size max)

nk_console_progress_render

NK_API struct nk_rect nk_console_progress_render(nk_console * console)

nk_console_property_int

NK_API nk_console * nk_console_property_int(nk_console * parent, const char * label, int min, int * val, int max, int step, float inc_per_pixel)

nk_console_property_float

NK_API nk_console * nk_console_property_float(nk_console * parent, const char * label, float min, float * val, float max, float step, float inc_per_pixel)

nk_console_slider_int

NK_API nk_console * nk_console_slider_int(nk_console * parent, const char * label, int min, int * val, int max, int step)

nk_console_slider_float

NK_API nk_console * nk_console_slider_float(nk_console * parent, const char * label, float min, float * val, float max, float step)

nk_console_property_render

NK_API struct nk_rect nk_console_property_render(nk_console * console)

nk_console_textedit

NK_API nk_console * nk_console_textedit(nk_console * parent, const char * label, char * buffer, int buffer_size)

Adds a textedit on-screen keyboard widget to the console given parent.

Parameters

  • parent The parent widget to add the textedit to.

  • label A string representing the identifier for the associated textedit widget.

  • buffer The buffer to store the textedit data.

  • buffer_size The size of the given buffer.

Returns

The created textedit widget.

nk_console_textedit_masked

NK_API nk_console * nk_console_textedit_masked(nk_console * parent, const char * label, char * buffer, int buffer_size)

nk_console_textedit_render

NK_API struct nk_rect nk_console_textedit_render(nk_console * console)

nk_console_textedit_button_main_click

NK_API void nk_console_textedit_button_main_click(nk_console * button, void * user_data)

nk_console_textedit_button_back_click

NK_API void nk_console_textedit_button_back_click(nk_console * button, void * user_data)

nk_console_textedit_key_click

NK_API void nk_console_textedit_key_click(nk_console * key, void * user_data)

nk_console_list_view

NK_API nk_console * nk_console_list_view(nk_console * parent, const char * id, int rows_visible, nk_uint item_count, nk_console_list_view_get_label get_label_callback)

Creates a List View that can display thousands of items.

Parameters

  • parent Where the element should be placed.

  • id A unique identifier for the list view.

  • rows_visible The number of rows to be shown at any given time.

  • item_count The number of items in the data set.

  • get_label_callback The callback that will be used to retrieve individual labels.

See also: nk_console_list_view_get_label

nk_console_list_view_selected

NK_API nk_uint nk_console_list_view_selected(nk_console * list_view)

Get the currently selected index.

Parameters

  • list_view The List View widget.

Returns

The list view item that the user currently has selected.

nk_console_list_view_selected_label

NK_API const char * nk_console_list_view_selected_label(nk_console * list_view)

Get the currently selected label.

Parameters

  • list_view The List View widget.

Returns

The label associated with the currently selected item.

nk_console_list_view_row_height

NK_API float nk_console_list_view_row_height(nk_console * list_view)

Retrieve that height of an individual row in the list view.

Parameters

  • list_view The List View widget.

Returns

The height of an individual row.

nk_console_list_view_flags

NK_API nk_flags nk_console_list_view_flags(nk_console * list_view)

Retrieve the flags for the given List View Widget.

nk_console_list_view_set_flags

NK_API void nk_console_list_view_set_flags(nk_console * list_view, nk_flags flags)

Set the flags for the given List View Widget.

For example: NK_WINDOW_BORDER, NK_WINDOW_TITLE

nk_console_list_view_set_item_count

NK_API void nk_console_list_view_set_item_count(nk_console * list_view, nk_uint item_count)

nk_console_list_view_item_count

NK_API nk_uint nk_console_list_view_item_count(nk_console * list_view)

nk_console_textedit_text

NK_API nk_console * nk_console_textedit_text(nk_console * textedit)

A TextEdit Text widget is a text field that is displayed as part of the on-screen keyboard.

See also: nk_console_textedit()

nk_console_textedit_text_render

NK_API struct nk_rect nk_console_textedit_text_render(nk_console * widget)

nk_console_rule_horizontal

NK_API nk_console * nk_console_rule_horizontal(nk_console * parent, struct nk_color color, nk_bool rounding)

Line for visual separation. Draws a line with thickness determined by the current row height.

nk_console_rule_horizontal_render

NK_API struct nk_rect nk_console_rule_horizontal_render(nk_console * widget)

Renders the Horizontal Rule.

nk_console

#include <nuklear_console.h>
struct nk_console

Defined in nuklear_console.h:87

List of all members

Name Kind Owner
type variable Declared here
label variable Declared here
label_length variable Declared here
alignment variable Declared here
selectable variable Declared here
disabled variable Declared here
visible variable Declared here
columns variable Declared here
height variable Declared here
tooltip variable Declared here
data variable Declared here
parent variable Declared here
ctx variable Declared here
children variable Declared here
activeWidget variable Declared here
events variable Declared here
render variable Declared here

Public Attributes

Return Name Description
nk_console_widget_type type
const char * label
int label_length
nk_flags alignment
nk_bool selectable
nk_bool disabled Whether or not the widget can be selected.
nk_bool visible Whether or not the widget is currently disabled.
int columns When false, the widget will not be displayed.
int height When set, will determine how many dynamic columns to set to for the active row.
const char * tooltip When set, will determine the height of the row.
void * data Tooltip
struct nk_console * parent Widget-specific data
struct nk_context * ctx
struct nk_console ** children
struct nk_console * activeWidget
nk_console_event_handler * events
nk_console_render_event render Events handled for the widget.

type

nk_console_widget_type type

Defined in nuklear_console.h:88

label

const char * label

Defined in nuklear_console.h:89

label_length

int label_length

Defined in nuklear_console.h:90

alignment

nk_flags alignment

Defined in nuklear_console.h:91

selectable

nk_bool selectable

Defined in nuklear_console.h:93

disabled

nk_bool disabled

Defined in nuklear_console.h:94

Whether or not the widget can be selected.

visible

nk_bool visible

Defined in nuklear_console.h:95

Whether or not the widget is currently disabled.

columns

int columns

Defined in nuklear_console.h:96

When false, the widget will not be displayed.

height

int height

Defined in nuklear_console.h:97

When set, will determine how many dynamic columns to set to for the active row.

tooltip

const char * tooltip

Defined in nuklear_console.h:98

When set, will determine the height of the row.

data

void * data

Defined in nuklear_console.h:99

Tooltip

parent

struct nk_console * parent

Defined in nuklear_console.h:101

Widget-specific data

ctx

struct nk_context * ctx

Defined in nuklear_console.h:102

children

struct nk_console ** children

Defined in nuklear_console.h:103

activeWidget

struct nk_console * activeWidget

Defined in nuklear_console.h:104

events

nk_console_event_handler * events

Defined in nuklear_console.h:107

render

nk_console_render_event render

Defined in nuklear_console.h:108

Events handled for the widget.

nk_console_message

#include <nuklear_console.h>
struct nk_console_message

Defined in nuklear_console.h:82

List of all members

Name Kind Owner
text variable Declared here
duration variable Declared here

Public Attributes

Return Name Description
char text
float duration

text

char text

Defined in nuklear_console.h:83

duration

float duration

Defined in nuklear_console.h:84

nk_console_key_data

#include <nuklear_console_key.h>
struct nk_console_key_data

Defined in nuklear_console_key.h:14

Data specifically used for the Key widget.

Stored value convention for out_key: 0 = NK_KEY_NONE (nothing captured) 1 .. NK_KEY_MAX = nk_keys special key (arrows, Enter, Backspace, etc.) NK_KEY_MAX = Unicode codepoint of a typed character

See also: nk_console_key()

List of all members

Name Kind Owner
button_data variable Declared here
out_key variable Declared here
timer variable Declared here
default_key variable Declared here

Public Attributes

Return Name Description
struct nk_console_button_data button_data
nk_rune * out_key Inherited from button
float timer A pointer to where to store the captured key/character.
nk_rune default_key A countdown timer to prompt the user with. See also: NK_CONSOLE_KEY_TIMER

button_data

struct nk_console_button_data button_data

Defined in nuklear_console_key.h:15

out_key

nk_rune * out_key

Defined in nuklear_console_key.h:16

Inherited from button

timer

float timer

Defined in nuklear_console_key.h:17

A pointer to where to store the captured key/character.

default_key

nk_rune default_key

Defined in nuklear_console_key.h:18

A countdown timer to prompt the user with. See also: NK_CONSOLE_KEY_TIMER

nk_console_row_data

#include <nuklear_console_row.h>
struct nk_console_row_data

Defined in nuklear_console_row.h:4

List of all members

Name Kind Owner
activeChild variable Declared here
widgets_added variable Declared here

Public Attributes

Return Name Description
int activeChild
nk_bool widgets_added

activeChild

int activeChild

Defined in nuklear_console_row.h:5

widgets_added

nk_bool widgets_added

Defined in nuklear_console_row.h:6

nk_console_top_data

#include <nuklear_console.h>
struct nk_console_top_data

Defined in nuklear_console.h:111

List of all members

Name Kind Owner
active_parent variable Declared here
input_processed variable Declared here
scrollbar_required variable Declared here
scroll_to_widget variable Declared here
messages variable Declared here
message_bounds variable Declared here
gamepads variable Declared here
gamepad_num variable Declared here
user_data variable Declared here
up_down_hold_timer variable Declared here
up_down_repeat_timer variable Declared here
axis_ud variable Declared here
axis_lr variable Declared here
axis_up_fired variable Declared here
axis_down_fired variable Declared here
axis_left_fired variable Declared here
axis_right_fired variable Declared here
drag_scroll_active variable Declared here
drag_scroll_initiated variable Declared here
drag_scroll_origin variable Declared here
drag_scroll_start_x variable Declared here
drag_scroll_start_y variable Declared here
drag_scroll_max_x variable Declared here
drag_scroll_max_y variable Declared here

Public Attributes

Return Name Description
nk_console * active_parent
nk_bool input_processed The parent that is currently being displayed.
nk_bool scrollbar_required Whether or not user input has been processed.
nk_console * scroll_to_widget True when the scrollbar is needed to be rendered. See also: nk_console_render_window()
struct nk_console_message * messages When set by nk_console_navigate_back, the render loop scrolls the window to this widget's bounds. Message queue that is to be shown.
struct nk_rect message_bounds When set, will determine where messages should appear on the screen.
struct nk_gamepads * gamepads The gamepad system to use for gamepad input.
int gamepad_num Which gamepad number to use for input. -1 means any/all gamepads.
void * user_data Custom user data. This is only applied to the top-level console.
float up_down_hold_timer
float up_down_repeat_timer Total time up/down has been held continuously, used for acceleration.
struct nk_console_top_data::nk_console_axis_channel axis_ud
struct nk_console_top_data::nk_console_axis_channel axis_lr
nk_bool axis_up_fired
nk_bool axis_down_fired True this frame if an axis fired an up event.
nk_bool axis_left_fired True this frame if an axis fired a down event.
nk_bool axis_right_fired True this frame if an axis fired a left event.
nk_bool drag_scroll_active True this frame if an axis fired a right event.
nk_bool drag_scroll_initiated True when a drag-scroll gesture is in progress.
struct nk_vec2 drag_scroll_origin True when the drag started from the content area (not scrollbar).
nk_uint drag_scroll_start_x Mouse position when the drag started.
nk_uint drag_scroll_start_y Window scroll X at drag start.
nk_uint drag_scroll_max_x Window scroll Y at drag start.
nk_uint drag_scroll_max_y Maximum scroll X, updated each frame after render.

active_parent

nk_console * active_parent

Defined in nuklear_console.h:112

input_processed

nk_bool input_processed

Defined in nuklear_console.h:113

The parent that is currently being displayed.

scrollbar_required

nk_bool scrollbar_required

Defined in nuklear_console.h:114

Whether or not user input has been processed.

scroll_to_widget

nk_console * scroll_to_widget

Defined in nuklear_console.h:115

True when the scrollbar is needed to be rendered. See also: nk_console_render_window()

messages

struct nk_console_message * messages

Defined in nuklear_console.h:120

When set by nk_console_navigate_back, the render loop scrolls the window to this widget's bounds. Message queue that is to be shown.

message_bounds

struct nk_rect message_bounds

Defined in nuklear_console.h:125

When set, will determine where messages should appear on the screen.

gamepads

struct nk_gamepads * gamepads

Defined in nuklear_console.h:133

The gamepad system to use for gamepad input.

See also: nk_console_get_gamepads()

See also: nk_console_set_gamepads()

gamepad_num

int gamepad_num

Defined in nuklear_console.h:141

Which gamepad number to use for input. -1 means any/all gamepads.

See also: nk_console_set_gamepad_num()

See also: nk_console_get_gamepad_num()

user_data

void * user_data

Defined in nuklear_console.h:149

Custom user data. This is only applied to the top-level console.

See also: nk_console_user_data()

See also: nk_console_set_user_data()

up_down_hold_timer

float up_down_hold_timer

Defined in nuklear_console.h:151

up_down_repeat_timer

float up_down_repeat_timer

Defined in nuklear_console.h:152

Total time up/down has been held continuously, used for acceleration.

axis_ud

struct nk_console_top_data::nk_console_axis_channel axis_ud

Defined in nuklear_console.h:158

axis_lr

struct nk_console_top_data::nk_console_axis_channel axis_lr

Defined in nuklear_console.h:158

axis_up_fired

nk_bool axis_up_fired

Defined in nuklear_console.h:160

axis_down_fired

nk_bool axis_down_fired

Defined in nuklear_console.h:161

True this frame if an axis fired an up event.

axis_left_fired

nk_bool axis_left_fired

Defined in nuklear_console.h:162

True this frame if an axis fired a down event.

axis_right_fired

nk_bool axis_right_fired

Defined in nuklear_console.h:163

True this frame if an axis fired a left event.

drag_scroll_active

nk_bool drag_scroll_active

Defined in nuklear_console.h:165

True this frame if an axis fired a right event.

drag_scroll_initiated

nk_bool drag_scroll_initiated

Defined in nuklear_console.h:166

True when a drag-scroll gesture is in progress.

drag_scroll_origin

struct nk_vec2 drag_scroll_origin

Defined in nuklear_console.h:167

True when the drag started from the content area (not scrollbar).

drag_scroll_start_x

nk_uint drag_scroll_start_x

Defined in nuklear_console.h:168

Mouse position when the drag started.

drag_scroll_start_y

nk_uint drag_scroll_start_y

Defined in nuklear_console.h:169

Window scroll X at drag start.

drag_scroll_max_x

nk_uint drag_scroll_max_x

Defined in nuklear_console.h:170

Window scroll Y at drag start.

drag_scroll_max_y

nk_uint drag_scroll_max_y

Defined in nuklear_console.h:171

Maximum scroll X, updated each frame after render.

nk_console_axis_channel

#include <nuklear_console.h>
struct nk_console_axis_channel

Defined in nuklear_console.h:155

Time accumulator since the last repeated up/down move. State for one analog axis navigation channel (up/down or left/right).

List of all members

Name Kind Owner
timer variable Declared here
hold_timer variable Declared here

Public Attributes

Return Name Description
float timer
float hold_timer Repeat accumulator. -1 when inactive.

timer

float timer

Defined in nuklear_console.h:156

hold_timer

float hold_timer

Defined in nuklear_console.h:157

Repeat accumulator. -1 when inactive.

nk_console_file_data

#include <nuklear_console_file.h>
struct nk_console_file_data

Defined in nuklear_console_file.h:23

Custom data for the file widget.

List of all members

Name Kind Owner
button variable Declared here
file_path_buffer variable Declared here
file_path_buffer_size variable Declared here
directory variable Declared here
file_user_data variable Declared here
select_directory variable Declared here
use_list_view variable Declared here
file_action variable Declared here
starting_directory variable Declared here
dir_label_buf variable Declared here
entries variable Declared here

Public Attributes

Return Name Description
nk_console_button_data button
char * file_path_buffer Inherited from Button
int file_path_buffer_size The string buffer for the chosen file path.
char directory The size of the buffer.
void * file_user_data When selecting a file, this is the current directory.
nk_bool select_directory Custom user data for the file system.
nk_bool use_list_view Flag indicating if we are selecting a directory.
nk_bool file_action When true, uses a list view for file selection. Defaults to buttons.
char starting_directory When true, uses the label as the button text and skips the left-side label.
char dir_label_buf Optional user-specified starting directory. When set, overrides the buffer-derived directory.
nk_console_file_entry * entries Scratch buffer for appending "/" to directory labels in the list view.

button

nk_console_button_data button

Defined in nuklear_console_file.h:24

file_path_buffer

char * file_path_buffer

Defined in nuklear_console_file.h:25

Inherited from Button

file_path_buffer_size

int file_path_buffer_size

Defined in nuklear_console_file.h:26

The string buffer for the chosen file path.

directory

char directory

Defined in nuklear_console_file.h:27

The size of the buffer.

file_user_data

void * file_user_data

Defined in nuklear_console_file.h:28

When selecting a file, this is the current directory.

select_directory

nk_bool select_directory

Defined in nuklear_console_file.h:29

Custom user data for the file system.

use_list_view

nk_bool use_list_view

Defined in nuklear_console_file.h:30

Flag indicating if we are selecting a directory.

file_action

nk_bool file_action

Defined in nuklear_console_file.h:31

When true, uses a list view for file selection. Defaults to buttons.

starting_directory

char starting_directory

Defined in nuklear_console_file.h:32

When true, uses the label as the button text and skips the left-side label.

dir_label_buf

char dir_label_buf

Defined in nuklear_console_file.h:33

Optional user-specified starting directory. When set, overrides the buffer-derived directory.

entries

nk_console_file_entry * entries

Defined in nuklear_console_file.h:34

Scratch buffer for appending "/" to directory labels in the list view.

nk_console_knob_data

#include <nuklear_console_knob.h>
struct nk_console_knob_data

Defined in nuklear_console_knob.h:9

Data for Property and Slider widgets.

List of all members

Name Kind Owner
property variable Declared here
zero_direction variable Declared here
dead_zone_degrees variable Declared here

Public Attributes

Return Name Description
nk_console_property_data property
enum nk_heading zero_direction
float dead_zone_degrees

property

nk_console_property_data property

Defined in nuklear_console_knob.h:10

zero_direction

enum nk_heading zero_direction

Defined in nuklear_console_knob.h:11

dead_zone_degrees

float dead_zone_degrees

Defined in nuklear_console_knob.h:12

nk_console_tree_data

#include <nuklear_console_tree.h>
struct nk_console_tree_data

Defined in nuklear_console_tree.h:4

List of all members

Name Kind Owner
button variable Declared here
referenced_children variable Declared here

Public Attributes

Return Name Description
struct nk_console_button_data button
struct nk_console ** referenced_children Inherited from button

button

struct nk_console_button_data button

Defined in nuklear_console_tree.h:5

referenced_children

struct nk_console ** referenced_children

Defined in nuklear_console_tree.h:6

Inherited from button

nk_console_color_data

#include <nuklear_console_color.h>
struct nk_console_color_data

Defined in nuklear_console_color.h:4

List of all members

Name Kind Owner
button variable Declared here
color variable Declared here

Public Attributes

Return Name Description
struct nk_console_button_data button
struct nk_colorf * color Inherited from button

button

struct nk_console_button_data button

Defined in nuklear_console_color.h:5

color

struct nk_colorf * color

Defined in nuklear_console_color.h:6

Inherited from button

nk_console_file_entry

#include <nuklear_console_file.h>
struct nk_console_file_entry

Defined in nuklear_console_file.h:15

A single file or directory entry stored for the file widget's list view.

List of all members

Name Kind Owner
label variable Declared here
is_directory variable Declared here

Public Attributes

Return Name Description
char * label
nk_bool is_directory The basename of the file or directory.

label

char * label

Defined in nuklear_console_file.h:16

is_directory

nk_bool is_directory

Defined in nuklear_console_file.h:17

The basename of the file or directory.

nk_console_image_data

#include <nuklear_console_image.h>
struct nk_console_image_data

Defined in nuklear_console_image.h:4

List of all members

Name Kind Owner
image variable Declared here
color variable Declared here

Public Attributes

Return Name Description
struct nk_image image
struct nk_color color

image

struct nk_image image

Defined in nuklear_console_image.h:5

color

struct nk_color color

Defined in nuklear_console_image.h:6

nk_console_input_data

#include <nuklear_console_input.h>
struct nk_console_input_data

Defined in nuklear_console_input.h:9

Data specifically used for the input widget.

See also: nk_console_input()

List of all members

Name Kind Owner
button_data variable Declared here
gamepad_number variable Declared here
out_gamepad_number variable Declared here
out_gamepad_button variable Declared here
timer variable Declared here
default_gamepad_button variable Declared here

Public Attributes

Return Name Description
struct nk_console_button_data button_data
int gamepad_number Inherited from button
int * out_gamepad_number The gamepad number of which to expect input from. Provied -1 for any gamepad.
enum nk_gamepad_button * out_gamepad_button A pointer for where to store the gamepad number the button is associated with.
float timer A pointer to where to store the gamepad button.
enum nk_gamepad_button default_gamepad_button A countdown timer to prompt the user with. See also: NK_CONSOLE_INPUT_TIMER

button_data

struct nk_console_button_data button_data

Defined in nuklear_console_input.h:10

gamepad_number

int gamepad_number

Defined in nuklear_console_input.h:11

Inherited from button

out_gamepad_number

int * out_gamepad_number

Defined in nuklear_console_input.h:12

The gamepad number of which to expect input from. Provied -1 for any gamepad.

out_gamepad_button

enum nk_gamepad_button * out_gamepad_button

Defined in nuklear_console_input.h:13

A pointer for where to store the gamepad number the button is associated with.

timer

float timer

Defined in nuklear_console_input.h:14

A pointer to where to store the gamepad button.

default_gamepad_button

enum nk_gamepad_button default_gamepad_button

Defined in nuklear_console_input.h:15

A countdown timer to prompt the user with. See also: NK_CONSOLE_INPUT_TIMER

nk_console_radio_data

#include <nuklear_console_radio.h>
struct nk_console_radio_data

Defined in nuklear_console_radio.h:9

Data for the radio button.

See also: nk_console_radio()

List of all members

Name Kind Owner
selected variable Declared here

Public Attributes

Return Name Description
int * selected

selected

int * selected

Defined in nuklear_console_radio.h:10

nk_console_button_data

#include <nuklear_console_button.h>
struct nk_console_button_data

Defined in nuklear_console_button.h:4

List of all members

Name Kind Owner
symbol variable Declared here
image variable Declared here

Public Attributes

Return Name Description
enum nk_symbol_type symbol
struct nk_image image

symbol

enum nk_symbol_type symbol

Defined in nuklear_console_button.h:5

image

struct nk_image image

Defined in nuklear_console_button.h:6

nk_console_checkbox_data

#include <nuklear_console_checkbox.h>
struct nk_console_checkbox_data

Defined in nuklear_console_checkbox.h:4

List of all members

Name Kind Owner
value_bool variable Declared here

Public Attributes

Return Name Description
nk_bool * value_bool

value_bool

nk_bool * value_bool

Defined in nuklear_console_checkbox.h:5

nk_console_combobox_data

#include <nuklear_console_combobox.h>
struct nk_console_combobox_data

Defined in nuklear_console_combobox.h:7

Data for Combobox widgets.

List of all members

Name Kind Owner
button variable Declared here
label variable Declared here
items_separated_by_separator variable Declared here
separator variable Declared here
selected variable Declared here
count variable Declared here

Public Attributes

Return Name Description
nk_console_button_data button
constchar * label
constchar * items_separated_by_separator
int separator
int * selected
int count

button

nk_console_button_data button

Defined in nuklear_console_combobox.h:8

label

constchar * label

Defined in nuklear_console_combobox.h:9

items_separated_by_separator

constchar * items_separated_by_separator

Defined in nuklear_console_combobox.h:10

separator

int separator

Defined in nuklear_console_combobox.h:11

selected

int * selected

Defined in nuklear_console_combobox.h:12

count

int count

Defined in nuklear_console_combobox.h:13

nk_console_event_handler

#include <nuklear_console.h>
struct nk_console_event_handler

Defined in nuklear_console.h:35

List of all members

Name Kind Owner
type variable Declared here
callback variable Declared here
user_data variable Declared here
destructor variable Declared here

Public Attributes

Return Name Description
nk_console_event_type type
nk_console_event callback The type of event this handler is for.
void * user_data Invoked when this handler is triggered.
nk_console_event destructor Passed to both 'callback' and 'destructor'.

type

nk_console_event_type type

Defined in nuklear_console.h:36

callback

nk_console_event callback

Defined in nuklear_console.h:37

The type of event this handler is for.

user_data

void * user_data

Defined in nuklear_console.h:38

Invoked when this handler is triggered.

destructor

nk_console_event destructor

Defined in nuklear_console.h:39

Passed to both 'callback' and 'destructor'.

nk_console_progress_data

#include <nuklear_console_progress.h>
struct nk_console_progress_data

Defined in nuklear_console_progress.h:4

List of all members

Name Kind Owner
max_size variable Declared here
value_size variable Declared here

Public Attributes

Return Name Description
nk_size max_size
nk_size * value_size

max_size

nk_size max_size

Defined in nuklear_console_progress.h:5

value_size

nk_size * value_size

Defined in nuklear_console_progress.h:6

nk_console_property_data

#include <nuklear_console_property.h>
struct nk_console_property_data

Defined in nuklear_console_property.h:7

Data for Property and Slider widgets.

List of all members

Name Kind Owner
min_int variable Declared here
max_int variable Declared here
step_int variable Declared here
min_float variable Declared here
max_float variable Declared here
step_float variable Declared here
inc_per_pixel variable Declared here
val_int variable Declared here
val_float variable Declared here

Public Attributes

Return Name Description
int min_int
int max_int The minimum value, represented as an integer.
int step_int The maximum value, represented as an integer.
float min_float How much each step should increment.
float max_float The minimum value, represented as a float.
float step_float The maximum value, represented as a float.
float inc_per_pixel How much each step should increment.
int * val_int The increment per pixel value as a float.
float * val_float Pointer to the integer value.

min_int

int min_int

Defined in nuklear_console_property.h:8

max_int

int max_int

Defined in nuklear_console_property.h:9

The minimum value, represented as an integer.

step_int

int step_int

Defined in nuklear_console_property.h:10

The maximum value, represented as an integer.

min_float

float min_float

Defined in nuklear_console_property.h:11

How much each step should increment.

max_float

float max_float

Defined in nuklear_console_property.h:12

The minimum value, represented as a float.

step_float

float step_float

Defined in nuklear_console_property.h:13

The maximum value, represented as a float.

inc_per_pixel

float inc_per_pixel

Defined in nuklear_console_property.h:14

How much each step should increment.

val_int

int * val_int

Defined in nuklear_console_property.h:15

The increment per pixel value as a float.

val_float

float * val_float

Defined in nuklear_console_property.h:16

Pointer to the integer value.

nk_console_textedit_data

#include <nuklear_console_textedit.h>
struct nk_console_textedit_data

Defined in nuklear_console_textedit.h:11

List of all members

Name Kind Owner
button variable Declared here
buffer variable Declared here
buffer_size variable Declared here
shift variable Declared here
masked variable Declared here
masked_display variable Declared here

Public Attributes

Return Name Description
nk_console_button_data button
char * buffer
int buffer_size
nk_bool shift
nk_bool masked
char masked_display

button

nk_console_button_data button

Defined in nuklear_console_textedit.h:12

buffer

char * buffer

Defined in nuklear_console_textedit.h:13

buffer_size

int buffer_size

Defined in nuklear_console_textedit.h:14

shift

nk_bool shift

Defined in nuklear_console_textedit.h:15

masked

nk_bool masked

Defined in nuklear_console_textedit.h:16

masked_display

char masked_display

Defined in nuklear_console_textedit.h:17

nk_console_list_view_data

#include <nuklear_console_list_view.h>
struct nk_console_list_view_data

Defined in nuklear_console_list_view.h:18

Data associated with a List View Widget.

List of all members

Name Kind Owner
view variable Declared here
flags variable Declared here
row_count variable Declared here
rows_visible variable Declared here
scroll_pointer variable Declared here
selected variable Declared here
_scroll_y variable Declared here
get_label_callback variable Declared here

Public Attributes

Return Name Description
structnk_list_view view
nk_flags flags The Nuklear list view object itself.
nk_uint row_count Flags that are used for the list_view.
nk_uint rows_visible The number of available rows in the dataset.
nk_uint scroll_pointer The number of rows to display when the user is looking at the list.
nk_uint selected Tracks where the user is scrolling the list.
nk_uint _scroll_y Which item has been selected.
nk_console_list_view_get_label get_label_callback Helps calculate the list view scroll.

view

structnk_list_view view

Defined in nuklear_console_list_view.h:19

flags

nk_flags flags

Defined in nuklear_console_list_view.h:20

The Nuklear list view object itself.

row_count

nk_uint row_count

Defined in nuklear_console_list_view.h:21

Flags that are used for the list_view.

rows_visible

nk_uint rows_visible

Defined in nuklear_console_list_view.h:22

The number of available rows in the dataset.

scroll_pointer

nk_uint scroll_pointer

Defined in nuklear_console_list_view.h:23

The number of rows to display when the user is looking at the list.

selected

nk_uint selected

Defined in nuklear_console_list_view.h:24

Tracks where the user is scrolling the list.

_scroll_y

nk_uint _scroll_y

Defined in nuklear_console_list_view.h:25

Which item has been selected.

get_label_callback

nk_console_list_view_get_label get_label_callback

Defined in nuklear_console_list_view.h:26

Helps calculate the list view scroll.

nk_console_rule_horizontal_data

#include <nuklear_console_rule_horizontal.h>
struct nk_console_rule_horizontal_data

Defined in nuklear_console_rule_horizontal.h:13

Data for the horizontal rule widget.

See also: nk_console_rule_horizontal()

List of all members

Name Kind Owner
color variable Declared here
rounding variable Declared here

Public Attributes

Return Name Description
struct nk_color color
nk_bool rounding

color

struct nk_color color

Defined in nuklear_console_rule_horizontal.h:14

rounding

nk_bool rounding

Defined in nuklear_console_rule_horizontal.h:15

nk_console_axis_channel

#include <nuklear_console.h>
struct nk_console_axis_channel

Defined in nuklear_console.h:155

Time accumulator since the last repeated up/down move. State for one analog axis navigation channel (up/down or left/right).

List of all members

Name Kind Owner
timer variable Declared here
hold_timer variable Declared here

Public Attributes

Return Name Description
float timer
float hold_timer Repeat accumulator. -1 when inactive.

timer

float timer

Defined in nuklear_console.h:156

hold_timer

float hold_timer

Defined in nuklear_console.h:157

Repeat accumulator. -1 when inactive.

Generated by Moxygen

Clone this wiki locally