Zephyr API Documentation 3.7.99
A Scalable Open Source RTOS
|
Public Monochrome Character Framebuffer API . More...
Data Structures | |
struct | cfb_font |
struct | cfb_position |
Macros | |
#define | FONT_ENTRY_DEFINE(_name, _width, _height, _caps, _data, _fc, _lc) |
Macro for creating a font entry. | |
Enumerations | |
enum | cfb_display_param { CFB_DISPLAY_HEIGH = 0 , CFB_DISPLAY_WIDTH , CFB_DISPLAY_PPT , CFB_DISPLAY_ROWS , CFB_DISPLAY_COLS } |
enum | cfb_font_caps { CFB_FONT_MONO_VPACKED = BIT(0) , CFB_FONT_MONO_HPACKED = BIT(1) , CFB_FONT_MSB_FIRST = BIT(2) } |
Functions | |
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_draw_text (const struct device *dev, const char *const str, int16_t x, int16_t y) |
Print a string into the framebuffer. | |
int | cfb_draw_point (const struct device *dev, const struct cfb_position *pos) |
Draw a point. | |
int | cfb_draw_line (const struct device *dev, const struct cfb_position *start, const struct cfb_position *end) |
Draw a line. | |
int | cfb_draw_rect (const struct device *dev, const struct cfb_position *start, const struct cfb_position *end) |
Draw a rectangle. | |
int | cfb_framebuffer_clear (const struct device *dev, bool clear_display) |
Clear framebuffer. | |
int | cfb_framebuffer_invert (const struct device *dev) |
Invert Pixels. | |
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_framebuffer_finalize (const struct device *dev) |
Finalize framebuffer and write it to display RAM, invert or reorder pixels if necessary. | |
int | cfb_get_display_parameter (const struct device *dev, enum cfb_display_param) |
Get display parameter. | |
int | cfb_framebuffer_set_font (const struct device *dev, uint8_t idx) |
Set font. | |
int | cfb_set_kerning (const struct device *dev, int8_t kerning) |
Set font kerning (spacing between individual letters). | |
int | cfb_get_font_size (const struct device *dev, uint8_t idx, uint8_t *width, uint8_t *height) |
Get font size. | |
int | cfb_get_numof_fonts (const struct device *dev) |
Get number of fonts. | |
int | cfb_framebuffer_init (const struct device *dev) |
Initialize Character Framebuffer. | |
void | cfb_framebuffer_deinit (const struct device *dev) |
Deinitialize Character Framebuffer. | |
Public Monochrome Character Framebuffer API .
#define FONT_ENTRY_DEFINE | ( | _name, | |
_width, | |||
_height, | |||
_caps, | |||
_data, | |||
_fc, | |||
_lc ) |
#include <zephyr/display/cfb.h>
Macro for creating a font entry.
_name | Name of the font entry. |
_width | Width of the font in pixels |
_height | Height of the font in pixels. |
_caps | Font capabilities. |
_data | Raw data of the font. |
_fc | Character mapped to first font element. |
_lc | Character mapped to last font element. |
enum cfb_display_param |
#include <zephyr/display/cfb.h>
Enumerator | |
---|---|
CFB_DISPLAY_HEIGH | |
CFB_DISPLAY_WIDTH | |
CFB_DISPLAY_PPT | |
CFB_DISPLAY_ROWS | |
CFB_DISPLAY_COLS |
enum cfb_font_caps |
#include <zephyr/display/cfb.h>
Enumerator | |
---|---|
CFB_FONT_MONO_VPACKED | |
CFB_FONT_MONO_HPACKED | |
CFB_FONT_MSB_FIRST |
int cfb_draw_line | ( | const struct device * | dev, |
const struct cfb_position * | start, | ||
const struct cfb_position * | end ) |
#include <zephyr/display/cfb.h>
Draw a line.
dev | Pointer to device structure for driver instance |
start | start position of the line |
end | end position of the line |
int cfb_draw_point | ( | const struct device * | dev, |
const struct cfb_position * | pos ) |
#include <zephyr/display/cfb.h>
Draw a point.
dev | Pointer to device structure for driver instance |
pos | position of the point |
int cfb_draw_rect | ( | const struct device * | dev, |
const struct cfb_position * | start, | ||
const struct cfb_position * | end ) |
#include <zephyr/display/cfb.h>
Draw a rectangle.
dev | Pointer to device structure for driver instance |
start | Top-Left position of the rectangle |
end | Bottom-Right position of the rectangle |
#include <zephyr/display/cfb.h>
Print a string into the framebuffer.
For compare to cfb_print, cfb_draw_text accept non tile-aligned coords and not line wrapping.
dev | Pointer to device structure for driver instance |
str | String to print |
x | Position in X direction of the beginning of the string |
y | Position in Y direction of the beginning of the string |
#include <zephyr/display/cfb.h>
Clear framebuffer.
dev | Pointer to device structure for driver instance |
clear_display | Clear the display as well |
void cfb_framebuffer_deinit | ( | const struct device * | dev | ) |
#include <zephyr/display/cfb.h>
Deinitialize Character Framebuffer.
dev | Pointer to device structure for driver instance |
int cfb_framebuffer_finalize | ( | const struct device * | dev | ) |
#include <zephyr/display/cfb.h>
Finalize framebuffer and write it to display RAM, invert or reorder pixels if necessary.
dev | Pointer to device structure for driver instance |
int cfb_framebuffer_init | ( | const struct device * | dev | ) |
#include <zephyr/display/cfb.h>
Initialize Character Framebuffer.
dev | Pointer to device structure for driver instance |
int cfb_framebuffer_invert | ( | const struct device * | dev | ) |
#include <zephyr/display/cfb.h>
Invert Pixels.
dev | Pointer to device structure for driver instance |
#include <zephyr/display/cfb.h>
Set font.
dev | Pointer to device structure for driver instance |
idx | Font index |
int cfb_get_display_parameter | ( | const struct device * | dev, |
enum | cfb_display_param ) |
#include <zephyr/display/cfb.h>
Get display parameter.
dev | Pointer to device structure for driver instance |
cfb_display_param | One of the display parameters |
#include <zephyr/display/cfb.h>
Get font size.
dev | Pointer to device structure for driver instance |
idx | Font index |
width | Pointers to the variable where the font width will be stored. |
height | Pointers to the variable where the font height will be stored. |
int cfb_get_numof_fonts | ( | const struct device * | dev | ) |
#include <zephyr/display/cfb.h>
Get number of fonts.
dev | Pointer to device structure for driver instance |
int cfb_invert_area | ( | const struct device * | dev, |
uint16_t | x, | ||
uint16_t | y, | ||
uint16_t | width, | ||
uint16_t | height ) |
#include <zephyr/display/cfb.h>
Invert Pixels in selected area.
dev | Pointer to device structure for driver instance |
x | Position in X direction of the beginning of area |
y | Position in Y direction of the beginning of area |
width | Width of area in pixels |
height | Height of area in pixels |
#include <zephyr/display/cfb.h>
Print a string into the framebuffer.
dev | Pointer to device structure for driver instance |
str | String to print |
x | Position in X direction of the beginning of the string |
y | Position in Y direction of the beginning of the string |
#include <zephyr/display/cfb.h>
Set font kerning (spacing between individual letters).
dev | Pointer to device structure for driver instance |
kerning | Font kerning |