BRL.PolledInput · BlitzMax

The polled input module provides an easy way to detect keyboard and mouse input.

The functions in this module are only available when your program is running in Graphics mode. When working on GUI applications, you should use events instead.

Functions

`Function AppSuspended()`

Get app suspended state

Returns

True if application is currently suspended.

Example

SuperStrict

SetGraphicsDriver GLMax2DDriver()
Graphics 800,600

While Not KeyHit(KEY_ESCAPE)
    Cls
    If AppSuspended() = True
        DrawText "Application Suspended!",10,10
    Else
        DrawText "Application Running...",10,10
    EndIf
    Flip
Wend

`Function AppTerminate()`

Return app terminate state

Returns

True if user has requested to terminate application

Example

SuperStrict

Graphics 640,480,0

While Not AppTerminate() Or Not Confirm( "Terminate?" )

    Cls
    DrawText MouseX()+","+MouseY(),0,0
    Flip

Wend

`Function KeyHit( key )`

Check for key hit

The returned value represents the number of the times key has been hit since the last call to KeyHit with the same key.

See the key codes module for a list of valid key codes.

Returns

Number of times key has been hit.

Example

' keyhit.bmx

' the following code draws a circle every time the
' program detects the spacebar has been pressed
' and exits when it detects the ESCAPE key has
' been pressed

SuperStrict

Graphics 640,480
While Not KeyHit(KEY_ESCAPE)
    Cls
    If KeyHit(KEY_SPACE) DrawOval 0,0,640,480
    Flip
Wend

`Function KeyDown( key )`

Check for key state

See the key codes module for a list of valid keycodes.

Returns

True if key is currently down

Example

' keydown.bmx

' the following code draws a circle if the
' program detects the spacebar is pressed
' and exits when it detects the ESCAPE key has
' been pressed

SuperStrict

Graphics 640,480
While Not KeyHit(KEY_ESCAPE)
    Cls
    If KeyDown(KEY_SPACE) DrawOval 0,0,640,480
    Flip
Wend

`Function GetChar()`

Get next character

As the user hits keys on the keyboard, BlitzMax records the character codes of these keystrokes into an internal 'character queue'.

GetChar removes the next character code from this queue and returns it the application.

If the character queue is empty, 0 is returned.

Returns

The character code of the next character.

`Function FlushKeys(resetStates:Int = True)`

Flush key states and character queue.

FlushKeys resets the state of all keys to 'off', and resets the character queue used by GetChar.

`Function MouseX()`

Get mouse x location

The returned value is relative to the left of the screen.

Returns

Mouse x axis location

Example

' mousex.bmx

' the following tracks the position of the mouse

SuperStrict

Graphics 640,480
While Not KeyHit(KEY_ESCAPE)
    Cls
    DrawOval MouseX()-10,MouseY()-10,20,20
    Flip
Wend

`Function MouseY()`

Get mouse y location

The returned value is relative to the top of the screen.

Returns

Mouse y axis location

Example

' mousey.bmx

' the following tracks the position of the mouse

SuperStrict

Graphics 640,480
While Not KeyHit(KEY_ESCAPE)
    Cls
    DrawRect MouseX()-10,MouseY()-10,20,20
    Flip
Wend

`Function MouseZ()`

Get mouse wheel

The mouse wheel value increments when the mouse wheel is rolled 'away' from the user, and decrements when the mouse wheel is rolled 'towards' the user.

Returns

Mouse wheel value

Example

' mousez.bmx

' prints mousez() the mousewheel position

SuperStrict

Graphics 640,480
While Not KeyHit(KEY_ESCAPE)
    Cls
    DrawText "MouseZ()="+MouseZ(),0,0
    Flip
Wend

`Function MouseXSpeed()`

Get mouse x speed

Returns

Mouse x speed

`Function MouseYSpeed()`

Get mouse y speed

Returns

Mouse y speed

`Function MouseZSpeed()`

Get mouse z speed

Returns

Mouse z speed

`Function FlushMouse()`

Flush mouse button states

FlushMouse resets the state of all mouse buttons to 'off'.

`Function MouseHit( button )`

Check for mouse button click

The returned value represents the number of the times button has been clicked since the last call to MouseHit with the same button.

button should be 1 for the left mouse button, 2 for the right mouse button or 3 for the middle mouse button. Two further buttons, 4 and 5, are also available for mice that support them.

Returns

Number of times button has been clicked.

Example

' mousehit.bmx

SuperStrict

Graphics 640,480

While Not KeyHit(KEY_ESCAPE)
    Cls
    If MouseHit(1) DrawRect 0,0,200,200
    If MouseHit(2) DrawRect 200,0,200,200
    If MouseHit(3) DrawRect 400,0,200,200
    Flip
Wend

`Function MouseDown( button )`

Check for mouse button down state

button should be 1 for the left mouse button, 2 for the right mouse button or 3 for the middle mouse button. Two further buttons, 4 and 5, are also available for mice that support them.

Returns

True if button is currently down

Example

' mousedown.bmx

SuperStrict

Graphics 640,480

While Not KeyHit(KEY_ESCAPE)
    Cls
    If MouseDown(1) DrawRect 0,0,200,200
    If MouseDown(2) DrawRect 200,0,200,200
    If MouseDown(3) DrawRect 400,0,200,200
    Flip
Wend

`Function WaitKey()`

Wait for a key press

WaitKey suspends program execution until a key has been hit. The keycode of this key is then returned to the application.

See the key codes module for a list of valid keycodes.

Returns

The keycode of the pressed key

Example

SuperStrict

Graphics 640,480

DrawText "Press any key to end this program.", 10 , 10
Flip
WaitKey()

`Function WaitChar()`

Wait for a key press

WaitChar suspends program execution until a character is available from GetChar. This character is then returned to the application.

Returns

The character code of the pressed key

`Function WaitMouse()`

Wait for mouse button click

WaitMouse suspends program execution until a mouse button is clicked.

WaitMouse returns 1 if the left mouse button was clicked, 2 if the right mouse button was clicked or 3 if the middle mouse button was clicked.

Returns

The clicked button

Example

'detects which mouse button was pressed 

SuperStrict

Graphics 640,480

Repeat
    DrawText "Click Mouse to exit" , 200 , 200
    Flip 
Until WaitMouse()

`Function SetAutoPoll(value:Int)`

Enables or disables autopolling.