Data Structures
struct	orxINPUT_EVENT_PAYLOAD

Macros
#define	orxINPUT_GET_FLAG(TYPE)
#define	orxINPUT_KC_MODE_PREFIX_NEGATIVE '-'
#define	orxINPUT_KC_MODE_PREFIX_POSITIVE '+'
#define	orxINPUT_KU32_BINDING_NUMBER 16
#define	orxINPUT_KU32_FLAG_TYPE_NONE 0x00000000
#define	orxINPUT_KU32_MASK_TYPE_ALL 0x0000FFFF
#define	orxINPUT_KZ_CONFIG_COMBINE_LIST "CombineList"
#define	orxINPUT_KZ_CONFIG_DEFAULT_MULTIPLIER "DefaultMultiplier"
#define	orxINPUT_KZ_CONFIG_DEFAULT_THRESHOLD "DefaultThreshold"
#define	orxINPUT_KZ_CONFIG_JOYSTICK_ID_LIST "JoyIDList"
#define	orxINPUT_KZ_CONFIG_SECTION "Input"
#define	orxINPUT_KZ_INTERNAL_SET_PREFIX "-="

Enumerations
enum	orxINPUT_EVENT { orxINPUT_EVENT_ON = 0 , orxINPUT_EVENT_OFF , orxINPUT_EVENT_SELECT_SET , orxINPUT_EVENT_REMOVE_SET , orxINPUT_EVENT_NUMBER , orxINPUT_EVENT_NONE = orxENUM_NONE }
enum	orxINPUT_MODE { orxINPUT_MODE_FULL = 0 , orxINPUT_MODE_POSITIVE , orxINPUT_MODE_NEGATIVE , orxINPUT_MODE_NUMBER , orxINPUT_MODE_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, orxINPUT_MODE _eMode, orxS32 _s32BindingIndex)
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_ClearSet (const orxSTRING _zSetName)
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_EnableSet (const orxSTRING _zSetName, orxBOOL _bEnable)
orxDLLAPI void orxFASTCALL	orxInput_Exit ()
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_GetActiveBinding (orxINPUT_TYPE _peType, orxENUM _peID, orxFLOAT *_pfValue)
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_GetBinding (const orxSTRING _zName, orxU32 _u32BindingIndex, orxINPUT_TYPE _peType, orxENUM _peID, orxINPUT_MODE *_peMode)
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_GetBindingList (const orxSTRING _zName, orxINPUT_TYPE _aeTypeList[orxINPUT_KU32_BINDING_NUMBER], orxENUM _aeIDList[orxINPUT_KU32_BINDING_NUMBER], orxINPUT_MODE _aeModeList[orxINPUT_KU32_BINDING_NUMBER])
orxDLLAPI const orxSTRING orxFASTCALL	orxInput_GetBindingName (orxINPUT_TYPE _eType, orxENUM _eID, orxINPUT_MODE _eMode)
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_GetBindingType (const orxSTRING _zName, orxINPUT_TYPE _peType, orxENUM _peID, orxINPUT_MODE *_peMode)
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_GetBoundInput (orxINPUT_TYPE _eType, orxENUM _eID, orxINPUT_MODE _eMode, orxU32 _u32InputIndex, const orxSTRING _pzName, orxU32 _pu32BindingIndex)
orxDLLAPI orxU32 orxFASTCALL	orxInput_GetBoundInputCount (orxINPUT_TYPE _eType, orxENUM _eID, orxINPUT_MODE _eMode)
orxDLLAPI const orxSTRING orxFASTCALL	orxInput_GetCurrentSet ()
orxDLLAPI orxFLOAT orxFASTCALL	orxInput_GetMultiplier (const orxSTRING _zInputName)
orxDLLAPI const orxSTRING orxFASTCALL	orxInput_GetNext (const orxSTRING _zInputName)
orxDLLAPI const orxSTRING orxFASTCALL	orxInput_GetNextSet (const orxSTRING _zSetName)
orxDLLAPI orxFLOAT orxFASTCALL	orxInput_GetThreshold (const orxSTRING _zInputName)
orxDLLAPI orxFLOAT orxFASTCALL	orxInput_GetValue (const orxSTRING _zInputName)
orxDLLAPI orxBOOL orxFASTCALL	orxInput_HasBeenActivated (const orxSTRING _zInputName)
orxDLLAPI orxBOOL orxFASTCALL	orxInput_HasBeenDeactivated (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 orxBOOL orxFASTCALL	orxInput_IsSetEnabled (const orxSTRING _zSetName)
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_Load (const orxSTRING _zFileName)
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_PopSet ()
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_PushSet (const orxSTRING _zSetName)
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_RemoveSet (const orxSTRING _zSetName)
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_SetMultiplier (const orxSTRING _zInputName, orxFLOAT _fMultiplier)
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_SetPermanentValue (const orxSTRING _zInputName, orxFLOAT _fValue)
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_SetThreshold (const orxSTRING _zInputName, orxFLOAT _fThreshold)
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_SetTypeFlags (orxU32 _u32AddTypeFlags, orxU32 _u32RemoveTypeFlags)
orxDLLAPI void orxFASTCALL	orxInput_Setup ()
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_SetValue (const orxSTRING _zInputName, orxFLOAT _fValue)
orxDLLAPI orxSTATUS orxFASTCALL	orxInput_Unbind (const orxSTRING _zName, orxS32 _s32BindingIndex)

Detailed Description

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

Macro Definition Documentation

◆ orxINPUT_GET_FLAG

#define orxINPUT_GET_FLAG ( TYPE )

Value:

((orxU32)(1U << (orxU32)(TYPE)))

Definition at line 69 of file orxInput.h.

◆ orxINPUT_KC_MODE_PREFIX_NEGATIVE

#define orxINPUT_KC_MODE_PREFIX_NEGATIVE '-'

Definition at line 67 of file orxInput.h.

◆ orxINPUT_KC_MODE_PREFIX_POSITIVE

#define orxINPUT_KC_MODE_PREFIX_POSITIVE '+'

Definition at line 66 of file orxInput.h.

◆ orxINPUT_KU32_BINDING_NUMBER

#define orxINPUT_KU32_BINDING_NUMBER 16

Definition at line 62 of file orxInput.h.

◆ orxINPUT_KU32_FLAG_TYPE_NONE

#define orxINPUT_KU32_FLAG_TYPE_NONE 0x00000000

Definition at line 70 of file orxInput.h.

◆ orxINPUT_KU32_MASK_TYPE_ALL

#define orxINPUT_KU32_MASK_TYPE_ALL 0x0000FFFF

Definition at line 71 of file orxInput.h.

◆ orxINPUT_KZ_CONFIG_COMBINE_LIST

#define orxINPUT_KZ_CONFIG_COMBINE_LIST "CombineList"

Combine input list

Definition at line 59 of file orxInput.h.

◆ orxINPUT_KZ_CONFIG_DEFAULT_MULTIPLIER

#define orxINPUT_KZ_CONFIG_DEFAULT_MULTIPLIER "DefaultMultiplier"

Input default multiplier

Definition at line 58 of file orxInput.h.

◆ orxINPUT_KZ_CONFIG_DEFAULT_THRESHOLD

#define orxINPUT_KZ_CONFIG_DEFAULT_THRESHOLD "DefaultThreshold"

Input default threshold

Definition at line 57 of file orxInput.h.

◆ orxINPUT_KZ_CONFIG_JOYSTICK_ID_LIST

#define orxINPUT_KZ_CONFIG_JOYSTICK_ID_LIST "JoyIDList"

Joystick ID list

Definition at line 60 of file orxInput.h.

◆ orxINPUT_KZ_CONFIG_SECTION

#define orxINPUT_KZ_CONFIG_SECTION "Input"

Misc defines Input section name

Definition at line 56 of file orxInput.h.

◆ orxINPUT_KZ_INTERNAL_SET_PREFIX

#define orxINPUT_KZ_INTERNAL_SET_PREFIX "-="

Definition at line 64 of file orxInput.h.

Enumeration Type Documentation

◆ orxINPUT_EVENT

enum orxINPUT_EVENT

Event enum

Enumerator
orxINPUT_EVENT_ON
orxINPUT_EVENT_OFF
orxINPUT_EVENT_SELECT_SET
orxINPUT_EVENT_REMOVE_SET
orxINPUT_EVENT_NUMBER
orxINPUT_EVENT_NONE

Definition at line 107 of file orxInput.h.

◆ orxINPUT_MODE

enum orxINPUT_MODE

Input mode enum

Enumerator
orxINPUT_MODE_FULL
orxINPUT_MODE_POSITIVE
orxINPUT_MODE_NEGATIVE
orxINPUT_MODE_NUMBER
orxINPUT_MODE_NONE

Definition at line 93 of file orxInput.h.

◆ orxINPUT_TYPE

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 76 of file orxInput.h.

Function Documentation

◆ orxInput_Bind()

orxDLLAPI orxSTATUS orxFASTCALL orxInput_Bind	(	const orxSTRING	_zName,
		orxINPUT_TYPE	_eType,
		orxENUM	_eID,
		orxINPUT_MODE	_eMode,
		orxS32	_s32BindingIndex )

extern

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
[in]	_eMode	Mode (only used for axis input)
[in]	_s32BindingIndex	Index of the desired binding, if < 0 the oldest binding will be replaced

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxInput_ClearSet()

orxDLLAPI orxSTATUS orxFASTCALL orxInput_ClearSet ( const orxSTRING _zSetName )

extern

Clears all input values of a set

Parameters

[in] _zSetName Set name to clear, will use current set if orxSTRING_EMPTY/orxNULL

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxInput_EnableSet()

orxDLLAPI orxSTATUS orxFASTCALL orxInput_EnableSet	(	const orxSTRING	_zSetName,
		orxBOOL	_bEnable )

extern

Enables/disables working set (without selecting it)

Parameters

[in]	_zSetName	Set name to enable/disable
[in]	_bEnable	Enable / Disable

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxInput_Exit()

orxDLLAPI void orxFASTCALL orxInput_Exit ( )

extern

Exits from Input module

◆ orxInput_GetActiveBinding()

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

extern

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

Parameters

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

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

◆ orxInput_GetBinding()

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

extern

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, should be less than orxINPUT_KU32_BINDING_NUMBER
[out]	_peType	Binding type (if a slot is not bound, its value is orxINPUT_TYPE_NONE)
[out]	_peID	Binding ID (button/key/axis)
[out]	_peMode	Mode (only used for axis inputs)

Returns: orxSTATUS_SUCCESS if input exists, orxSTATUS_FAILURE otherwise

◆ orxInput_GetBindingList()

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

extern

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)
[out]	_aeModeList	List of modes (only used for axis inputs)

