Blame view

RIOT/sys/include/mineplex.h 1.4 KB
a752c7ab   elopes   add first test an...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
  /*
   * Copyright (C) 2016 Freie Universitรคt Berlin
   *
   * This file is subject to the terms and conditions of the GNU Lesser
   * General Public License v2.1. See the file LICENSE in the top level
   * directory for more details.
   */
  
  /**
   * @defgroup    sys_mineplex 5x5 Font 'Mineplex'
   * @ingroup     sys
   * @brief       The Mineplex font for containing 5x5 pixel ASCII characters
   * @{
   *
   * @file
   * @brief       Interface definition to access the Mineplex font
   *
   * @author      Hauke Petersen <hauke.petersen@fu-berlin.de>
   */
  
  #ifndef MINEPLEX_H
  #define MINEPLEX_H
  
  #include <stdint.h>
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  /**
   * @brief   The width of a single character in pixel
   */
  #define MINEPLEX_CHAR_W     (5U)
  
  /**
   * @brief   The height of a single character in pixel
   */
  #define MINEPLEX_CHAR_H     (5U)
  
  /**
   * @brief   Get the Mineplex representation of a given ASCII character
   *
   * The function returns the pointer to a 5 byte pointer containing the Mineplex
   * representation of the given ASCII character. The Mineplex character is
   * encoded row wise from top to bottom using the least significant 5 bit, where
   * byte 1, bit 1 is the top left pixel of the encoded character.
   *
   * @param[in] c         character to translate
   *
   * @return  a 5 byte big buffer containing the encoded Mineplex character
   */
  const uint8_t *mineplex_char(char c);
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif /* MINEPLEX_H */
  /** @} */