Data Structures
struct	orxINPUT_EVENT_PAYLOAD
Defines
#define	orxINPUT_KU32_BINDING_NUMBER 4
Enumerations
enum	orxINPUT_EVENT { orxINPUT_EVENT_ON = 0, orxINPUT_EVENT_OFF, orxINPUT_EVENT_NUMBER, orxINPUT_EVENT_NONE = orxENUM_NONE }
enum	orxINPUT_TYPE { orxINPUT_TYPE_KEYBOARD_KEY = 0, orxINPUT_TYPE_MOUSE_BUTTON, orxINPUT_TYPE_MOUSE_AXIS, orxINPUT_TYPE_JOYSTICK_BUTTON, orxINPUT_TYPE_JOYSTICK_AXIS, orxINPUT_TYPE_EXTERNAL, orxINPUT_TYPE_NUMBER, orxINPUT_TYPE_NONE = orxENUM_NONE }
Functions
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_Bind (const orxSTRING _zName, orxINPUT_TYPE _eType, orxENUM _eID)
orxDLLAPI void orxFASTCALL	orxInput_Exit ()
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_GetActiveBinding (orxINPUT_TYPE _peType, orxENUM _peID)
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_GetBinding (const orxSTRING _zName, orxU32 _u32BindingIndex, orxINPUT_TYPE _peType, orxENUM _peID)
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_GetBindingList (const orxSTRING _zName, orxINPUT_TYPE _aeTypeList[orxINPUT_KU32_BINDING_NUMBER], orxENUM _aeIDList[orxINPUT_KU32_BINDING_NUMBER])
orxDLLAPI const orxSTRING orxFASTCALL	orxInput_GetBindingName (orxINPUT_TYPE _eType, orxENUM _eID)
orxDLLAPI const orxSTRING orxFASTCALL	orxInput_GetBoundInput (orxINPUT_TYPE _eType, orxENUM _eID, orxU32 _u32InputIndex)
orxDLLAPI orxU32 orxFASTCALL	orxInput_GetBoundInputCounter (orxINPUT_TYPE _eType, orxENUM _eID)
orxDLLAPI const orxSTRING orxFASTCALL	orxInput_GetCurrentSet ()
orxDLLAPI orxFLOAT orxFASTCALL	orxInput_GetValue (const orxSTRING _zInputName)
orxDLLAPI orxBOOL orxFASTCALL	orxInput_HasNewStatus (const orxSTRING _zInputName)
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_Init ()
orxDLLAPI orxBOOL orxFASTCALL	orxInput_IsActive (const orxSTRING _zInputName)
orxDLLAPI orxBOOL orxFASTCALL	orxInput_IsInCombineMode (const orxSTRING _zName)
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_Load (const orxSTRING _zFileName)
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_ResetValue (const orxSTRING _zInputName)
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_Save (const orxSTRING _zFileName)
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_SelectSet (const orxSTRING _zSetName)
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_SetCombineMode (const orxSTRING _zName, orxBOOL _bCombine)
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_SetPermanentValue (const orxSTRING _zInputName, orxFLOAT _fValue)
orxDLLAPI void orxFASTCALL	orxInput_Setup ()
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_SetValue (const orxSTRING _zInputName, orxFLOAT _fValue)
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_Unbind (orxINPUT_TYPE _eType, orxENUM _eID)

Detailed Description

Input module Module that handles generalized inputs (keyboard, mouse, joystick, ...)

Define Documentation

#define orxINPUT_KU32_BINDING_NUMBER 4

Misc defines

Definition at line 56 of file orxInput.h.

Enumeration Type Documentation

enum orxINPUT_EVENT

Event enum

Enumerator:

orxINPUT_EVENT_ON
orxINPUT_EVENT_OFF
orxINPUT_EVENT_NUMBER
orxINPUT_EVENT_NONE

Definition at line 78 of file orxInput.h.

enum orxINPUT_TYPE

Input type enum

Enumerator:

orxINPUT_TYPE_KEYBOARD_KEY
orxINPUT_TYPE_MOUSE_BUTTON
orxINPUT_TYPE_MOUSE_AXIS
orxINPUT_TYPE_JOYSTICK_BUTTON
orxINPUT_TYPE_JOYSTICK_AXIS
orxINPUT_TYPE_EXTERNAL
orxINPUT_TYPE_NUMBER
orxINPUT_TYPE_NONE

Definition at line 61 of file orxInput.h.

Function Documentation

orxDLLAPI orxSTATUS orxFASTCALL orxInput_Bind	(	const orxSTRING	_zName,
		orxINPUT_TYPE	_eType,
		orxENUM	_eID
	)

Binds an input to a mouse/joystick button, keyboard key or joystick axis

Parameters:

[in]	_zName	Concerned input name
[in]	_eType	Type of peripheral to bind
[in]	_eID	ID of button/key/axis to bind

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxInput_Exit ( )

Exits from Input module

orxDLLAPI orxSTATUS orxFASTCALL orxInput_GetActiveBinding	(	orxINPUT_TYPE *	_peType,
		orxENUM *	_peID
	)

Gets active binding (current pressed key/button/...) so as to allow on-the-fly user rebinding

Parameters:

[out]	_peType	Active binding type (mouse/joystick button, keyboard key or joystick axis)
[out]	_peID	Active binding ID (ID of button/key/axis to bind)

Returns:: orxSTATUS_SUCCESS if one active binding is found, orxSTATUS_FAILURE otherwise

orxDLLAPI orxSTATUS orxFASTCALL orxInput_GetBinding	(	const orxSTRING	_zName,
		orxU32	_u32BindingIndex,
		orxINPUT_TYPE *	_peType,
		orxENUM *	_peID
	)

Gets an input binding (mouse/joystick button, keyboard key or joystick axis) at a given index

Parameters:

[in]	_zName	Concerned input name
[in]	_u32BindingIndex	Index of the desired binding
[out]	_peType	List of binding types (if a slot is not bound, its value is orxINPUT_TYPE_NONE)
[out]	_peID	List of binding IDs (button/key/axis)

Returns:: orxSTATUS_SUCCESS if input exists, orxSTATUS_FAILURE otherwise

orxDLLAPI orxSTATUS orxFASTCALL orxInput_GetBindingList	(	const orxSTRING	_zName,
		orxINPUT_TYPE	_aeTypeList[orxINPUT_KU32_BINDING_NUMBER],
		orxENUM	_aeIDList[orxINPUT_KU32_BINDING_NUMBER]
	)

Gets an input binding (mouse/joystick button, keyboard key or joystick axis) list

Parameters:

[in]	_zName	Concerned input name
[out]	_aeTypeList	List of binding types (if a slot is not bound, its value is orxINPUT_TYPE_NONE)
[out]	_aeIDList	List of binding IDs (button/key/axis)

Returns:: orxSTATUS_SUCCESS if input exists, orxSTATUS_FAILURE otherwise

orxDLLAPI const orxSTRING orxFASTCALL orxInput_GetBindingName	(	orxINPUT_TYPE	_eType,
		orxENUM	_eID
	)

Gets a binding name

Parameters:

[in]	_eType	Binding type (mouse/joystick button, keyboard key or joystick axis)
[in]	_eID	Binding ID (ID of button/key/axis to bind)

