Add Key selector (#154)

Author: RobLoach

CMakeLists.txt

@@ -14,7 +14,7 @@ if (NOT nuklear_gamepad_FOUND)
     FetchContent_Declare(
         nuklear_gamepad
         GIT_REPOSITORY https://github.com/RobLoach/nuklear_gamepad.git
-        GIT_TAG 625d716
+        GIT_TAG 82056c3
     )
     FetchContent_GetProperties(nuklear_gamepad)
     if (NOT nuklear_gamepad_POPULATED)

README.md

@@ -44,7 +44,7 @@ int main() {
 
 ## Widgets
 
-Buttons, Checkboxes, Color Select, Comboboxes, Files, Directories, Gamepad Input Buttons, Labels, Properties, Sliders, Knobs, Radio Options, Images, Knob, Rows, TextEdit, Tree, Rule Horizontal, List View, Messages.
+Buttons, Checkboxes, Color Select, Comboboxes, Files, Directories, Gamepad Input Buttons, Labels, Properties, Sliders, Knobs, Radio Options, Images, Knob, Rows, TextEdit, Tree, Rule Horizontal, Keyboard Key, List View, Messages.
 
 ## API
 
@@ -95,13 +95,14 @@ void nk_console_set_active_widget(nk_console* widget);
 
 ## Configuration
 
-| Define | Description |
-| ------ | ----------- |
-| `NK_BUTTON_TRIGGER_ON_RELEASE` | When enabled, will allow for touch and drag to scroll the window |
-| `NK_CONSOLE_DRAG_THRESHOLD` | When using touch and drag to scroll, the amount of threshold movement needed to consider it a scroll |
-| `NK_CONSOLE_AXIS_DEADZONE` | The amount of movement the axis needs prior to moving the cursor |
-| `NK_CONSOLE_AXIS_REPEAT_INTERVAL` | When using the gamepad axis to move, how frequently the cursor will move |
-| `NK_CONSOLE_FILE_ADD_FILES` | The function callback used to enumerate files, see `nk_console_file_add_files_tinydir()` |
+Define | Description
+------ | -----------
+`NK_BUTTON_TRIGGER_ON_RELEASE` | Required in order to ensure events are triggered in the correct order
+`NK_CONSOLE_KEY_BACK` | The `nk_keys` enumeration that will be used to go back in the menu heirarchy. Defaults to ESC.
+`NK_CONSOLE_DRAG_THRESHOLD` | The amount of threshold mouse movement needed to consider it a scroll
+`NK_CONSOLE_AXIS_DEADZONE` | The amount of movement the gamepad axis needs prior to moving the cursor
+`NK_CONSOLE_AXIS_REPEAT_INTERVAL` | When using the gamepad axis to move, how frequently the cursor will move
+`NK_CONSOLE_FILE_ADD_FILES` | The function callback used to enumerate files, see `nk_console_file_add_files_tinydir()`
 
 ## Development
 

demo/common/nuklear_console_demo.c

@@ -84,6 +84,9 @@ static char textedit_password_buffer[256] = "12345";
 static int gamepad_number = 0;
 static enum nk_gamepad_button gamepad_button = NK_GAMEPAD_BUTTON_A;
 
+// Key
+static nk_rune key_binding = NK_KEY_ENTER;
+
 // Color
 static struct nk_colorf color = {0.31f, 1.0f, 0.48f, 1.0f};
 
@@ -350,12 +353,17 @@ struct nk_console* nuklear_console_demo_init(struct nk_context* ctx, void* user_
         struct nk_console* progressbar = nk_console_button(widgets, "Progress Bar");
         {
             nk_console_progress(progressbar, "Progress", &progressValue, 100);
+            nk_console_progress(progressbar, "Progress (Disabled)", &progressValue, 100)
+                ->disabled = nk_true;
             nk_console_button_onclick(progressbar, "Back", &nk_console_button_back);
         }
 
         // Input: From any gamepad (-1)
         nk_console_input(widgets, "Input Button", -1, &gamepad_number, &gamepad_button);
 
+        // Key: Capture a keyboard key binding
+        nk_console_key(widgets, "Key Binding", &key_binding);
+
         // Combobox
         nk_console_combobox(widgets, "ComboBox", "Fists;Chainsaw;Pistol;Shotgun;Chaingun", ';', &weapon)
             ->tooltip = "Choose a weapon! The chainsaw is the best!";
@@ -375,6 +383,8 @@ struct nk_console* nuklear_console_demo_init(struct nk_context* ctx, void* user_
         {
             nk_console_slider_float(sliders, "Slider Float", 0.0f, &slider_float_test, 2.0f, 0.1f)->tooltip = "Slider float is cool! It's what you want to use.";
             nk_console_slider_int(sliders, "Slider Int", 0, &slider_int_test, 20, 1);
+            nk_console_slider_int(sliders, "Slider Disabled", 0, &slider_int_test, 20, 1)
+                ->disabled = nk_true;
             nk_console_button_onclick(sliders, "Back", &nk_console_button_back);
         }
 

demo/glfw/main.c

@@ -22,6 +22,7 @@
 #define NK_IMPLEMENTATION
 #define NK_GLFW_GL3_IMPLEMENTATION
 #define NK_KEYSTATE_BASED_INPUT
+#define NK_BUTTON_TRIGGER_ON_RELEASE
 #include "../../vendor/Nuklear/nuklear.h"
 #include "../../vendor/Nuklear/demo/glfw_opengl3/nuklear_glfw_gl3.h"
 

demo/raylib/main.c

@@ -16,7 +16,6 @@ void UpdateDrawFrame(void);
 
 struct nk_context *ctx;
 nk_bool closeWindow = nk_false;
-struct nk_rect lastWindowSize;
 
 int main() {
     SetConfigFlags(FLAG_WINDOW_RESIZABLE);
@@ -32,7 +31,6 @@ int main() {
     Texture texture = LoadTexture("resources/image.png");
 
     console = nuklear_console_demo_init(ctx, NULL, TextureToNuklearImage(texture));
-    lastWindowSize = nk_rect(0, 0, (float)GetScreenWidth() * 0.80f, (float)GetScreenHeight());
 
     #if defined(PLATFORM_WEB)
         emscripten_set_main_loop(UpdateDrawFrame, 0, 1);
@@ -62,20 +60,8 @@ void UpdateDrawFrame(void) {
 
     nk_gamepad_update(nk_console_get_gamepads(console));
 
-    int flags = NK_WINDOW_SCROLL_AUTO_HIDE;
-
-    // Center the window using the previous frame's rendered size, capped to screen
-    float windowW = lastWindowSize.w < GetScreenWidth() ? lastWindowSize.w : GetScreenWidth();
-    float windowH = lastWindowSize.h < GetScreenHeight() ? lastWindowSize.h : GetScreenHeight();
-    struct nk_rect centered = nk_rect(
-        (GetScreenWidth() - windowW) / 2.0f,
-        (GetScreenHeight() - windowH) / 2.0f,
-        windowW,
-        windowH
-    );
-
     // Nuklear GUI Code
-    lastWindowSize = nk_console_render_window(console, "nuklear_console", centered, flags);
+    nk_console_render_window(console, "nuklear_console", nk_rect(0, 0, (float)GetScreenWidth(), (float)GetScreenHeight()), NK_WINDOW_SCROLL_AUTO_HIDE | NK_WINDOW_TITLE);
 
     // Render
     BeginDrawing();

demo/sdl3_renderer/main.c

@@ -21,6 +21,7 @@
 #define NK_INCLUDE_DEFAULT_FONT
 #define NK_INCLUDE_COMMAND_USERDATA
 #define NK_INCLUDE_VERTEX_BUFFER_OUTPUT
+#define NK_BUTTON_TRIGGER_ON_RELEASE
 #define NK_IMPLEMENTATION
 #include "../../vendor/Nuklear/nuklear.h"
 
@@ -176,6 +177,8 @@ SDL_AppResult SDL_AppIterate(void *appstate) {
     SDL_RenderClear(app->renderer);
 
     nk_sdl_render(ctx, NK_ANTI_ALIASING_ON);
+
+    // The SDL Renderer allows handling SDL_StartTextInput()
     nk_console_sdl_update_text_input(app->console, app->window);
 
     SDL_RenderPresent(app->renderer);

demo/sdl_renderer/main.c

@@ -20,6 +20,7 @@
 #define NK_INCLUDE_COMMAND_USERDATA
 #define NK_IMPLEMENTATION
 #define NK_SDL_RENDERER_IMPLEMENTATION
+#define NK_BUTTON_TRIGGER_ON_RELEASE
 #include "../../vendor/Nuklear/nuklear.h"
 #include "../../vendor/Nuklear/demo/sdl_renderer/nuklear_sdl_renderer.h"
 
@@ -112,7 +113,7 @@ int main(int argc, char *argv[]) {
         nk_input_begin(ctx);
 
         nk_gamepad_update(nk_console_get_gamepads(console));
-        
+
         while (SDL_PollEvent(&evt)) {
             if (evt.type == SDL_QUIT) goto cleanup;
             if (evt.type == SDL_KEYUP && evt.key.keysym.scancode == SDL_SCANCODE_ESCAPE) running = 0;
@@ -137,6 +138,8 @@ int main(int argc, char *argv[]) {
         SDL_RenderClear(renderer);
 
         nk_sdl_render(NK_ANTI_ALIASING_ON);
+
+        // The SDL Renderer allows handling SDL_StartTextInput()
         nk_console_sdl_update_text_input(console, win);
 
         SDL_RenderPresent(renderer);

nuklear_console.h

@@ -69,6 +69,8 @@ typedef enum {
     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,
@@ -284,6 +286,7 @@ NK_API nk_bool nk_console_navigate_to_path(nk_console* console, const char* path
 #include "nuklear_console_file_system.h"
 #include "nuklear_console_image.h"
 #include "nuklear_console_input.h"
+#include "nuklear_console_key.h"
 #include "nuklear_console_knob.h"
 #include "nuklear_console_label.h"
 #include "nuklear_console_list_view.h"
@@ -309,6 +312,28 @@ NK_API nk_bool nk_console_navigate_to_path(nk_console* console, const char* path
 #ifndef NK_CONSOLE_IMPLEMENTATION_ONCE
 #define NK_CONSOLE_IMPLEMENTATION_ONCE
 
+#ifndef NK_BUTTON_TRIGGER_ON_RELEASE
+/**
+ * Define NK_BUTTON_TRIGGER_ON_RELEASE prior to nuklear.h.
+ *
+ * This is required because the input events are triggered incorrectly otherwise, resulting in undesirable behavior.
+ *
+ * @code
+ * #define NK_BUTTON_TRIGGER_ON_RELEASE
+ * #define NK_IMPLEMENTATION
+ * #include "nuklear.h"
+ *
+ * #define NK_CONSOLE_IMPLEMENTATION
+ * #include "nuklear_console.h"
+ * @endcode
+ *
+ * You are able to ignore this warning by using #define NK_CONSOLE_IGNORE_BUTTON_TRIGGER_ON_RELEASE
+ */
+#ifndef NK_CONSOLE_IGNORE_BUTTON_TRIGGER_ON_RELEASE
+#warning "nuklear_console requires NK_BUTTON_TRIGGER_ON_RELEASE. Add #define NK_BUTTON_TRIGGER_ON_RELEASE prior to #define NK_IMPLEMENTATION ."
+#endif
+#endif
+
 #ifndef NK_CONSOLE_AXIS_DEADZONE
 #define NK_CONSOLE_AXIS_DEADZONE 0.22f
 #endif
@@ -319,6 +344,15 @@ NK_API nk_bool nk_console_navigate_to_path(nk_console* console, const char* path
 #define NK_CONSOLE_DRAG_THRESHOLD 8.0f
 #endif
 
+#ifndef NK_CONSOLE_KEY_BACK
+/**
+ * The Nuklear `enum nk_keys` used to go back in the menu heirarchy.
+ *
+ * @see nk_console_button_pushed()
+ */
+#define NK_CONSOLE_KEY_BACK NK_KEY_TEXT_RESET_MODE
+#endif // NK_CONSOLE_KEY_BACK
+
 // NK_CONSOLE_MALLOC
 #ifndef NK_CONSOLE_MALLOC
 #ifdef NK_INCLUDE_DEFAULT_ALLOCATOR
@@ -378,6 +412,7 @@ extern "C" {
 #include "nuklear_console_file_system.h"
 #include "nuklear_console_image.h"
 #include "nuklear_console_input.h"
+#include "nuklear_console_key.h"
 #include "nuklear_console_knob.h"
 #include "nuklear_console_label.h"
 #include "nuklear_console_list_view.h"
@@ -876,10 +911,6 @@ static void nk_console_axis_update(nk_console* console) {
  * Handles the Touch and Drag Scrolling.
  */
 static void nk_console_window_touch_drag(nk_console* console, nk_console_top_data* top_data) {
-#ifndef NK_BUTTON_TRIGGER_ON_RELEASE
-    NK_UNUSED(console);
-    NK_UNUSED(top_data);
-#else
     struct nk_input* in = &console->ctx->input;
     if (nk_window_is_hovered(console->ctx) && nk_input_is_mouse_pressed(in, NK_BUTTON_LEFT)) {
         top_data->drag_scroll_origin = in->mouse.pos;
@@ -890,7 +921,7 @@ static void nk_console_window_touch_drag(nk_console* console, nk_console_top_dat
         float dy = top_data->drag_scroll_origin.y - in->mouse.pos.y;
         float dx = top_data->drag_scroll_origin.x - in->mouse.pos.x;
         if (!top_data->drag_scroll_active &&
-                (dy * dy + dx * dx) > NK_CONSOLE_DRAG_THRESHOLD * NK_CONSOLE_DRAG_THRESHOLD) {
+            (dy * dy + dx * dx) > NK_CONSOLE_DRAG_THRESHOLD * NK_CONSOLE_DRAG_THRESHOLD) {
             top_data->drag_scroll_active = nk_true;
         }
         if (top_data->drag_scroll_active) {
@@ -899,10 +930,10 @@ static void nk_console_window_touch_drag(nk_console* console, nk_console_top_dat
             nk_window_set_scroll(console->ctx, sx, sy);
             top_data->input_processed = nk_true;
         }
-    } else {
+    }
+    else {
         top_data->drag_scroll_active = nk_false;
     }
-#endif
 }
 
 NK_API void nk_console_render(nk_console* console) {
@@ -973,6 +1004,15 @@ NK_API void nk_console_render(nk_console* console) {
                 cvector_clear(console->events);
             }
         }
+
+        // Update drag scroll bounds so they're valid when nk_console_render is called directly (e.g. SDL/GLFW demos) rather than via nk_console_render_window.
+        if (console->ctx->current != NULL) {
+            struct nk_rect content = nk_window_get_content_region(console->ctx);
+            float rendered_h = console->ctx->current->layout->at_y - console->ctx->current->layout->bounds.y + console->ctx->current->layout->row.height;
+            data->drag_scroll_max_y = (nk_uint)NK_MAX(0.0f, rendered_h - content.h);
+            data->drag_scroll_max_x = (nk_uint)NK_MAX(0.0f, console->ctx->current->layout->max_x - console->ctx->current->layout->bounds.x - content.w);
+        }
+
         return;
     }
 
@@ -1109,10 +1149,8 @@ NK_API struct nk_rect nk_console_render_window(nk_console* console, const char*
         float rendered_h = console->ctx->current->layout->at_y - console->ctx->current->layout->bounds.y + console->ctx->current->layout->row.height;
         window_bounds = nk_window_get_bounds(console->ctx);
         window_bounds.h = window_bounds.h - content.h + rendered_h;
-#ifdef NK_BUTTON_TRIGGER_ON_RELEASE
         top_data->drag_scroll_max_y = (nk_uint)NK_MAX(0.0f, rendered_h - content.h);
         top_data->drag_scroll_max_x = (nk_uint)NK_MAX(0.0f, console->ctx->current->layout->max_x - console->ctx->current->layout->bounds.x - content.w);
-#endif
     }
 
     // Finish the window processing.
@@ -1333,8 +1371,8 @@ NK_API nk_console* nk_console_find_by_path(nk_console* console, const char* path
                     continue;
                 }
                 int label_len = child->label_length > 0
-                    ? child->label_length
-                    : (int)nk_strlen(child->label);
+                                    ? child->label_length
+                                    : (int)nk_strlen(child->label);
                 if (label_len == copy_len &&
                     strncmp(child->label, segment, (size_t)copy_len) == 0) {
                     found = child;
@@ -1397,9 +1435,9 @@ NK_API nk_bool nk_console_button_pushed(nk_console* console, int button) {
         case NK_GAMEPAD_BUTTON_A: return nk_input_is_key_released(&console->ctx->input, NK_KEY_ENTER);
         case NK_GAMEPAD_BUTTON_B:
             // Escape Key
-            return nk_input_is_key_released(&console->ctx->input, NK_KEY_TEXT_RESET_MODE) ||
-            // Mouse Back Button
-            (nk_input_is_mouse_pressed(&console->ctx->input, NK_BUTTON_X1) && nk_window_is_hovered(console->ctx));
+            return nk_input_is_key_released(&console->ctx->input, NK_CONSOLE_KEY_BACK) ||
+                   // Mouse Back Button
+                   (nk_input_is_mouse_pressed(&console->ctx->input, NK_BUTTON_X1) && nk_window_is_hovered(console->ctx));
         // case NK_GAMEPAD_BUTTON_X: return nk_input_is_key_pressed(&console->ctx->input, NK_KEY_A);
         // case NK_GAMEPAD_BUTTON_Y: return nk_input_is_key_pressed(&console->ctx->input, NK_KEY_S);
         case NK_GAMEPAD_BUTTON_LB: return nk_input_is_key_released(&console->ctx->input, NK_KEY_UP) && nk_input_is_key_down(&console->ctx->input, NK_KEY_SHIFT);