logo

qmk_firmware

custom branch of QMK firmware git clone https://anongit.hacktivis.me/git/qmk_firmware.git

charybdis.h (3710B)

    

  1. /*
  2.  * Copyright 2021 Quentin LEBASTARD <qlebastard@gmail.com>
  3.  * Copyright 2021 Charly Delay <charly@codesink.dev> (@0xcharly)
  4.  *
  5.  * This program is free software: you can redistribute it and/or modify
  6.  * it under the terms of the GNU General Public License as published by
  7.  * the Free Software Foundation, either version 2 of the License, or
  8.  * (at your option) any later version.
  9.  *
  10.  * This program is distributed in the hope that it will be useful,
  11.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13.  * GNU General Public License for more details.
  14.  *
  15.  * You should have received a copy of the GNU General Public License
  16.  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17.  */
  19. #pragma once
  21. #include "quantum.h"
  23. #ifdef POINTING_DEVICE_ENABLE
  24. #    ifndef NO_CHARYBDIS_KEYCODES
  25. enum charybdis_keycodes {
  26.     POINTER_DEFAULT_DPI_FORWARD = QK_KB_0,
  27.     POINTER_DEFAULT_DPI_REVERSE,
  28.     POINTER_SNIPING_DPI_FORWARD,
  29.     POINTER_SNIPING_DPI_REVERSE,
  30.     SNIPING_MODE,
  31.     SNIPING_MODE_TOGGLE,
  32.     DRAGSCROLL_MODE,
  33.     DRAGSCROLL_MODE_TOGGLE,
  34. };
  36. #        define DPI_MOD POINTER_DEFAULT_DPI_FORWARD
  37. #        define DPI_RMOD POINTER_DEFAULT_DPI_REVERSE
  38. #        define S_D_MOD POINTER_SNIPING_DPI_FORWARD
  39. #        define S_D_RMOD POINTER_SNIPING_DPI_REVERSE
  40. #        define SNIPING SNIPING_MODE
  41. #        define SNP_TOG SNIPING_MODE_TOGGLE
  42. #        define DRGSCRL DRAGSCROLL_MODE
  43. #        define DRG_TOG DRAGSCROLL_MODE_TOGGLE
  44. #    endif // !NO_CHARYBDIS_KEYCODES
  46. /** \brief Return the current DPI value for the pointer's default mode. */
  47. uint16_t charybdis_get_pointer_default_dpi(void);
  49. /**
  50.  * \brief Update the pointer's default DPI to the next or previous step.
  51.  *
  52.  * Increases the DPI value if `forward` is `true`, decreases it otherwise.
  53.  * The increment/decrement steps are equal to CHARYBDIS_DEFAULT_DPI_CONFIG_STEP.
  54.  *
  55.  * The new value is persisted in EEPROM.
  56.  */
  57. void charybdis_cycle_pointer_default_dpi(bool forward);
  59. /**
  60.  * \brief Same as `charybdis_cycle_pointer_default_dpi`, but do not write to
  61.  * EEPROM.
  62.  *
  63.  * This means that reseting the board will revert the value to the last
  64.  * persisted one.
  65.  */
  66. void charybdis_cycle_pointer_default_dpi_noeeprom(bool forward);
  68. /** \brief Return the current DPI value for the pointer's sniper-mode. */
  69. uint16_t charybdis_get_pointer_sniping_dpi(void);
  71. /**
  72.  * \brief Update the pointer's sniper-mode DPI to the next or previous step.
  73.  *
  74.  * Increases the DPI value if `forward` is `true`, decreases it otherwise.
  75.  * The increment/decrement steps are equal to CHARYBDIS_SNIPING_DPI_CONFIG_STEP.
  76.  *
  77.  * The new value is persisted in EEPROM.
  78.  */
  79. void charybdis_cycle_pointer_sniping_dpi(bool forward);
  81. /**
  82.  * \brief Same as `charybdis_cycle_pointer_sniping_dpi`, but do not write to
  83.  * EEPROM.
  84.  *
  85.  * This means that reseting the board will revert the value to the last
  86.  * persisted one.
  87.  */
  88. void charybdis_cycle_pointer_sniping_dpi_noeeprom(bool forward);
  90. /** \brief Whether sniper-mode is enabled. */
  91. bool charybdis_get_pointer_sniping_enabled(void);
  93. /**
  94.  * \brief Enable/disable sniper mode.
  95.  *
  96.  * When sniper mode is enabled the dpi is reduced to slow down the pointer for
  97.  * more accurate movements.
  98.  */
  99. void charybdis_set_pointer_sniping_enabled(bool enable);
  101. /** \brief Whether drag-scroll is enabled. */
  102. bool charybdis_get_pointer_dragscroll_enabled(void);
  104. /**
  105.  * \brief Enable/disable drag-scroll mode.
  106.  *
  107.  * When drag-scroll mode is enabled, horizontal and vertical pointer movements
  108.  * are translated into horizontal and vertical scroll movements.
  109.  */
  110. void charybdis_set_pointer_dragscroll_enabled(bool enable);
  111. #endif // POINTING_DEVICE_ENABLE