1 | /* ---------------------------------------------------------------------------- */ |
---|
2 | /* Atmel Microcontroller Software Support */ |
---|
3 | /* SAM Software Package License */ |
---|
4 | /* ---------------------------------------------------------------------------- */ |
---|
5 | /* Copyright (c) 2015, Atmel Corporation */ |
---|
6 | /* */ |
---|
7 | /* All rights reserved. */ |
---|
8 | /* */ |
---|
9 | /* Redistribution and use in source and binary forms, with or without */ |
---|
10 | /* modification, are permitted provided that the following condition is met: */ |
---|
11 | /* */ |
---|
12 | /* - Redistributions of source code must retain the above copyright notice, */ |
---|
13 | /* this list of conditions and the disclaimer below. */ |
---|
14 | /* */ |
---|
15 | /* Atmel's name may not be used to endorse or promote products derived from */ |
---|
16 | /* this software without specific prior written permission. */ |
---|
17 | /* */ |
---|
18 | /* DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR */ |
---|
19 | /* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF */ |
---|
20 | /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE */ |
---|
21 | /* DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT, */ |
---|
22 | /* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT */ |
---|
23 | /* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, */ |
---|
24 | /* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF */ |
---|
25 | /* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING */ |
---|
26 | /* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, */ |
---|
27 | /* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ |
---|
28 | /* ---------------------------------------------------------------------------- */ |
---|
29 | |
---|
30 | /** |
---|
31 | * \file |
---|
32 | * |
---|
33 | * Interface for draw font on LCD. |
---|
34 | * |
---|
35 | */ |
---|
36 | |
---|
37 | /** |
---|
38 | * |
---|
39 | * \section Purpose |
---|
40 | * |
---|
41 | * The font.h files declares a font structure and a LCDD_DrawChar function |
---|
42 | * that must be implemented by a font definition file to be used with the |
---|
43 | * LCDD_DrawString method of draw.h. |
---|
44 | * |
---|
45 | * The font10x14.c implements the necessary variable and function for a 10x14 |
---|
46 | * font. |
---|
47 | * |
---|
48 | * \section Usage |
---|
49 | * |
---|
50 | * -# Declare a gFont global variable with the necessary Font information. |
---|
51 | * -# Implement an LCDD_DrawChar function which displays the specified |
---|
52 | * character on the LCD. |
---|
53 | * -# Use the LCDD_DrawString method defined in draw.h to display a complete |
---|
54 | * string. |
---|
55 | */ |
---|
56 | |
---|
57 | #ifndef _LCD_FONT_ |
---|
58 | #define _LCD_FONT_ |
---|
59 | |
---|
60 | /*---------------------------------------------------------------------------- |
---|
61 | * Headers |
---|
62 | *----------------------------------------------------------------------------*/ |
---|
63 | |
---|
64 | #include <stdint.h> |
---|
65 | |
---|
66 | /*---------------------------------------------------------------------------- |
---|
67 | * Types |
---|
68 | *----------------------------------------------------------------------------*/ |
---|
69 | |
---|
70 | |
---|
71 | /** \brief Describes the font (width, height, supported characters, etc.) used by |
---|
72 | * the LCD driver draw API. |
---|
73 | */ |
---|
74 | typedef struct _Font { |
---|
75 | /* Font width in pixels. */ |
---|
76 | uint8_t width; |
---|
77 | /* Font height in pixels. */ |
---|
78 | uint8_t height; |
---|
79 | } Font; |
---|
80 | |
---|
81 | /*---------------------------------------------------------------------------- |
---|
82 | * Variables |
---|
83 | *----------------------------------------------------------------------------*/ |
---|
84 | |
---|
85 | /** Global variable describing the font being instanced. */ |
---|
86 | extern const Font gFont; |
---|
87 | |
---|
88 | /*---------------------------------------------------------------------------- |
---|
89 | * Exported functions |
---|
90 | *----------------------------------------------------------------------------*/ |
---|
91 | |
---|
92 | extern void LCDD_DrawChar( |
---|
93 | uint16_t *pCanvasBuffer, |
---|
94 | uint32_t x, |
---|
95 | uint32_t y, |
---|
96 | uint8_t c, |
---|
97 | uint32_t color); |
---|
98 | |
---|
99 | extern void LCD_DrawString( |
---|
100 | uint16_t *pCanvasBuffer, |
---|
101 | uint32_t dwX, |
---|
102 | uint32_t dwY, |
---|
103 | const uint8_t *pString, |
---|
104 | uint32_t color); |
---|
105 | |
---|
106 | |
---|
107 | #endif /* #ifndef LCD_FONT_ */ |
---|
108 | |
---|