Returns: orxSTATUS_SUCCESS if input exists, orxSTATUS_FAILURE otherwise

◆ orxInput_GetBindingName()

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

extern

Gets a binding name, don't keep the result as is as it'll get overridden during the next call to this function

Parameters

[in]	_eType	Binding type (mouse/joystick button, keyboard key or joystick axis)
[in]	_eID	Binding ID (ID of button/key/axis to bind)
[in]	_eMode	Mode (only used for axis input)

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

◆ orxInput_GetBindingType()

orxDLLAPI orxSTATUS orxFASTCALL orxInput_GetBindingType	(	const orxSTRING	_zName,
		orxINPUT_TYPE *	_peType,
		orxENUM *	_peID,
		orxINPUT_MODE *	_peMode )

extern

Gets a binding type and ID from its name

Parameters

[in]	_zName	Concerned input name
[out]	_peType	Binding type (mouse/joystick button, keyboard key or joystick axis)
[out]	_peID	Binding ID (ID of button/key/axis to bind)
[out]	_peMode	Binding mode (only used for axis input)

Returns: orxSTATUS_SUCCESS if input is valid, orxSTATUS_FAILURE otherwise

◆ orxInput_GetBoundInput()

orxDLLAPI orxSTATUS orxFASTCALL orxInput_GetBoundInput	(	orxINPUT_TYPE	_eType,
		orxENUM	_eID,
		orxINPUT_MODE	_eMode,
		orxU32	_u32InputIndex,
		const orxSTRING *	_pzName,
		orxU32 *	_pu32BindingIndex )

