.. _stdlib_input_index:

=====
Input
=====

This section provides a description of the input-related functionality.

* :ref:`Input consts <stdlib_input_consts>` covers key codes for handling input states from buttons on mouse, keyboard and gamepad (for both raw input events and action set button indexes).
* :ref:`Action set module <stdlib_action_set_input_state>` provides functionality related to action sets, including:

   * enumerations and structures for action types
   * functions to define and manage action sets, as well as functions to handle state of actions

* :ref:`Raw input module <stdlib_global_input_state>` provides functionality related for global input state, including:

   * enumerations and structures for types of mouse, keyboard, and gamepad raw events
   * functions to handle these events

.. warning::
   Raw input module is not recommended for use due to lack of built-in cross-platform support. It is recommended to use the :ref:`Action set module <stdlib_action_set_input_state>` instead



To use the entire input module, add the following line to your project file::

   require engine.input_core // or require engine.core

.. toctree::
   :maxdepth: 2
   :caption: Contents:


   index/input_consts.rst
   index/action_set_core.rst
   index/input_core.rst