Returns:: orxSTRING (binding's name) if success, orxSTRING_EMPTY otherwise

orxDLLAPI const orxSTRING orxFASTCALL orxInput_GetBoundInput	(	orxINPUT_TYPE	_eType,
		orxENUM	_eID,
		orxU32	_u32InputIndex
	)

Gets the input name to which a mouse/joystick button, keyboard key or joystick axis is bound (at given index)

Parameters:

[in]	_eType	Type of peripheral to test
[in]	_eID	ID of button/key/axis to test
[in]	_u32InputIndex	Index of the desired input

Returns:: orxSTRING input name if bound / orxSTRING_EMPY otherwise

orxDLLAPI orxU32 orxFASTCALL orxInput_GetBoundInputCounter	(	orxINPUT_TYPE	_eType,
		orxENUM	_eID
	)

Gets the input counter to which a mouse/joystick button, keyboard key or joystick axis is bound

Parameters:

[in]	_eType	Type of peripheral to test
[in]	_eID	ID of button/key/axis to test

Returns:: Number of bound inputs

orxDLLAPI const orxSTRING orxFASTCALL orxInput_GetCurrentSet ( )

Gets current working set

Returns:: Current selected set

orxDLLAPI orxFLOAT orxFASTCALL orxInput_GetValue ( const orxSTRING _zInputName )

Gets input value

Parameters:

[in] _zInputName Concerned input name

Returns:: orxFLOAT

orxDLLAPI orxBOOL orxFASTCALL orxInput_HasNewStatus ( const orxSTRING _zInputName )

Has a new active status since this frame?

Parameters:

[in] _zInputName Concerned input name

Returns:: orxTRUE if active status is new, orxFALSE otherwise

orxDLLAPI orxSTATUS orxFASTCALL orxInput_Init ( )

Initializes Input module

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxBOOL orxFASTCALL orxInput_IsActive ( const orxSTRING _zInputName )

Is input active?

Parameters:

[in] _zInputName Concerned input name

Returns:: orxTRUE if active, orxFALSE otherwise

orxDLLAPI orxBOOL orxFASTCALL orxInput_IsInCombineMode ( const orxSTRING _zName )

Is an input in combine mode?

Parameters:

[in] _zName Concerned input name

Returns:: orxTRUE if the input is in combine mode, orxFALSE otherwise

orxDLLAPI orxSTATUS orxFASTCALL orxInput_Load ( const orxSTRING _zFileName )

Loads inputs from config

Parameters:

[in] _zFileName File name to load, will use current loaded config if orxSTRING_EMPTY/orxNULL

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxInput_ResetValue ( const orxSTRING _zInputName )

Resets input value (peripheral inputs will then be used instead of code ones)

Parameters:

[in] _zInputName Concerned input name

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxInput_Save ( const orxSTRING _zFileName )

Saves inputs to config

Parameters:

[in] _zFileName File name

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxInput_SelectSet ( const orxSTRING _zSetName )

Selects current working set

Parameters:

[in] _zSetName Set name to select

orxDLLAPI orxSTATUS orxFASTCALL orxInput_SetCombineMode	(	const orxSTRING	_zName,
		orxBOOL	_bCombine
	)

Sets an input combine mode

Parameters:

[in]	_zName	Concerned input name
[in]	_bCombine	If orxTRUE, all assigned bindings need to be active in order to activate input, otherwise input will be considered active if any of its binding is

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxInput_SetPermanentValue	(	const orxSTRING	_zInputName,
		orxFLOAT	_fValue
	)

Sets permanent input value (will prevail on peripheral inputs till reset)

Parameters:

[in]	_zInputName	Concerned input name
[in]	_fValue	Value to set, orxFLOAT_0 to deactivate

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxInput_Setup ( )

Input module setup

orxDLLAPI orxSTATUS orxFASTCALL orxInput_SetValue	(	const orxSTRING	_zInputName,
		orxFLOAT	_fValue
	)

Sets input value (will prevail on peripheral inputs only once)

Parameters:

[in]	_zInputName	Concerned input name
[in]	_fValue	Value to set, orxFLOAT_0 to deactivate

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxInput_Unbind	(	orxINPUT_TYPE	_eType,
		orxENUM	_eID
	)

Unbinds a mouse/joystick button, keyboard key or joystick axis

Parameters:

[in]	_eType	Type of peripheral to unbind
[in]	_eID	ID of button/key/axis to unbind

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

OrxInput

Data Structures

Defines

Enumerations

Functions

Detailed Description

Define Documentation

Enumeration Type Documentation

Function Documentation