include/core/controller.hpp

   1 #ifndef _controller__hpp__included__
   2 #define _controller__hpp__included__
   3
   4 #include "controllerdata.hpp"
   5
   6 /**
   7  * Look up physcial controller ID by logical controller ID.
   8  *
   9  * parameter lid: Logical ID (0-7).
  10  * returns: Physical ID. -1 if there is no such logical controller.
  11  */
  12 int controller_index_by_logical(unsigned lid) throw();
  13 /**
  14  * Look up physcial controller ID by analog controller ID.
  15  *
  16  * parameter aid: Analog ID (0-2).
  17  * returns: Physical ID. -1 if there is no such controller.
  18  */
  19 int controller_index_by_analog(unsigned aid) throw();
  20 /**
  21  * Look up if controller is mouse by analog controller ID.
  22  *
  23  * parameter aid: Analog ID (0-2).
  24  * returns: True if ID points to mouse, otherwise false.
  25  */
  26 bool controller_ismouse_by_analog(unsigned aid) throw();
  27 /**
  28  * Look up type of controller by logical controller ID.
  29  *
  30  * parameter lid: Logical ID (0-7).
  31  * returns: The type of controller (not port!).
  32  */
  33 devicetype_t controller_type_by_logical(unsigned lid) throw();
  34 /**
  35  * Set port type.
  36  *
  37  * Parameter port: The port to set.
  38  * Parameter ptype: New port type.
  39  * Parameter set_core: If true, set port type in bsnes core, otherwise skip this step.
  40  */
  41 void controller_set_port_type(unsigned port, porttype_t ptype, bool set_core = true) throw();
  42
  43 /**
  44  * Get current controls, assuming given frame.
  45  *
  46  * Parameter frame: Current frame number.
  47  * Returns: Current controls, taking autohold and autofire into account.
  48  */
  49 controls_t get_current_controls(uint64_t frame);
  50
  51 /**
  52  * Send analog input.
  53  *
  54  * Parameter x: X position of click.
  55  * Parameter y: Y position of click.
  56  * Parameter index: Index of button (0-2).
  57  */
  58 void send_analog_input(int32_t x, int32_t y, unsigned index);
  59
  60 /**
  61  * Manipulate the reset flag in current controls.
  62  *
  63  * Parameter delay: Delay for reset (-1 for no reset)
  64  */
  65 void set_curcontrols_reset(int32_t delay);
  66
  67 /**
  68  * Change the state of autohold.
  69  *
  70  * Parameter pid: The physical ID of controller.
  71  * Parameter idx: The physical Index of the control.
  72  * Parameter newstate: New state for autohold.
  73  */
  74 void change_autohold(unsigned pid, unsigned idx, bool newstate);
  75
  76 /**
  77  * Read the state of autohold.
  78  *
  79  * Parameter pid: The physical ID of controller.
  80  * Parameter idx: The physical Index of the control.
  81  * Returns: True if autohold is in progress, false otherwise.
  82  */
  83 bool get_autohold(unsigned pid, unsigned idx);
  84
  85 /**
  86  * Get the name of button.
  87  *
  88  * Parameter lidx: The logical index of the controller.
  89  * Returns:
  90  */
  91 std::string get_button_name(unsigned lidx);
  92
  93 /**
  94  * Logical to physical control ID transition.
  95  *
  96  * Parameter dtype: The device type.
  97  * Parameter lidx: The logical index.
  98  * Returns: The physical index or -1 if the logical index is invalid for type.
  99  */
 100 int get_physcial_id_for_control(devicetype_t dtype, unsigned lidx);
 101
 102 #endif