Controller Devices

From QB64 Phoenix Edition Wiki
Revision as of 21:55, 3 April 2023 by RhoSigma (talk | contribs)
Jump to navigation Jump to search

QB64 supports all kinds of keyboard, mouse, joystick, gamepad, steering wheel and other multi-stick controller input devices.

  • In order to read the device controls, the number of input devices MUST first be found using _DEVICES.
  • After the device count is determined we can find out the type of device, the device name and the type of controls available using the _DEVICE$(device_number) function. The function returns a STRING containing information about each numbered device.


"[CONTROLLER][[DEVICENAME] device description][BUTTON][AXIS][WHEEL]"


  • _DEVICEINPUT can indicate a used device number or true when a specified device number is active.
device = _DEVICEINPUT would return 1 for a keyboard event and 2 for a mouse event.
mouse = _DEVICEINPUT(2) would return -1(true) when the mouse was moved, clicked or scrolled.


KEYBOARD

Normally the number 1 device, it usually only has BUTTON controls. Program window must be in focus to read key activity.


[KEYBOARD][BUTTON]


_LASTBUTTON(1) will normally return 512 buttons.
_BUTTONCHANGE(number) returns -1 when pressed, 1 when released and 0 when there is no event since the last read.
_BUTTON(number) returns -1 when a button is pressed and 0 when released.
'                                  Keyboard Device Button Numbers
'
' Esc F1  F2  F3  F4  F5  F6  F7  F8  F9  F10  F11 F12      SysReq ScrL Pause
'  2  60  61  62  63  64  65  66  67  68  --   88  89        --    71    70
' `~  1!  2@  3#  4$  5%  6^  7&  8*  9(  0)  -_  =+ BkSpc  Insert Home PgUp   NumL    /    *    -
' 42   3   4   5   6   7   8   9  10  11  12  13  14  15     339   328   330   326    310  56   75
' Tab  Q   W   E   R   T   Y   U   I   O   P   [{  ]}  \|   Delete End  PgDn   7/Home 8/▲  9/PU  +
' 16  17  18  19  20  21  22  23  24  25  26   27  28  44    340   336   338   72     73   74   79
' CapL  A   S   D   F   G   H   J   K   L   ;:  '"   Enter                     4/◄-    5   6/-►  E
' 59   31  32  33  34  35  36  37  38  39   40  41    29                       76     77   78    n
' Shift  Z   X   C   V   B   N   M  ,<  .>  /?       Shift          ▲          1/End  2/▼  3/PD  t
' 43    45  46  47  48  49  50  51  52  53  54        55           329         80     81   82    e
' Ctrl Win  Alt    Spacebar    Alt  Win  Menu Ctrl            ◄-    ▼    -►    0/Insert    ./Del r
' 30   348  --       58        --   349  350  286             332  337  334    83          84   285
'

(Return to Table of Contents)


MOUSE

Normally the number 2 device, a mouse usually has [[[AXIS]]], [[[BUTTON]]] and [[[WHEEL]]] controls. Pointer must be in program screen area.


[MOUSE][BUTTON][AXIS][WHEEL]


_LASTAXIS(2) normally returns 2 axis representing the horizontal and vertical mouse, trackball, touch pad or touchscreen axis.
_AXIS(number) returns a SINGLE value from -1 to 1 with 0 representing the axis center in normal movement mode.
_AXIS(1) returns the horizontal axis position in normal movement mode only.
_AXIS(2) returns the vertical axis position in normal movement mode only.
Program window pointer AXIS values change from 0 at the center to -1 or + 1 values at the window borders.


_LASTBUTTON(2) will normally return 3 buttons when mouse has a center or scroll wheel button.
_BUTTONCHANGE(number) returns -1 when pressed, 1 when released and 0 when there is no event since the last read.
_BUTTON(number) returns -1 when corresponding button is pressed and 0 when released.
_BUTTON(1) returns Left button presses like _MOUSEBUTTON(1) and _BUTTONCHANGE(1) returns events.
_BUTTON(2) returns Center button presses like _MOUSEBUTTON(3) and _BUTTONCHANGE(2) returns events.
_BUTTON(3) returns Right button presses like _MOUSEBUTTON(2) and _BUTTONCHANGE(3) returns events.
Note that middle _BUTTON(2) is equivalent to _MOUSEBUTTON(3)!


