1 /**
2  * \file
3  *
4  * \brief Monochrome graphic library framebuffer device
5  *
6  * Copyright (c) 2011-2015 Atmel Corporation. All rights reserved.
7  *
8  * \asf_license_start
9  *
10  * \page License
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions are met:
14  *
15  * 1. Redistributions of source code must retain the above copyright notice,
16  *    this list of conditions and the following disclaimer.
17  *
18  * 2. Redistributions in binary form must reproduce the above copyright notice,
19  *    this list of conditions and the following disclaimer in the documentation
20  *    and/or other materials provided with the distribution.
21  *
22  * 3. The name of Atmel may not be used to endorse or promote products derived
23  *    from this software without specific prior written permission.
24  *
25  * 4. This software may only be redistributed and used in connection with an
26  *    Atmel microcontroller product.
27  *
28  * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
29  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
30  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
31  * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
32  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
36  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
37  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38  * POSSIBILITY OF SUCH DAMAGE.
39  *
40  * \asf_license_stop
41  *
42  */
43 /*
44  * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
45  */
46 #ifndef GFX_MONO_FRAMEBUFFER
47 #define GFX_MONO_FRAMEBUFFER
48 
49 #include "gfx_mono.h"
50 
51 #ifdef __cplusplus
52 extern "C" {
53 #endif
54 
55 /**
56  * \ingroup asfdoc_common2_gfx_mono
57  * \defgroup asfdoc_common2_gfx_mono_framebuffer_group Framebuffer
58  *
59  * This module provides read/write from and to a framebuffer in RAM. This is
60  * needed when using a controller that does not provide a way to read back data
61  * from the LCD controller memory. In this case we need to buffer the data in
62  * a local framebuffer to allow manipulation on pixel level. It is generally
63  * not recommended to access the framebuffer directly; this is handled by the
64  * graphic driver when needed.
65  *
66  * @{
67  */
68 
69 void gfx_mono_set_framebuffer(uint8_t *framebuffer);
70 
71 void gfx_mono_framebuffer_put_page(gfx_mono_color_t *data, gfx_coord_t page,
72 		gfx_coord_t page_offset, gfx_coord_t width);
73 
74 void gfx_mono_framebuffer_get_page(gfx_mono_color_t *data, gfx_coord_t page,
75 		gfx_coord_t page_offset, gfx_coord_t width);
76 
77 void gfx_mono_framebuffer_draw_pixel(gfx_coord_t x, gfx_coord_t y,
78 		gfx_mono_color_t color);
79 
80 uint8_t gfx_mono_framebuffer_get_pixel(gfx_coord_t x, gfx_coord_t y);
81 
82 void gfx_mono_framebuffer_put_byte(gfx_coord_t page, gfx_coord_t column,
83 		uint8_t data);
84 
85 uint8_t gfx_mono_framebuffer_get_byte(gfx_coord_t page, gfx_coord_t column);
86 
87 void gfx_mono_framebuffer_mask_byte(gfx_coord_t page, gfx_coord_t column,
88 		gfx_mono_color_t pixel_mask, gfx_mono_color_t color);
89 
90 /** @} */
91 
92 #ifdef __cplusplus
93 }
94 #endif
95 
96 #endif /* GFX_MONO_FRAMEBUFFER */
97