VSF Documented
Data Structures | Macros | Functions
vsf_fbcon.h File Reference
#include "component/ui/vsf_ui_cfg.h"
#include "component/ui/disp/vsf_disp.h"
#include "service/simple_stream/vsf_simple_stream.h"
#include "utilities/ooc_class.h"

Go to the source code of this file.

Data Structures

class  vsf_fbcon_t
 

Macros

#define VSF_FBCON_CFG_FONT_WIDTH   8
 
#define VSF_FBCON_CFG_FONT_HEIGHT   16
 
#define VSF_FBCON_CFG_TAB_WIDTH   8
 
#define VSF_FBCON_MAX_ROWS   32
 

Functions

vsf_err_t vsf_fbcon_init (vsf_fbcon_t *fbcon)
 
void vsf_fbcon_fini (vsf_fbcon_t *fbcon)
 

Macro Definition Documentation

◆ VSF_FBCON_CFG_FONT_WIDTH

#define VSF_FBCON_CFG_FONT_WIDTH   8

◆ VSF_FBCON_CFG_FONT_HEIGHT

#define VSF_FBCON_CFG_FONT_HEIGHT   16

◆ VSF_FBCON_CFG_TAB_WIDTH

#define VSF_FBCON_CFG_TAB_WIDTH   8

◆ VSF_FBCON_MAX_ROWS

#define VSF_FBCON_MAX_ROWS   32

Function Documentation

◆ vsf_fbcon_init()

vsf_err_t vsf_fbcon_init ( vsf_fbcon_t fbcon)
extern

vsf_fbcon_init - initialize the framebuffer console

Parameters
fbconpointer to a vsf_fbcon_t instance whose public members (disp, stream) have been set by the caller.
Returns
VSF_ERR_NONE on success.

Typical usage: vsf_fbcon_t con; con.disp = &my_display.use_as__vk_disp_t; con.stream = &my_fifo_stream.use_as__vsf_stream_t; vsf_fbcon_init(&con);

◆ vsf_fbcon_fini()

void vsf_fbcon_fini ( vsf_fbcon_t fbcon)
extern

vsf_fbcon_fini - finalize and release fbcon resources

Parameters
fbconpointer to a previously initialized vsf_fbcon_t instance.

Disconnects the stream rx subscription, frees the internal pixel buffer and character grid. The caller-owned disp and stream are NOT touched.

Generated from commit: vsfteam/vsf@c3767bf