Falco Engine 3.9.0.1 (beta)
Static Public Member Functions | Properties | List of all members
FalcoEngine.Input Class Reference

Static Public Member Functions

static bool GetKey (ScanCode key)
 Returns true while the user holds down the key identified by the key ScanCode enum parameter More...
 
static bool GetKeyDown (ScanCode key)
 Returns true during the frame the user starts pressing down the key identified by the key ScanCode enum parameter More...
 
static bool GetKeyUp (ScanCode key)
 Returns true during the frame the user releases the key identified by the key ScanCode enum parameter More...
 
static bool GetMouseButton (int button)
 Returns whether the given mouse button is held down More...
 
static bool GetMouseButtonDown (int button)
 Returns true during the frame the user pressed the given mouse button More...
 
static bool GetMouseButtonUp (int button)
 Returns true during the frame the user releases the given mouse button More...
 
static Vector2 GetMouseWheel ()
 Returns direction in which the mouse wheel was scrolled More...
 

Properties

static Vector2 cursorDirection [get]
 Get mouse cursor direction (delta position) More...
 
static Vector2 cursorPosition [get]
 Get mouse cursor global position (from top left of the screen) More...
 
static Vector2 cursorRelativePosition [get]
 Get mouse cursor position relative to window (from top left of the window) More...
 

Detailed Description

Definition at line 5 of file Input.cs.

Member Function Documentation

◆ GetKey()

static bool FalcoEngine.Input.GetKey ( ScanCode  key)
static

Returns true while the user holds down the key identified by the key ScanCode enum parameter

Parameters
key
Returns

Definition at line 48 of file Input.cs.

◆ GetKeyDown()

static bool FalcoEngine.Input.GetKeyDown ( ScanCode  key)
static

Returns true during the frame the user starts pressing down the key identified by the key ScanCode enum parameter

Parameters
key
Returns

Definition at line 58 of file Input.cs.

◆ GetKeyUp()

static bool FalcoEngine.Input.GetKeyUp ( ScanCode  key)
static

Returns true during the frame the user releases the key identified by the key ScanCode enum parameter

Parameters
key
Returns

Definition at line 68 of file Input.cs.

◆ GetMouseButton()

static bool FalcoEngine.Input.GetMouseButton ( int  button)
static

Returns whether the given mouse button is held down

Parameters
button
Returns

Definition at line 78 of file Input.cs.

◆ GetMouseButtonDown()

static bool FalcoEngine.Input.GetMouseButtonDown ( int  button)
static

Returns true during the frame the user pressed the given mouse button

Parameters
button
Returns

Definition at line 88 of file Input.cs.

◆ GetMouseButtonUp()

static bool FalcoEngine.Input.GetMouseButtonUp ( int  button)
static

Returns true during the frame the user releases the given mouse button

Parameters
button
Returns

Definition at line 98 of file Input.cs.

◆ GetMouseWheel()

static Vector2 FalcoEngine.Input.GetMouseWheel ( )
static

Returns direction in which the mouse wheel was scrolled

Returns

Definition at line 107 of file Input.cs.

Property Documentation

◆ cursorDirection

Vector2 FalcoEngine.Input.cursorDirection
staticget

Get mouse cursor direction (delta position)

Definition at line 10 of file Input.cs.

◆ cursorPosition

Vector2 FalcoEngine.Input.cursorPosition
staticget

Get mouse cursor global position (from top left of the screen)

Definition at line 22 of file Input.cs.

◆ cursorRelativePosition

Vector2 FalcoEngine.Input.cursorRelativePosition
staticget

Get mouse cursor position relative to window (from top left of the window)

Definition at line 34 of file Input.cs.

The documentation for this class was generated from the following file: