SDLKeyboard Class Reference

The SDL implementation of the IKeyboard interface. More...

#include <Input/SDLKeyboard.h>

Public Member Functions
	SDLKeyboard ()
	Constructor.
virtual	~SDLKeyboard ()
	Deconstructor.
virtual bool	KeyDown (Key k) const
	Determines if the given Key is down.
virtual bool	KeyPressed (Key k) const
	Determines if the given Key was just pressed.
virtual bool	KeyPressedRepeat (Key k) const
	Determines if the given Key was just pressed or is being repeated.
virtual bool	KeyRepeat (Key k) const
	Determines if the given Key is being repeated.
virtual uint	InputQueueSize () const
	Returns the size of the input queue.
virtual const KeyData &	InputQueuePeek () const
	Returns the key at the top of the input queue.
virtual const KeyData &	InputQueueGet (uint i) const
	Returns the ith key in the input queue.
void	InputQueueClear ()
	Clears the iput queue.
void	Update (float dt)
	Call once a frame.
void	HandleEvent (const SDL_KeyboardEvent &event)
	Called each time an SDL keyboard event occures.

Detailed Description

The SDL implementation of the IKeyboard interface.

void SDLKeyboard::HandleEvent ( const SDL_KeyboardEvent & event )

Called each time an SDL keyboard event occures.

Parameters:

[in] event the SDL keyboard event.

bool SDLKeyboard::KeyDown ( Key k ) const [virtual]

Determines if the given Key is down.

Parameters:

[in] k the Key to check.

Implements IKeyboard.

bool SDLKeyboard::KeyPressed ( Key k ) const [virtual]

Determines if the given Key was just pressed.

Parameters:

[in] k the Key to check.

Implements IKeyboard.

bool SDLKeyboard::KeyPressedRepeat ( Key k ) const [virtual]

Determines if the given Key was just pressed or is being repeated.

Parameters:

[in] k the Key to check.

Returns:: True if the Key k was just pressed or is being repeated, false otherwise.

Implements IKeyboard.

bool SDLKeyboard::KeyRepeat ( Key k ) const [virtual]

Determines if the given Key is being repeated.

Parameters:

[in] k the Key to check.

Implements IKeyboard.

void SDLKeyboard::Update ( float dt )

Call once a frame.

Parameters:

[in] dt the time in seconds since the last frame.

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