extern

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]	_eMode	Mode (only used for axis input)
[in]	_u32InputIndex	Index of the desired input
[out]	_pzName	Input name, mandatory
[out]	_pu32BindingIndex	Binding index for this input, ignored if orxNULL

Returns: orxSTATUS_SUCCESS if binding exists / orxSTATUS_FAILURE otherwise

◆ orxInput_GetBoundInputCount()

orxDLLAPI orxU32 orxFASTCALL orxInput_GetBoundInputCount	(	orxINPUT_TYPE	_eType,
		orxENUM	_eID,
		orxINPUT_MODE	_eMode )

extern

Gets the input count 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
[in]	_eMode	Mode (only used for axis input)

Returns: Number of bound inputs

◆ orxInput_GetCurrentSet()

orxDLLAPI const orxSTRING orxFASTCALL orxInput_GetCurrentSet ( )

extern

Gets current working set

Returns: Current selected set

◆ orxInput_GetMultiplier()

orxDLLAPI orxFLOAT orxFASTCALL orxInput_GetMultiplier ( const orxSTRING _zInputName )

extern

Gets input multiplier

Parameters

[in] _zInputName Concerned input name

Returns: Input multiplier if found, -1.0f otherwise

◆ orxInput_GetNext()

orxDLLAPI const orxSTRING orxFASTCALL orxInput_GetNext ( const orxSTRING _zInputName )

