cfb.h File Reference

Public Monochrome Character Framebuffer API. More...

#include <zephyr/device.h>
#include <zephyr/drivers/display.h>
#include <zephyr/sys/iterable_sections.h>

Go to the source code of this file.

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_HEIGHT = 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_draw_circle (const struct device *dev, const struct cfb_position *start, uint16_t radius)
	Draw a circle.
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.

Detailed Description

Public Monochrome Character Framebuffer API.