InputState

Represents the entire input state for the duration of a processed frame

File location: framework/cauldron/framework/inc/core/inputmanager.h

Methods

Return type

Description

bool

GetKeyState (const KeyboardInputMappings inputID) const
Returns the key down state of the requested input mapping.

bool

GetKeyUpState (const KeyboardInputMappings inputID) const
Returns the key up state of the requested input mapping.

bool

GetMouseButtonState (const MouseButtonMappings inputID) const
Returns the button down state of the requested input mapping.

bool

GetMouseButtonUpState (const MouseButtonMappings inputID) const
Returns the button up state of the requested input mapping.

int64_t

GetMouseAxisDelta (const MouseAxisMappings inputID) const
Returns the axis value of the requested input mapping.

float

GetGamePadAxisState (const GamePadAxisMappings inputID) const
Returns axis value of the requested input mapping.

bool

GetGamePadButtonState (const GamePadButtonMappings inputID) const
Returns the button down state of the requested input mapping.

bool

GetGamePadButtonUpState (const GamePadButtonMappings inputID) const
Returns the button up state of the requested input mapping.

Detailed description

Represents the entire input state for the duration of a processed frame

Data fields

Type

Description

MouseState

Mouse
Represents the state of mouse input.

GamePadState

GamePad
Represents the state of gamepad input.

uint64_t

KeyboardState
Bitwise mapping of keyboard key down states for all monitored keys.

uint64_t

KeyboardUpState
Bitwise mapping of keyboard key up states for all monitored keys.

Methods

GetKeyState

Copied!

bool GetKeyState (const KeyboardInputMappings  inputID) const

Returns the key down state of the requested input mapping.


GetKeyUpState

Copied!

bool GetKeyUpState (const KeyboardInputMappings  inputID) const

Returns the key up state of the requested input mapping.


GetMouseButtonState

Copied!

bool GetMouseButtonState (const MouseButtonMappings  inputID) const

Returns the button down state of the requested input mapping.


GetMouseButtonUpState

Copied!

bool GetMouseButtonUpState (const MouseButtonMappings  inputID) const

Returns the button up state of the requested input mapping.


GetMouseAxisDelta

Copied!

int64_t GetMouseAxisDelta (const MouseAxisMappings  inputID) const

Returns the axis value of the requested input mapping.


GetGamePadAxisState

Copied!

float GetGamePadAxisState (const GamePadAxisMappings  inputID) const

Returns axis value of the requested input mapping.


GetGamePadButtonState

Copied!

bool GetGamePadButtonState (const GamePadButtonMappings  inputID) const

Returns the button down state of the requested input mapping.


GetGamePadButtonUpState

Copied!

bool GetGamePadButtonUpState (const GamePadButtonMappings  inputID) const

Returns the button up state of the requested input mapping.