logo

qmk_firmware

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

unicodemap.h (958B)

    

  1. // Copyright 2023 QMK
  2. // SPDX-License-Identifier: GPL-2.0-or-later
  4. #pragma once
  6. #include <stdint.h>
  7. #include "progmem.h"
  9. /**
  10.  * \file
  11.  *
  12.  * \defgroup unicodemap Unicode Map
  13.  * \{
  14.  */
  16. extern const uint32_t unicode_map[] PROGMEM;
  18. /**
  19.  * \brief Get the index into the `unicode_map` array for the given keycode, respecting shift state for pair keycodes.
  20.  *
  21.  * \param keycode The Unicode Map keycode to get the index of.
  22.  *
  23.  * \return An index into the `unicode_map` array.
  24.  */
  25. uint8_t unicodemap_index(uint16_t keycode);
  27. /**
  28.  * \brief Get the code point for the given index in the `unicode_map` array.
  29.  *
  30.  * \param index The index into the `unicode_map` array.
  31.  *
  32.  * \return A Unicode code point value.
  33.  */
  34. uint32_t unicodemap_get_code_point(uint8_t index);
  36. /**
  37.  * \brief Send the code point for the given index in the `unicode_map` array.
  38.  *
  39.  * \param index The index into the `unicode_map` array.
  40.  */
  41. void register_unicodemap(uint8_t index);
  43. /** \} */