extern

Gets next input in current set

Parameters

[in] _zInputName Concerned input, orxNULL to get the first one

Returns: Input name / orxNULL

◆ orxInput_GetNextSet()

orxDLLAPI const orxSTRING orxFASTCALL orxInput_GetNextSet ( const orxSTRING _zSetName )

extern

Gets next set

Parameters

[in] _zSetName Concerned set, orxNULL to get the first one

Returns: Set name / orxNULL

◆ orxInput_GetThreshold()

orxDLLAPI orxFLOAT orxFASTCALL orxInput_GetThreshold ( const orxSTRING _zInputName )

extern

Gets input threshold

Parameters

[in] _zInputName Concerned input name

Returns: Input threshold

◆ orxInput_GetValue()

orxDLLAPI orxFLOAT orxFASTCALL orxInput_GetValue ( const orxSTRING _zInputName )

extern

Gets input value

Parameters

[in] _zInputName Concerned input name

Returns: orxFLOAT

◆ orxInput_HasBeenActivated()

orxDLLAPI orxBOOL orxFASTCALL orxInput_HasBeenActivated ( const orxSTRING _zInputName )

extern

Has input been activated (this frame)?

Parameters

[in] _zInputName Concerned input name

Returns: orxTRUE if newly activated since last frame, orxFALSE otherwise

◆ orxInput_HasBeenDeactivated()

orxDLLAPI orxBOOL orxFASTCALL orxInput_HasBeenDeactivated ( const orxSTRING _zInputName )

extern

Has input been deactivated (this frame)?

Parameters

[in] _zInputName Concerned input name

Returns: orxTRUE if newly deactivated since last frame, orxFALSE otherwise

◆ orxInput_HasNewStatus()

orxDLLAPI orxBOOL orxFASTCALL orxInput_HasNewStatus ( const orxSTRING _zInputName )

extern

Has a new active status since this frame?

Parameters

[in] _zInputName Concerned input name

Returns: orxTRUE if active status is new, orxFALSE otherwise

◆ orxInput_Init()

orxDLLAPI orxSTATUS orxFASTCALL orxInput_Init ( )

extern

Initializes Input module

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxInput_IsActive()

orxDLLAPI orxBOOL orxFASTCALL orxInput_IsActive ( const orxSTRING _zInputName )

extern

Is input active?

Parameters

[in] _zInputName Concerned input name

Returns: orxTRUE if active, orxFALSE otherwise

◆ orxInput_IsInCombineMode()

orxDLLAPI orxBOOL orxFASTCALL orxInput_IsInCombineMode ( const orxSTRING _zName )

extern

Is an input in combine mode?

Parameters

[in] _zName Concerned input name

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

◆ orxInput_IsSetEnabled()

orxDLLAPI orxBOOL orxFASTCALL orxInput_IsSetEnabled ( const orxSTRING _zSetName )

extern

Is working set enabled (includes current working set)?

Parameters

[in] _zSetName Set name to check

Returns: orxTRUE / orxFALSE

◆ orxInput_Load()

orxDLLAPI orxSTATUS orxFASTCALL orxInput_Load ( const orxSTRING _zFileName )

extern

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

◆ orxInput_PopSet()

orxDLLAPI orxSTATUS orxFASTCALL orxInput_PopSet ( )

extern

Pops last set from the stack

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxInput_PushSet()

orxDLLAPI orxSTATUS orxFASTCALL orxInput_PushSet ( const orxSTRING _zSetName )

extern

Pushes a set (storing the current one on the stack)

Parameters

[in] _zSetName Set name to push

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxInput_RemoveSet()

orxDLLAPI orxSTATUS orxFASTCALL orxInput_RemoveSet ( const orxSTRING _zSetName )

extern

Removes a set

Parameters

[in] _zSetName Set name to remove

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxInput_ResetValue()

orxDLLAPI orxSTATUS orxFASTCALL orxInput_ResetValue ( const orxSTRING _zInputName )

extern

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

Parameters

[in] _zInputName Concerned input name

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxInput_Save()

orxDLLAPI orxSTATUS orxFASTCALL orxInput_Save ( const orxSTRING _zFileName )

extern

Saves inputs to config

Parameters

[in] _zFileName File name

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxInput_SelectSet()

orxDLLAPI orxSTATUS orxFASTCALL orxInput_SelectSet ( const orxSTRING _zSetName )

extern

Selects (and enables) current working set

Parameters

[in] _zSetName Set name to select

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxInput_SetCombineMode()

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

extern

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

◆ orxInput_SetMultiplier()

