IND_Input Class Reference
[IND_Input]

List of all members.

Public Member Functions
bool	Init (IND_Render *pRender)
void	End ()
Input common
void	Update ()
bool	Quit ()
Keyboard
bool	OnKeyPress (IND_Key pKey)
bool	OnKeyRelease (IND_Key pKey)
bool	IsKeyPressed (IND_Key pKey)
bool	IsKeyPressed (IND_Key pKey, unsigned long pTime)
Mouse
bool	IsMouseMotion ()
int	GetMouseX ()
int	GetMouseY ()
bool	OnMouseButtonPress (IND_MouseButton pMouseButton)
bool	OnMouseButtonRelease (IND_MouseButton pMouseButton)
bool	IsMouseButtonPressed (IND_MouseButton pMouseButton)
bool	IsMouseButtonPressed (IND_MouseButton pMouseButton, unsigned long pTime)

---

Detailed Description

IND_Input is a wrapper class of SDL input functions for giving IndieLib the possibility of keyboard and mouse Input.

---

Member Function Documentation

bool IND_Input::Init

(

IND_Render *

pRender

)

Operation: This function returns 1 (true) if the adminstrator is successfully initialized. Must be called before using any method.

void IND_Input::End

(

)

Operation:

This function frees the manager and all the objects that it contains.

void IND_Input::Update

(

)

Operation:

Update input function. This method has to be called everytime in the game loop.

bool IND_Input::Quit

(

)

Operation:

This method returns true if the user closes the window.

bool IND_Input::OnKeyPress

(

IND_Key

pKey

)

Parameters:

• pKey Key that we want to check. See IND_Key.

Operation:

This function returns true if the key passed as pKey parameter is pressed.

bool IND_Input::OnKeyRelease

(

IND_Key

pKey

)

Parameters:

• pKey Key that we want to check. See IND_Key.

Operation:

This function returns true if the key passed as pKey parameter is released.

bool IND_Input::IsKeyPressed

(

IND_Key

pKey

)

Parameters:

• pKey Key that we want to check. See IND_Key.

Operation:

This function returns true if the key passed as pKey parameter is being pressed.

bool IND_Input::IsKeyPressed	(	IND_Key	pKey,
		unsigned long	pTime
	)

Parameters:

• pKey Key that we want to check. See IND_Key.
• pTime Time that has to pass in milliseconds.

Operation:

This function returns true if the key passed as pKey parameter has been pressed pTime milliseconds.

bool IND_Input::IsMouseMotion

(

)

Operation:

This function returns the true if the mouse is moving

int IND_Input::GetMouseX

(

)

Operation:

This function returns the horizontal position of the mouse in screen pixels

int IND_Input::GetMouseY

(

)

Operation:

This function returns the vertical position of the mouse in screen pixels

bool IND_Input::OnMouseButtonPress

(

IND_MouseButton

pMouseButton

)

Parameters:

• pMouseButton Mouse button that we want to check. See IND_MouseButton.

Operation:

This function returns true if the mouse button passed as pMouseButton is pressed. It will return true again only if the button is released and pressed again.

bool IND_Input::OnMouseButtonRelease

(

IND_MouseButton

pMouseButton

)

Parameters:

• pMouseButton Mouse button that we want to check. See IND_MouseButton.

Operation:

This function returns true if the mouse button passed as pMouseButton is released. It will return true again only if the button is pressed and released again.

bool IND_Input::IsMouseButtonPressed

(

IND_MouseButton

pMouseButton

)

Parameters:

• pMouseButton Mouse button that we want to check. See IND_MouseButton.

Operation:

This function returns true if the mouse button passed as pMouseButton is being pressed.

bool IND_Input::IsMouseButtonPressed	(	IND_MouseButton	pMouseButton,
		unsigned long	pTime
	)

Parameters:

• pMouseButton Mouse button that we want to check. See IND_MouseButton.
• pTime Time that has to pass in milliseconds.

Operation:

This function returns true if the mouse button passed as pMouseButton parameter has been pressed pTime milliseconds.

---

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

• G:/trabajo/programacion/IndieLib/IndieLib Rep/IndieLib/Common/LibHeaders/IND_Input.h
• G:/trabajo/programacion/IndieLib/IndieLib Rep/IndieLib/Common/LibSources/IND_Input.cpp

---