claude_code/procedural-3d-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix F1 on/off toggle for ImGui overlay (all platforms), clean up keycode handling (mostly macOS/iOS)

Browse source
This commit is contained in:
Stephen Saunders 2022-08-01 16:11:57 -04:00
parent 5c2aaaf693
commit 1b3fe76cdb
7 changed files with 106 additions and 70 deletions
Download patch file Download diff file Expand all files Collapse all files

72
base/keycodes.hpp
View file

@ -40,16 +40,24 @@
#define GAMEPAD_BUTTON_START 0x1006 #define GAMEPAD_BUTTON_START 0x1006
#define TOUCH_DOUBLE_TAP 0x1100 #define TOUCH_DOUBLE_TAP 0x1100
// for textoverlay example
#define KEY_SPACE 0x3E // AKEYCODE_SPACE
#define KEY_KPADD 0x9D // AKEYCODE_NUMPAD_ADD
#elif (defined(VK_USE_PLATFORM_IOS_MVK) || defined(VK_USE_PLATFORM_MACOS_MVK)) #elif (defined(VK_USE_PLATFORM_IOS_MVK) || defined(VK_USE_PLATFORM_MACOS_MVK))
#if !defined(VK_EXAMPLE_XCODE_GENERATED) #if !defined(VK_EXAMPLE_XCODE_GENERATED)
// For iOS and macOS pre-configured Xcode example project: Use character keycodes // For iOS and macOS pre-configured Xcode example project: Use character keycodes
// - Use numeric keys instead of function keys. // - Use numeric keys as optional alternative to function keys
#define KEY_DELETE 0x7F #define KEY_DELETE 0x7F
#define KEY_ESCAPE 0x1B #define KEY_ESCAPE 0x1B
#define KEY_F1 '1' #define KEY_F1 0xF704 // NSF1FunctionKey
#define KEY_F2 '2' #define KEY_F2 0xF705 // NSF2FunctionKey
#define KEY_F3 '3' #define KEY_F3 0xF706 // NSF3FunctionKey
#define KEY_F4 '4' #define KEY_F4 0xF707 // NSF4FunctionKey
#define KEY_1 '1'
#define KEY_2 '2'
#define KEY_3 '3'
#define KEY_4 '4'
#define KEY_W 'w' #define KEY_W 'w'
#define KEY_A 'a' #define KEY_A 'a'
#define KEY_S 's' #define KEY_S 's'
@ -69,32 +77,35 @@
#else // defined(VK_EXAMPLE_XCODE_GENERATED) #else // defined(VK_EXAMPLE_XCODE_GENERATED)
// For cross-platform cmake-generated Xcode project: Use ANSI keyboard keycodes // For cross-platform cmake-generated Xcode project: Use ANSI keyboard keycodes
// - Use numeric keys instead of function keys // - Use numeric keys as optional alternative to function keys
// - Use main keyboard plus/minus instead of keypad plus/minus // - Use main keyboard plus/minus instead of keypad plus/minus
// Note: Carbon kVK_* definitions are used instead of these in vulkanexamplebase.cpp #include <Carbon/Carbon.h>
// Currently only KEY_SPACE and KEY_KPADD are used in textoverlay.cpp example #define KEY_DELETE kVK_Delete
#define KEY_DELETE 0x33 #define KEY_ESCAPE kVK_Escape
#define KEY_ESCAPE 0x35 #define KEY_F1 kVK_F1
#define KEY_F1 0x12 #define KEY_F2 kVK_F2
#define KEY_F2 0x13 #define KEY_F3 kVK_F3
#define KEY_F3 0x14 #define KEY_F4 kVK_F4
#define KEY_F4 0x15 #define KEY_1 kVK_ANSI_1
#define KEY_W 0x0D #define KEY_2 kVK_ANSI_2
#define KEY_A 0x00 #define KEY_3 kVK_ANSI_3
#define KEY_S 0x01 #define KEY_4 kVK_ANSI_4
#define KEY_D 0x02 #define KEY_W kVK_ANSI_W
#define KEY_P 0x23 #define KEY_A kVK_ANSI_A
#define KEY_SPACE 0x31 #define KEY_S kVK_ANSI_S
#define KEY_KPADD 0x18 #define KEY_D kVK_ANSI_D
#define KEY_KPSUB 0x1B #define KEY_P kVK_ANSI_P
#define KEY_B 0x0B #define KEY_SPACE kVK_Space
#define KEY_F 0x03 #define KEY_KPADD kVK_ANSI_Equal
#define KEY_L 0x25 #define KEY_KPSUB kVK_ANSI_Minus
#define KEY_N 0x2D #define KEY_B kVK_ANSI_B
#define KEY_O 0x1F #define KEY_F kVK_ANSI_F
#define KEY_Q 0x0C #define KEY_L kVK_ANSI_L
#define KEY_T 0x11 #define KEY_N kVK_ANSI_N
#define KEY_Z 0x06 #define KEY_O kVK_ANSI_O
#define KEY_Q kVK_ANSI_Q
#define KEY_T kVK_ANSI_T
#define KEY_Z kVK_ANSI_Z
#endif #endif
#elif defined(VK_USE_PLATFORM_DIRECTFB_EXT) #elif defined(VK_USE_PLATFORM_DIRECTFB_EXT)
@ -122,6 +133,7 @@
#include <linux/input.h> #include <linux/input.h>
// todo: hack for bloom example // todo: hack for bloom example
#define KEY_ESCAPE KEY_ESC
#define KEY_KPADD KEY_KPPLUS #define KEY_KPADD KEY_KPPLUS
#define KEY_KPSUB KEY_KPMINUS #define KEY_KPSUB KEY_KPMINUS

