Documentation
==============================

.. rst-class:: lead

   Increase immersion and framerates in games with the Beam Eye Tracker SDK |version|

.. important::
   Version |version| requires Beam Eye Tracker 2.6.3 or later. As of 2026-07-05,
   Beam Eye Tracker 2.6.3 is however only available as a beta release.

   We nevertheless strongly recommend using the SDK version |version| for the
   :doc:`features/sim_game_camera` feature, either directly or through the provided
   plugins. Older versions are missing functionality critical to user experience.

   For all other functionality, you can safely build and test using version 2.1.0, but
   we still recommend shipping the |version| redistributables in your application for
   future compatibility. The |version| redistributables are ABI-compatible with applications
   built against version 2.1.0.

.. toctree::
   :hidden:
   :maxdepth: 3

   basics/index
   features/features
   integration/integration
   api/index
   info/info

.. card:: Start with the basics
   :link: basics/index
   :link-type: doc
   :img-top:   /media/card_icons/Basics.svg
   :class-card: left-square-image-card
   
   Get started with the Beam Eye Tracker SDK.

.. card:: Core features
   :link: features/features
   :link-type: doc
   :img-top:   /media/card_icons/Racing.svg
   :class-card: left-square-image-card
   
   Explore in detail what you can do with the Beam Eye Tracker SDK.

.. card:: Ready to use plugins and samples
   :link: integration/integration
   :link-type: doc
   :img-top:   /media/card_icons/Integrations.svg
   :class-card: left-square-image-card
   
   Press the skip button and go to the samples and plugins.

.. card:: API Reference
   :link: api/index
   :link-type: doc
   :img-top:   /media/card_icons/Programming.svg
   :class-card: left-square-image-card
   
   Reference for the main supported programming languages .

.. card:: Versioning & Legal
   :link: info/info
   :link-type: doc
   :img-top:   /media/card_icons/Information.svg
   :class-card: left-square-image-card
   
   Details about version history, licensing and third-party components.