_LASTWHEEL(2) will normally return 3 wheels where the first two return relative coordinate movements when set.
_WHEEL(number) returns -1 when wheel is scrolled up or forward and 1 when wheel is scrolled down or backward.
_WHEEL(1) returns relative horizontal pixel moves after _MOUSEMOVEMENTX or Y enables relative mode.
_WHEEL(2) returns relative vertical pixel moves after _MOUSEMOVEMENTX or Y enables relative mode.
_WHEEL(3) returns -1 when scroll wheel is moved forward or up and 1 when scrolled backward or down.
Relative WHEEL move values are negative when mouse is moved up or left. Positive when mouse is moved down or right.
WHEEL values can be added for a cumulative movement value when needed. Scroll reads can be off program screen.

(Return to Table of Contents)


CONTROLLER

[[NAME][manufacturer name]] may follow in the controller _DEVICE$ string. Devices can be joysticks, game pads or multi-stick.


[CONTROLLER][[DeviceName]description][BUTTON][AXIS][WHEEL]


Normally device numbers 3 or higher, controllers may have any number of [[[AXIS]]], [[[BUTTON]]] and/or [[[WHEEL]]] controls.


_LASTAXIS(device_number) normally returns dual axis representing the horizontal and vertical axis or view point("top hat").
_AXIS(number) returns a SINGLE value from -1 to 1 with 0 representing the axis center.
_AXIS(1) returns the horizontal axis position.
_AXIS(2) returns the vertical axis position.
Note: Some slide controls may only have one axis!


_LASTBUTTON(device_number) will return the number of buttons or triggers a device has.
_BUTTONCHANGE(number) returns -1 when pressed, 1 when released and 0 when there is no event since the last read.
_BUTTON(number) returns -1 when button number is pressed and 0 when released.


_LASTWHEEL(device_number) will return the number of wheel controls a device has.
_WHEEL(number) returns -1 when wheel is scrolled up or forward and 1 when wheel is scrolled down or backward.

(Return to Table of Contents)


Examples

Displays all keyboard, mouse and game controller button, axis and wheel control input values when each device is being used.
PRINT "Use relative mouse movement mode with ESC key exit only?(Y/N) ";
K$ = UCASE$(INPUT$(1))
PRINT K$
PRINT

FOR i = 1 TO _DEVICES 'DEVICES MUST be read first!
    PRINT STR$(i) + ") " + _DEVICE$(i) + " Buttons:"; _LASTBUTTON(i); ",Axis:"; _LASTAXIS(i); ",Wheel:"; _LASTWHEEL(i)
NEXT
IF K$ = "Y" THEN dummy = _MOUSEMOVEMENTX 'enable relative mouse movement reads
PRINT

DO
    x& = _DEVICEINPUT 'determines which device is currently being used
    IF x& = 1 THEN
        PRINT "Keyboard: ";
        FOR b = 1 TO _LASTBUTTON(x&)
            bb = _BUTTONCHANGE(b)
            IF bb THEN PRINT b; bb; _BUTTON(b);
        NEXT
        PRINT
    END IF
    IF x& > 1 THEN '  skip keyboard reads
        PRINT "Device:"; x&;
        FOR b = 1 TO _LASTBUTTON(x&)
            PRINT _BUTTONCHANGE(b); _BUTTON(b);
        NEXT
        FOR a = 1 TO _LASTAXIS(x&)
            PRINT _AXIS(a); 'mouse axis returns -1 to 1 with 0 center screen
        NEXT
        FOR w = 1 TO _LASTWHEEL(x&)
            PRINT _WHEEL(w); 'wheels 1 and 2 of mouse return relative pixel moves when enabled
        NEXT
        PRINT
    END IF
LOOP UNTIL INKEY$ = CHR$(27) 'escape key exit

END
Code by Ted Weissgerber
Note: When there is no device control to read, a FOR n = 1 TO 0 loop will not run thus avoiding a control function read error.
Using _MOUSEMOVEMENTX or Y will hide the mouse cursor and return relative mouse movements with the 1 and 2 _WHEEL controls.
_MOUSESHOW will return the mouse coordinate reads to the _AXIS control after it is used!

(Return to Table of Contents)


See also


Navigation:
Main Page with Articles and Tutorials
Keyword Reference - Alphabetical
Keyword Reference - By usage
Report a broken link
Retrieved from "https://qb64phoenix.com/qb64wiki/index.php?title=Controller_Devices&oldid=8356"