.. include:: ../../defs.hrst

Events
######

.. doxygenclass:: obscura::Event
   :members:
   :undoc-members:

Available event categories and causes
-------------------------------------

.. doxygenenum:: obscura::EventCategory

.. doxygenenum:: obscura::EventCause

Available events in |Obscura|
-----------------------------

Keyboard events
***************

.. doxygenclass:: obscura::KeyEvent
   :members:
   :undoc-members:

.. doxygentypedef:: obscura::KeyPressedEvent

.. doxygentypedef:: obscura::KeyReleasedEvent

.. doxygentypedef:: obscura::KeyRepeatedEvent

Mouse events
************

.. doxygenclass:: obscura::MouseMovedEvent
   :members:
   :undoc-members:

.. doxygenclass:: obscura::MouseClickedEvent
   :members:
   :undoc-members:

.. doxygenclass:: obscura::MouseScrolledEvent
   :members:
   :undoc-members:

Window events
*************

.. doxygenclass:: obscura::WindowEvent
   :members:
   :undoc-members:

Loop events
***********

.. doxygenclass:: obscura::TickEvent
   :members:
   :undoc-members:

Helper functions
----------------

.. doxygenfunction:: obscura::eventCode

.. doxygenfunction:: obscura::getCategoryFromCode

.. doxygenfunction:: obscura::getCauseFromCode

Example
-------

The following code shows the creation of a custom event class:

.. literalinclude:: ../../../../examples/use_custom_event.cxx
   :language: c++