Skip to main content

Peripheral Input

warning

Ballex's peripheral input logic is processed in the image frame, so when you need to use the following APIs, set the trigger mode to Image Frame, otherwise the peripheral input may fail to be captured.

API​

CheckKeyDown(key_ID: Literal) -> bool​

Check whether a keyboard key is pressed down exactly in the current image frame.

CheckKeyUp(key_ID: Literal) -> bool​

Check whether a keyboard key is lifted up exactly in the last image frame.

CheckKeyHold(key_ID: Literal) -> bool​

Check whether a keyboard key is being held in the current image frame.

  • key_ID: key ID
  • returns: whether the corresponding event happens

CheckMouseDown(button: Literal[0, 1, 2]) -> bool​

Check whether a mouse button is pressed down exactly in the current image frame.

CheckMouseUp(button: Literal[0, 1, 2]) -> bool​

Check whether a mouse button is lifted up exactly in the last image frame.

CheckMouseHold(button: Literal[0, 1, 2]) -> bool​

Check whether a mouse button is being held in the current image frame.

  • button: mouse button
    • 0: left mouse button
    • 1: middle mouse button
    • 2: right mouse button
  • returns: whether the corresponding event happens

GetMousePosition() -> vec2​

Check the position of the mouse pointer in the current image frame.

  • returns: position's component along each axis, unit is pixel, right and up are the positive directions

GetMouseScrollDelta() -> vec2​

Check the movement of the mouse wheel in the current image frame.

  • returns: movement along each axis, unit is pixel, right and up are the positive directions

Peripheral Input ID List​

Keyboard​

IDKeyIDKeyIDKeyIDKey
0None60<120X286F5
8Backspace61=121Y287F6
9Tab62>122Z288F7
12Clear63?127Delete289F8
13Enter64@256Numpad0290F9
19Pause91[257Numpad1291F10
27Esc92\258Numpad2292F11
32Space93]259Numpad3293F12
33!94^260Numpad4294F13
34"95_261Numpad5295F14
35#96`262Numpad6296F15
36$97A263Numpad7300NumLock
38&98B264Numpad8301CapsLock
39'99C265Numpad9302ScrollLock
40(100D266Numpad.303RightShift
41)101E267Numpad/304Shift
42*102F268Numpad*305RightCtrl
43+103G269Numpad-306Ctrl
44,104H270Numpad+307RightAlt
45-105I271NumpadEnter308Alt
46.106J272Numpad=309RightApple
47/107K273↑309RightCommand
480108L274↓310LeftApple
491109M275→310LeftCommand
502110N276←311Win
513111O277Insert312RightWin
524112P278Home313AltGr
535113Q279End315Help
546114R280PageUp316PrintScreen
557115S281PageDown317SysReq
568116T282F1318Break
579117U283F2319Menu
58:118V284F3
59;119W285F4

Mouse​

IDKey
323Mouse0
324Mouse1
325Mouse2
326Mouse3
327Mouse4
328Mouse5
329Mouse6

Gamepad​

IDKeyIDKeyIDKeyIDKey
330JoystickButton0375Joystick2Button5420Joystick4Button10465Joystick6Button15
331JoystickButton1376Joystick2Button6421Joystick4Button11466Joystick6Button16
332JoystickButton2377Joystick2Button7422Joystick4Button12467Joystick6Button17
333JoystickButton3378Joystick2Button8423Joystick4Button13468Joystick6Button18
334JoystickButton4379Joystick2Button9424Joystick4Button14469Joystick6Button19
335JoystickButton5380Joystick2Button10425Joystick4Button15470Joystick7Button0
336JoystickButton6381Joystick2Button11426Joystick4Button16471Joystick7Button1
337JoystickButton7382Joystick2Button12427Joystick4Button17472Joystick7Button2
338JoystickButton8383Joystick2Button13428Joystick4Button18473Joystick7Button3
339JoystickButton9384Joystick2Button14429Joystick4Button19474Joystick7Button4
340JoystickButton10385Joystick2Button15430Joystick5Button0475Joystick7Button5
341JoystickButton11386Joystick2Button16431Joystick5Button1476Joystick7Button6
342JoystickButton12387Joystick2Button17432Joystick5Button2477Joystick7Button7
343JoystickButton13388Joystick2Button18433Joystick5Button3478Joystick7Button8
344JoystickButton14389Joystick2Button19434Joystick5Button4479Joystick7Button9
345JoystickButton15390Joystick3Button0435Joystick5Button5480Joystick7Button10
346JoystickButton16391Joystick3Button1436Joystick5Button6481Joystick7Button11
347JoystickButton17392Joystick3Button2437Joystick5Button7482Joystick7Button12
348JoystickButton18393Joystick3Button3438Joystick5Button8483Joystick7Button13
349JoystickButton19394Joystick3Button4439Joystick5Button9484Joystick7Button14
350Joystick1Button0395Joystick3Button5440Joystick5Button10485Joystick7Button15
351Joystick1Button1396Joystick3Button6441Joystick5Button11486Joystick7Button16
352Joystick1Button2397Joystick3Button7442Joystick5Button12487Joystick7Button17
353Joystick1Button3398Joystick3Button8443Joystick5Button13488Joystick7Button18
354Joystick1Button4399Joystick3Button9444Joystick5Button14489Joystick7Button19
355Joystick1Button5400Joystick3Button10445Joystick5Button15490Joystick8Button0
356Joystick1Button6401Joystick3Button11446Joystick5Button16491Joystick8Button1
357Joystick1Button7402Joystick3Button12447Joystick5Button17492Joystick8Button2
358Joystick1Button8403Joystick3Button13448Joystick5Button18493Joystick8Button3
359Joystick1Button9404Joystick3Button14449Joystick5Button19494Joystick8Button4
360Joystick1Button10405Joystick3Button15450Joystick6Button0495Joystick8Button5
361Joystick1Button11406Joystick3Button16451Joystick6Button1496Joystick8Button6
362Joystick1Button12407Joystick3Button17452Joystick6Button2497Joystick8Button7
363Joystick1Button13408Joystick3Button18453Joystick6Button3498Joystick8Button8
364Joystick1Button14409Joystick3Button19454Joystick6Button4499Joystick8Button9
365Joystick1Button15410Joystick4Button0455Joystick6Button5500Joystick8Button10
366Joystick1Button16411Joystick4Button1456Joystick6Button6501Joystick8Button11
367Joystick1Button17412Joystick4Button2457Joystick6Button7502Joystick8Button12
368Joystick1Button18413Joystick4Button3458Joystick6Button8503Joystick8Button13
369Joystick1Button19414Joystick4Button4459Joystick6Button9504Joystick8Button14
370Joystick2Button0415Joystick4Button5460Joystick6Button10505Joystick8Button15
371Joystick2Button1416Joystick4Button6461Joystick6Button11506Joystick8Button16
372Joystick2Button2417Joystick4Button7462Joystick6Button12507Joystick8Button17
373Joystick2Button3418Joystick4Button8463Joystick6Button13508Joystick8Button18
374Joystick2Button4419Joystick4Button9464Joystick6Button14509Joystick8Button19