Zephyr API Documentation  3.6.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
cfb.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2018 PHYTEC Messtechnik GmbH
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
12#ifndef __CFB_H__
13#define __CFB_H__
14
15#include <zephyr/device.h>
18
19#ifdef __cplusplus
20extern "C" {
21#endif
22
36};
37
42};
43
44struct cfb_font {
45 const void *data;
51};
52
56};
57
69#define FONT_ENTRY_DEFINE(_name, _width, _height, _caps, _data, _fc, _lc) \
70 static const STRUCT_SECTION_ITERABLE(cfb_font, _name) = { \
71 .data = _data, \
72 .caps = _caps, \
73 .width = _width, \
74 .height = _height, \
75 .first_char = _fc, \
76 .last_char = _lc, \
77 }
78
89int cfb_print(const struct device *dev, const char *const str, uint16_t x, uint16_t y);
90
103int cfb_draw_text(const struct device *dev, const char *const str, int16_t x, int16_t y);
104
113int cfb_draw_point(const struct device *dev, const struct cfb_position *pos);
114
124int cfb_draw_line(const struct device *dev, const struct cfb_position *start,
125 const struct cfb_position *end);
126
136int cfb_draw_rect(const struct device *dev, const struct cfb_position *start,
137 const struct cfb_position *end);
138
147int cfb_framebuffer_clear(const struct device *dev, bool clear_display);
148
156int cfb_framebuffer_invert(const struct device *dev);
157
169int cfb_invert_area(const struct device *dev, uint16_t x, uint16_t y,
170 uint16_t width, uint16_t height);
171
180int cfb_framebuffer_finalize(const struct device *dev);
181
190int cfb_get_display_parameter(const struct device *dev,
191 enum cfb_display_param);
192
201int cfb_framebuffer_set_font(const struct device *dev, uint8_t idx);
202
211int cfb_set_kerning(const struct device *dev, int8_t kerning);
212
223int cfb_get_font_size(const struct device *dev, uint8_t idx, uint8_t *width,
224 uint8_t *height);
225
233int cfb_get_numof_fonts(const struct device *dev);
234
242int cfb_framebuffer_init(const struct device *dev);
243
244#ifdef __cplusplus
245}
246#endif
247
252#endif /* __CFB_H__ */
Public API for display drivers and applications.
int cfb_draw_rect(const struct device *dev, const struct cfb_position *start, const struct cfb_position *end)
Draw a rectangle.
int cfb_framebuffer_set_font(const struct device *dev, uint8_t idx)
Set font.
int cfb_framebuffer_init(const struct device *dev)
Initialize Character Framebuffer.
cfb_display_param
Definition: cfb.h:30
int cfb_draw_text(const struct device *dev, const char *const str, int16_t x, int16_t y)
Print a string into the framebuffer.
int cfb_get_numof_fonts(const struct device *dev)
Get number of fonts.
int cfb_get_font_size(const struct device *dev, uint8_t idx, uint8_t *width, uint8_t *height)
Get font size.
int cfb_draw_line(const struct device *dev, const struct cfb_position *start, const struct cfb_position *end)
Draw a line.
int cfb_print(const struct device *dev, const char *const str, uint16_t x, uint16_t y)
Print a string into the framebuffer.
int cfb_framebuffer_invert(const struct device *dev)
Invert Pixels.
int cfb_framebuffer_finalize(const struct device *dev)
Finalize framebuffer and write it to display RAM, invert or reorder pixels if necessary.
int cfb_set_kerning(const struct device *dev, int8_t kerning)
Set font kerning (spacing between individual letters).
int cfb_framebuffer_clear(const struct device *dev, bool clear_display)
Clear framebuffer.
int cfb_invert_area(const struct device *dev, uint16_t x, uint16_t y, uint16_t width, uint16_t height)
Invert Pixels in selected area.
int cfb_draw_point(const struct device *dev, const struct cfb_position *pos)
Draw a point.
cfb_font_caps
Definition: cfb.h:38
int cfb_get_display_parameter(const struct device *dev, enum cfb_display_param)
Get display parameter.
@ CFB_DISPLAY_PPT
Definition: cfb.h:33
@ CFB_DISPLAY_ROWS
Definition: cfb.h:34
@ CFB_DISPLAY_HEIGH
Definition: cfb.h:31
@ CFB_DISPLAY_COLS
Definition: cfb.h:35
@ CFB_DISPLAY_WIDTH
Definition: cfb.h:32
@ CFB_FONT_MONO_HPACKED
Definition: cfb.h:40
@ CFB_FONT_MONO_VPACKED
Definition: cfb.h:39
@ CFB_FONT_MSB_FIRST
Definition: cfb.h:41
#define BIT(n)
Unsigned integer with bit position n set (signed in assembly language).
Definition: util_macro.h:44
__UINT8_TYPE__ uint8_t
Definition: stdint.h:88
__UINT16_TYPE__ uint16_t
Definition: stdint.h:89
__INT8_TYPE__ int8_t
Definition: stdint.h:72
__INT16_TYPE__ int16_t
Definition: stdint.h:73
Definition: cfb.h:44
uint8_t first_char
Definition: cfb.h:49
enum cfb_font_caps caps
Definition: cfb.h:46
uint8_t last_char
Definition: cfb.h:50
uint8_t width
Definition: cfb.h:47
const void * data
Definition: cfb.h:45
uint8_t height
Definition: cfb.h:48
Definition: cfb.h:53
uint16_t x
Definition: cfb.h:54
uint16_t y
Definition: cfb.h:55
Runtime device structure (in ROM) per driver instance.
Definition: device.h:399