orxDLLAPI orxSTATUS orxFASTCALL orxInput_SetMultiplier	(	const orxSTRING	_zInputName,
		orxFLOAT	_fMultiplier )

extern

Sets input multiplier, if not set the default global multiplier will be used

Parameters

[in]	_zInputName	Concerned input name
[in]	_fMultiplier	Multiplier value, can be negative

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxInput_SetPermanentValue()

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

extern

Sets permanent input value (will take precedence over peripheral inputs until reset)

Parameters

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

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxInput_SetThreshold()

orxDLLAPI orxSTATUS orxFASTCALL orxInput_SetThreshold	(	const orxSTRING	_zInputName,
		orxFLOAT	_fThreshold )

extern

Sets input threshold, if not set the default global threshold will be used

Parameters

[in]	_zInputName	Concerned input name
[in]	_fThreshold	Threshold value (between 0.0f and 1.0f)

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxInput_SetTypeFlags()

orxDLLAPI orxSTATUS orxFASTCALL orxInput_SetTypeFlags	(	orxU32	_u32AddTypeFlags,
		orxU32	_u32RemoveTypeFlags )

extern

Sets current set's type flags, only set types will be polled when updating the set (use orxINPUT_GET_FLAG(TYPE) in order to get the flag that matches a type)

Parameters

[in]	_u32AddTypeFlags	Type flags to add
[in]	_u32RemoveTypeFlags	Type flags to remove

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxInput_Setup()

orxDLLAPI void orxFASTCALL orxInput_Setup ( )

extern

Input module setup

◆ orxInput_SetValue()

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

extern

Sets input value (will take precedence over peripheral inputs only once)

Parameters

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

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxInput_Unbind()

orxDLLAPI orxSTATUS orxFASTCALL orxInput_Unbind	(	const orxSTRING	_zName,
		orxS32	_s32BindingIndex )

extern

Unbinds an input

Parameters

[in]	_zName	Concerned input name
[in]	_s32BindingIndex	Index of the desired binding, if < 0 all the bindings will be removed

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

Data Structures

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ orxINPUT_GET_FLAG

◆ orxINPUT_KC_MODE_PREFIX_NEGATIVE

◆ orxINPUT_KC_MODE_PREFIX_POSITIVE

◆ orxINPUT_KU32_BINDING_NUMBER

◆ orxINPUT_KU32_FLAG_TYPE_NONE

◆ orxINPUT_KU32_MASK_TYPE_ALL

◆ orxINPUT_KZ_CONFIG_COMBINE_LIST

◆ orxINPUT_KZ_CONFIG_DEFAULT_MULTIPLIER

◆ orxINPUT_KZ_CONFIG_DEFAULT_THRESHOLD

◆ orxINPUT_KZ_CONFIG_JOYSTICK_ID_LIST

◆ orxINPUT_KZ_CONFIG_SECTION

◆ orxINPUT_KZ_INTERNAL_SET_PREFIX

Enumeration Type Documentation

◆ orxINPUT_EVENT

◆ orxINPUT_MODE

◆ orxINPUT_TYPE

Function Documentation

◆ orxInput_Bind()

◆ orxInput_ClearSet()

◆ orxInput_EnableSet()

◆ orxInput_Exit()

◆ orxInput_GetActiveBinding()

◆ orxInput_GetBinding()

◆ orxInput_GetBindingList()

◆ orxInput_GetBindingName()

◆ orxInput_GetBindingType()

◆ orxInput_GetBoundInput()

◆ orxInput_GetBoundInputCount()

◆ orxInput_GetCurrentSet()

◆ orxInput_GetMultiplier()

◆ orxInput_GetNext()

◆ orxInput_GetNextSet()

◆ orxInput_GetThreshold()

◆ orxInput_GetValue()

◆ orxInput_HasBeenActivated()

◆ orxInput_HasBeenDeactivated()

◆ orxInput_HasNewStatus()

◆ orxInput_Init()

◆ orxInput_IsActive()

◆ orxInput_IsInCombineMode()

◆ orxInput_IsSetEnabled()

◆ orxInput_Load()

◆ orxInput_PopSet()

◆ orxInput_PushSet()

◆ orxInput_RemoveSet()

◆ orxInput_ResetValue()

◆ orxInput_Save()

◆ orxInput_SelectSet()

◆ orxInput_SetCombineMode()

◆ orxInput_SetMultiplier()

◆ orxInput_SetPermanentValue()

◆ orxInput_SetThreshold()

◆ orxInput_SetTypeFlags()

◆ orxInput_Setup()

◆ orxInput_SetValue()

◆ orxInput_Unbind()