include/io/orxInput.h

Go to the documentation of this file.

/* Orx - Portable Game Engine
 *
 * Copyright (c) 2008-2011 Orx-Project
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 *    1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 *
 *    2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 *
 *    3. This notice may not be removed or altered from any source
 *    distribution.
 */

#ifndef _orxINPUT_H_
#define _orxINPUT_H_


#include "orxInclude.h"

#include "io/orxJoystick.h"
#include "io/orxKeyboard.h"
#include "io/orxMouse.h"


#define orxINPUT_KU32_BINDING_NUMBER    4


typedef enum __orxINPUT_TYPE_t
{
  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

} orxINPUT_TYPE;

typedef enum __orxINPUT_EVENT_t
{
  orxINPUT_EVENT_ON = 0,
  orxINPUT_EVENT_OFF,

  orxINPUT_EVENT_NUMBER,

  orxINPUT_EVENT_NONE = orxENUM_NONE

} orxINPUT_EVENT;

typedef struct __orxINPUT_EVENT_PAYLOAD_t
{
  const orxSTRING zSetName;                               
  const orxSTRING zInputName;                             
  orxINPUT_TYPE   aeType[orxINPUT_KU32_BINDING_NUMBER];   
  orxENUM         aeID[orxINPUT_KU32_BINDING_NUMBER];     
  orxFLOAT        afValue[orxINPUT_KU32_BINDING_NUMBER];  
} orxINPUT_EVENT_PAYLOAD;


extern orxDLLAPI void orxFASTCALL       orxInput_Setup();

extern orxDLLAPI orxSTATUS orxFASTCALL  orxInput_Init();

extern orxDLLAPI void orxFASTCALL       orxInput_Exit();


extern orxDLLAPI orxSTATUS orxFASTCALL  orxInput_Load(const orxSTRING _zFileName);

extern orxDLLAPI orxSTATUS orxFASTCALL  orxInput_Save(const orxSTRING _zFileName);


extern orxDLLAPI orxSTATUS orxFASTCALL  orxInput_SelectSet(const orxSTRING _zSetName);

extern orxDLLAPI const orxSTRING orxFASTCALL orxInput_GetCurrentSet();


extern orxDLLAPI orxBOOL orxFASTCALL    orxInput_IsActive(const orxSTRING _zInputName);

extern orxDLLAPI orxBOOL orxFASTCALL    orxInput_HasNewStatus(const orxSTRING _zInputName);

extern orxDLLAPI orxFLOAT orxFASTCALL   orxInput_GetValue(const orxSTRING _zInputName);

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

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

extern orxDLLAPI orxSTATUS orxFASTCALL  orxInput_ResetValue(const orxSTRING _zInputName);


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

extern orxDLLAPI orxBOOL orxFASTCALL    orxInput_IsInCombineMode(const orxSTRING _zName);


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

extern orxDLLAPI orxSTATUS orxFASTCALL  orxInput_Unbind(orxINPUT_TYPE _eType, orxENUM _eID);

extern orxDLLAPI orxU32 orxFASTCALL     orxInput_GetBoundInputCounter(orxINPUT_TYPE _eType, orxENUM _eID);

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

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

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


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

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

#endif /*_orxINPUT_H_*/