Blam::Input Namespace Reference

Functions
BLAM int	HandleCharacterInput (WPARAM wParam)
	Handles character based input. More...
BLAM int	HandleKeyPress (WPARAM wParam)
	Handles virtual key based input. More...
BLAM void	FireKeyPress (SDL_Keycode key)
	Fires a key press event. More...
BLAM void	FireCharacterInput (char character)
	Fires a character input event. More...
BLAM void	SetKeyState (SDL_Keycode key, bool down)
BLAM bool	IsKeyDown (SDL_Keycode key)
BLAM void	FireMouseClick (uint8_t button)
BLAM void	FireMouseMove (int x, int y)
BLAM void	SetMouseButtonState (uint8_t button, bool down)
BLAM bool	IsMouseButtonDown (uint8_t button)

Function Documentation

FireCharacterInput()

void Blam::Input::FireCharacterInput

(

char

character

)

Fires a character input event.

Parameters

character

- The character that was pressed.

FireKeyPress()

void Blam::Input::FireKeyPress

(

SDL_Keycode

key

)

Fires a key press event.

Parameters

key	- The virtual key code that was pressed.

FireMouseClick()

void Blam::Input::FireMouseClick

(

uint8_t

button

)

FireMouseMove()

void Blam::Input::FireMouseMove	(	int	x,
		int	y
	)

HandleCharacterInput()

int Blam::Input::HandleCharacterInput

(

WPARAM

wParam

)

Handles character based input.

Recieved from the WM_CHAR message.

Deprecated:

No longer in use due to SDL being used instead of Win32 for window creation. Will be removed.

Todo:

Remove.

Parameters

wParam

- The wParam from the Main window procedure, contains the character that was pressed.

Returns

0

HandleKeyPress()

int Blam::Input::HandleKeyPress

(

WPARAM

wParam

)

Handles virtual key based input.

Recieved from the WM_KEYDOWN message.

Deprecated:

No longer in use due to SDL being used instead of Win32 for window creation. Will be removed.

Todo:

Remove.

Parameters

wParam

- The wParam from the Main window procedure, contains the virtual key code of the pressed key.

Returns

0

IsKeyDown()

bool Blam::Input::IsKeyDown

(

SDL_Keycode

key

)

IsMouseButtonDown()

bool Blam::Input::IsMouseButtonDown

(

uint8_t

button

)

SetKeyState()

void Blam::Input::SetKeyState	(	SDL_Keycode	key,
		bool	down
	)

SetMouseButtonState()

void Blam::Input::SetMouseButtonState	(	uint8_t	button,
		bool	down
	)