69
base/vulkanexamplebase.cpp
View file

@ -10,7 +10,6 @@
#if (defined(VK_USE_PLATFORM_MACOS_MVK) && defined(VK_EXAMPLE_XCODE_GENERATED)) #if (defined(VK_USE_PLATFORM_MACOS_MVK) && defined(VK_EXAMPLE_XCODE_GENERATED))
#include <Cocoa/Cocoa.h> #include <Cocoa/Cocoa.h>
#include <Carbon/Carbon.h>
#include <QuartzCore/CAMetalLayer.h> #include <QuartzCore/CAMetalLayer.h>
#include <CoreVideo/CVDisplayLink.h> #include <CoreVideo/CVDisplayLink.h>
#endif #endif
@ -667,8 +666,9 @@ void VulkanExampleBase::updateOverlay()
io.DeltaTime = frameTimer; io.DeltaTime = frameTimer;
io.MousePos = ImVec2(mousePos.x, mousePos.y); io.MousePos = ImVec2(mousePos.x, mousePos.y);
io.MouseDown[0] = mouseButtons.left; io.MouseDown[0] = mouseButtons.left && UIOverlay.visible;
io.MouseDown[1] = mouseButtons.right; io.MouseDown[1] = mouseButtons.right && UIOverlay.visible;
io.MouseDown[2] = mouseButtons.middle && UIOverlay.visible;
ImGui::NewFrame(); ImGui::NewFrame();
@ -708,7 +708,7 @@ void VulkanExampleBase::updateOverlay()
void VulkanExampleBase::drawUI(const VkCommandBuffer commandBuffer) void VulkanExampleBase::drawUI(const VkCommandBuffer commandBuffer)
{ {
if (settings.overlay) { if (settings.overlay && UIOverlay.visible) {
const VkViewport viewport = vks::initializers::viewport((float)width, (float)height, 0.0f, 1.0f); const VkViewport viewport = vks::initializers::viewport((float)width, (float)height, 0.0f, 1.0f);
const VkRect2D scissor = vks::initializers::rect2D(width, height, 0, 0); const VkRect2D scissor = vks::initializers::rect2D(width, height, 0, 0);
vkCmdSetViewport(commandBuffer, 0, 1, &viewport); vkCmdSetViewport(commandBuffer, 0, 1, &viewport);
@ -1217,9 +1217,8 @@ void VulkanExampleBase::handleMessages(HWND hWnd, UINT uMsg, WPARAM wParam, LPAR
paused = !paused; paused = !paused;
break; break;
case KEY_F1: case KEY_F1:
if (settings.overlay) {
UIOverlay.visible = !UIOverlay.visible; UIOverlay.visible = !UIOverlay.visible;
} UIOverlay.updated = true;
break; break;
case KEY_ESCAPE: case KEY_ESCAPE:
PostQuitMessage(0); PostQuitMessage(0);
@ -1396,7 +1395,7 @@ int32_t VulkanExampleBase::handleAppInput(struct android_app* app, AInputEvent*
bool handled = false; bool handled = false;
if (vulkanExample->settings.overlay) { if (vulkanExample->settings.overlay) {
ImGuiIO& io = ImGui::GetIO(); ImGuiIO& io = ImGui::GetIO();
handled = io.WantCaptureMouse; handled = io.WantCaptureMouse && vulkanExample->UIOverlay.visible;
} }
if (!handled) { if (!handled) {
int32_t eventX = AMotionEvent_getX(event, 0); int32_t eventX = AMotionEvent_getX(event, 0);
@ -1448,15 +1447,22 @@ int32_t VulkanExampleBase::handleAppInput(struct android_app* app, AInputEvent*
case AKEYCODE_BUTTON_Y: case AKEYCODE_BUTTON_Y:
vulkanExample->keyPressed(GAMEPAD_BUTTON_Y); vulkanExample->keyPressed(GAMEPAD_BUTTON_Y);
break; break;
case AKEYCODE_1: // support keyboards with no function keys
case AKEYCODE_F1:
case AKEYCODE_BUTTON_L1: case AKEYCODE_BUTTON_L1:
vulkanExample->keyPressed(GAMEPAD_BUTTON_L1); vulkanExample->UIOverlay.visible = !vulkanExample->UIOverlay.visible;
vulkanExample->UIOverlay.updated = true;
break; break;
case AKEYCODE_BUTTON_R1: case AKEYCODE_BUTTON_R1:
vulkanExample->keyPressed(GAMEPAD_BUTTON_R1); vulkanExample->keyPressed(GAMEPAD_BUTTON_R1);
break; break;
case AKEYCODE_P:
case AKEYCODE_BUTTON_START: case AKEYCODE_BUTTON_START:
vulkanExample->paused = !vulkanExample->paused; vulkanExample->paused = !vulkanExample->paused;
break; break;
default:
vulkanExample->keyPressed(keyCode); // handle example-specific key press events
break;
}; };
LOGD("Button %d pressed", keyCode); LOGD("Button %d pressed", keyCode);
@ -1625,23 +1631,28 @@ static CVReturn displayLinkOutputCallback(CVDisplayLinkRef displayLink, const CV
{ {
switch (event.keyCode) switch (event.keyCode)
{ {
case kVK_ANSI_P: case KEY_P:
vulkanExample->paused = !vulkanExample->paused; vulkanExample->paused = !vulkanExample->paused;
break; break;
case kVK_Delete: // support keyboards with no escape key case KEY_1: // support keyboards with no function keys
case kVK_Escape: case KEY_F1:
vulkanExample->UIOverlay.visible = !vulkanExample->UIOverlay.visible;
vulkanExample->UIOverlay.updated = true;
break;
case KEY_DELETE: // support keyboards with no escape key
case KEY_ESCAPE:
[NSApp terminate:nil]; [NSApp terminate:nil];
break; break;
case kVK_ANSI_W: case KEY_W:
vulkanExample->camera.keys.up = true; vulkanExample->camera.keys.up = true;
break; break;
case kVK_ANSI_S: case KEY_S:
vulkanExample->camera.keys.down = true; vulkanExample->camera.keys.down = true;
break; break;
case kVK_ANSI_A: case KEY_A:
vulkanExample->camera.keys.left = true; vulkanExample->camera.keys.left = true;
break; break;
case kVK_ANSI_D: case KEY_D:
vulkanExample->camera.keys.right = true; vulkanExample->camera.keys.right = true;
break; break;
default: default:
@ -1654,16 +1665,16 @@ static CVReturn displayLinkOutputCallback(CVDisplayLinkRef displayLink, const CV
{ {
switch (event.keyCode) switch (event.keyCode)
{ {
case kVK_ANSI_W: case KEY_W:
vulkanExample->camera.keys.up = false; vulkanExample->camera.keys.up = false;
break; break;
case kVK_ANSI_S: case KEY_S:
vulkanExample->camera.keys.down = false; vulkanExample->camera.keys.down = false;
break; break;
case kVK_ANSI_A: case KEY_A:
vulkanExample->camera.keys.left = false; vulkanExample->camera.keys.left = false;
break; break;
case kVK_ANSI_D: case KEY_D:
vulkanExample->camera.keys.right = false; vulkanExample->camera.keys.right = false;
break; break;
default: default:
@ -2004,9 +2015,8 @@ void VulkanExampleBase::handleEvent(const DFBWindowEvent *event)
paused = !paused; paused = !paused;
break; break;
case KEY_F1: case KEY_F1:
if (settings.overlay) { UIOverlay.visible = !UIOverlay.visible;
settings.overlay = !settings.overlay; UIOverlay.updated = true;
}
break; break;
default: default:
break; break;
@ -2179,10 +2189,12 @@ void VulkanExampleBase::keyboardKey(struct wl_keyboard *keyboard,
paused = !paused; paused = !paused;
break; break;
case KEY_F1: case KEY_F1:
if (state && settings.overlay) if (state) {
settings.overlay = !settings.overlay; UIOverlay.visible = !UIOverlay.visible;
UIOverlay.updated = true;
}
break; break;
case KEY_ESC: case KEY_ESCAPE:
quit = true; quit = true;
break; break;
} }
@ -2540,9 +2552,8 @@ void VulkanExampleBase::handleEvent(const xcb_generic_event_t *event)
paused = !paused; paused = !paused;
break; break;
case KEY_F1: case KEY_F1:
if (settings.overlay) { UIOverlay.visible = !UIOverlay.visible;
settings.overlay = !settings.overlay; UIOverlay.updated = true;
}
break; break;
} }
} }
@ -2833,7 +2844,7 @@ void VulkanExampleBase::handleMouseMove(int32_t x, int32_t y)
if (settings.overlay) { if (settings.overlay) {
ImGuiIO& io = ImGui::GetIO(); ImGuiIO& io = ImGui::GetIO();
handled = io.WantCaptureMouse; handled = io.WantCaptureMouse && UIOverlay.visible;
} }
mouseMoved((float)x, (float)y, handled); mouseMoved((float)x, (float)y, handled);

9
examples/imgui/main.cpp
View file

@ -596,7 +596,9 @@ public:
} }
// Render imGui // Render imGui
if (UIOverlay.visible) {
imGui->drawFrame(drawCmdBuffers[i]); imGui->drawFrame(drawCmdBuffers[i]);
}
vkCmdEndRenderPass(drawCmdBuffers[i]); vkCmdEndRenderPass(drawCmdBuffers[i]);
@ -748,8 +750,9 @@ public:
io.DeltaTime = frameTimer; io.DeltaTime = frameTimer;
io.MousePos = ImVec2(mousePos.x, mousePos.y); io.MousePos = ImVec2(mousePos.x, mousePos.y);
io.MouseDown[0] = mouseButtons.left; io.MouseDown[0] = mouseButtons.left && UIOverlay.visible;
io.MouseDown[1] = mouseButtons.right; io.MouseDown[1] = mouseButtons.right && UIOverlay.visible;
io.MouseDown[2] = mouseButtons.middle && UIOverlay.visible;
draw(); draw();
@ -765,7 +768,7 @@ public:
virtual void mouseMoved(double x, double y, bool &handled) virtual void mouseMoved(double x, double y, bool &handled)
{ {
ImGuiIO& io = ImGui::GetIO(); ImGuiIO& io = ImGui::GetIO();
handled = io.WantCaptureMouse; handled = io.WantCaptureMouse && UIOverlay.visible;
} }
}; };

2
examples/multithreading/multithreading.cpp
View file

@ -321,9 +321,7 @@ public:
vkCmdBindPipeline(secondaryCommandBuffers.ui, VK_PIPELINE_BIND_POINT_GRAPHICS, pipelines.starsphere); vkCmdBindPipeline(secondaryCommandBuffers.ui, VK_PIPELINE_BIND_POINT_GRAPHICS, pipelines.starsphere);
if (settings.overlay) {
drawUI(secondaryCommandBuffers.ui); drawUI(secondaryCommandBuffers.ui);
}
VK_CHECK_RESULT(vkEndCommandBuffer(secondaryCommandBuffers.ui)); VK_CHECK_RESULT(vkEndCommandBuffer(secondaryCommandBuffers.ui));
} }

2
examples/textoverlay/textoverlay.cpp
View file

@ -915,7 +915,6 @@ public:
updateTextOverlay(); updateTextOverlay();
} }
#if !defined(__ANDROID__)
virtual void keyPressed(uint32_t keyCode) virtual void keyPressed(uint32_t keyCode)
{ {
switch (keyCode) switch (keyCode)
@ -925,7 +924,6 @@ public:
textOverlay->visible = !textOverlay->visible; textOverlay->visible = !textOverlay->visible;
} }
} }
#endif
}; };
VULKAN_EXAMPLE_MAIN() VULKAN_EXAMPLE_MAIN()

