Zephyr API Documentation  2.7.0-rc2
A Scalable Open Source RTOS
Monochrome Character Framebuffer

Public Monochrome Character Framebuffer API. More...

Data Structures

struct  cfb_font
 

Macros

#define FONT_ENTRY_DEFINE(_name, _width, _height, _caps, _data, _fc, _lc)
 Macro for creating a font entry. More...
 

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, char *str, uint16_t x, uint16_t y)
 Print a string into the framebuffer. More...
 
int cfb_framebuffer_clear (const struct device *dev, bool clear_display)
 Clear framebuffer. More...
 
int cfb_framebuffer_invert (const struct device *dev)
 Invert Pixels. More...
 
int cfb_framebuffer_finalize (const struct device *dev)
 Finalize framebuffer and write it to display RAM, invert or reorder pixels if necessary. More...
 
int cfb_get_display_parameter (const struct device *dev, enum cfb_display_param)
 Get display parameter. More...
 
int cfb_framebuffer_set_font (const struct device *dev, uint8_t idx)
 Set font. More...
 
int cfb_get_font_size (const struct device *dev, uint8_t idx, uint8_t *width, uint8_t *height)
 Get font size. More...
 
int cfb_get_numof_fonts (const struct device *dev)
 Get number of fonts. More...
 
int cfb_framebuffer_init (const struct device *dev)
 Initialize Character Framebuffer. More...
 

Detailed Description

Public Monochrome Character Framebuffer API.

Macro Definition Documentation

◆ FONT_ENTRY_DEFINE

#define FONT_ENTRY_DEFINE (   _name,
  _width,
  _height,
  _caps,
  _data,
  _fc,
  _lc 
)

#include <include/display/cfb.h>

Value:
static const STRUCT_SECTION_ITERABLE(cfb_font, _name) = { \
.data = _data, \
.caps = _caps, \
.width = _width, \
.height = _height, \
.first_char = _fc, \
.last_char = _lc, \
}
#define STRUCT_SECTION_ITERABLE(struct_type, name)
Defines a new iterable section.
Definition: common.h:199
Definition: cfb.h:50

Macro for creating a font entry.

Parameters
_nameName of the font entry.
_widthWidth of the font in pixels
_heightHeight of the font in pixels.
_capsFont capabilities.
_dataRaw data of the font.
_fcCharacter mapped to first font element.
_lcCharacter mapped to last font element.

Enumeration Type Documentation

◆ cfb_display_param

#include <include/display/cfb.h>

Enumerator
CFB_DISPLAY_HEIGH 
CFB_DISPLAY_WIDTH 
CFB_DISPLAY_PPT 
CFB_DISPLAY_ROWS 
CFB_DISPLAY_COLS 

◆ cfb_font_caps

#include <include/display/cfb.h>

Enumerator
CFB_FONT_MONO_VPACKED 
CFB_FONT_MONO_HPACKED 
CFB_FONT_MSB_FIRST 

Function Documentation

◆ cfb_framebuffer_clear()

int cfb_framebuffer_clear ( const struct device dev,
bool  clear_display 
)

#include <include/display/cfb.h>

Clear framebuffer.

Parameters
devPointer to device structure for driver instance
clear_displayClear the display as well
Returns
0 on success, negative value otherwise

◆ cfb_framebuffer_finalize()

int cfb_framebuffer_finalize ( const struct device dev)

#include <include/display/cfb.h>

Finalize framebuffer and write it to display RAM, invert or reorder pixels if necessary.

Parameters
devPointer to device structure for driver instance
Returns
0 on success, negative value otherwise

◆ cfb_framebuffer_init()

int cfb_framebuffer_init ( const struct device dev)

#include <include/display/cfb.h>

Initialize Character Framebuffer.

Parameters
devPointer to device structure for driver instance
Returns
0 on success, negative value otherwise

◆ cfb_framebuffer_invert()

int cfb_framebuffer_invert ( const struct device dev)

#include <include/display/cfb.h>

Invert Pixels.

Parameters
devPointer to device structure for driver instance
Returns
0 on success, negative value otherwise

◆ cfb_framebuffer_set_font()

int cfb_framebuffer_set_font ( const struct device dev,
uint8_t  idx 
)

#include <include/display/cfb.h>

Set font.

Parameters
devPointer to device structure for driver instance
idxFont index
Returns
0 on success, negative value otherwise

◆ cfb_get_display_parameter()

int cfb_get_display_parameter ( const struct device dev,
enum  cfb_display_param 
)

#include <include/display/cfb.h>

Get display parameter.

Parameters
devPointer to device structure for driver instance
cfb_display_paramOne of the display parameters
Returns
Display parameter value

◆ cfb_get_font_size()

int cfb_get_font_size ( const struct device dev,
uint8_t  idx,
uint8_t width,
uint8_t height 
)

#include <include/display/cfb.h>

Get font size.

Parameters
devPointer to device structure for driver instance
idxFont index
widthPointers to the variable where the font width will be stored.
heightPointers to the variable where the font height will be stored.
Returns
0 on success, negative value otherwise

◆ cfb_get_numof_fonts()

int cfb_get_numof_fonts ( const struct device dev)

#include <include/display/cfb.h>

Get number of fonts.

Parameters
devPointer to device structure for driver instance
Returns
number of fonts

◆ cfb_print()

int cfb_print ( const struct device dev,
char *  str,
uint16_t  x,
uint16_t  y 
)

#include <include/display/cfb.h>

Print a string into the framebuffer.

Parameters
devPointer to device structure for driver instance
strString to print
xPosition in X direction of the beginning of the string
yPosition in Y direction of the beginning of the string
Returns
0 on success, negative value otherwise