5
xcode/MVKExample.cpp
View file

@ -23,6 +23,11 @@ void MVKExample::keyPressed(uint32_t keyChar) { // SRS - handle keyboard key
case KEY_P: case KEY_P:
_vulkanExample->paused = !_vulkanExample->paused; _vulkanExample->paused = !_vulkanExample->paused;
break; break;
case KEY_1: // SRS - support keyboards with no function keys
case KEY_F1:
_vulkanExample->UIOverlay.visible = !_vulkanExample->UIOverlay.visible;
_vulkanExample->UIOverlay.updated = true;
break;
default: default:
_vulkanExample->keyPressed(keyChar); _vulkanExample->keyPressed(keyChar);
break; break;

9
xcode/macos/DemoViewController.mm
View file

@ -97,7 +97,16 @@ MVKExample* _mvkExample;
-(void) keyDown:(NSEvent*) theEvent { -(void) keyDown:(NSEvent*) theEvent {
NSString *text = [theEvent charactersIgnoringModifiers]; NSString *text = [theEvent charactersIgnoringModifiers];
unichar keychar = (text.length > 0) ? [text.lowercaseString characterAtIndex: 0] : 0; unichar keychar = (text.length > 0) ? [text.lowercaseString characterAtIndex: 0] : 0;
switch (keychar)
{
case KEY_DELETE: // support keyboards with no escape key
case KEY_ESCAPE:
[NSApp terminate:nil];
break;
default:
_mvkExample->keyDown(keychar); _mvkExample->keyDown(keychar);
break;
}
} }
-(void) keyUp:(NSEvent*) theEvent { -(void) keyUp:(NSEvent*) theEvent {