VSF Documented
Data Structures | Macros | Typedefs | Functions
vsf_tgui_sv_port.c File Reference
#include "../../vsf_tgui.h"
#include <math.h>
#include <string.h>

Data Structures

struct  vsf_tgui_sv_port_info_t
 

Macros

#define __VSF_DISP_CLASS_INHERIT__
 
#define __VSF_TGUI_CLASS_INHERIT
 
#define VSF_TGUI_CFG_SV_PORT_SET_INIT_BG_COLOR   ENABLED
 
#define VSF_TGUI_CFG_SV_PORT_LOG   DISABLED
 
#define vsf_tgui_disp_color_prefix   rgb565
 
#define __disp_color_to_tgui_color(__disp_color)   ((vsf_tgui_v_color_t){ .value = __disp_color})
 
#define __tgui_color_to_disp_color(__tgui_color)   (__tgui_color.value)
 

Typedefs

typedef uint16_t vsf_tgui_disp_pixel_t
 
typedef vsf_tgui_sv_color_rgb565_t vsf_tgui_disp_tgui_pixel_t
 
typedef struct vsf_tgui_sv_port_info_t vsf_tgui_sv_port_info_t
 

Functions

unsigned char * vsf_tgui_tile_get_pixelmap (const vsf_tgui_tile_t *tile_ptr)
 
void vsf_tgui_sv_port_draw_rect (vsf_tgui_t *gui_ptr, vsf_tgui_location_t *location_ptr, vsf_tgui_size_t *size_ptr, vsf_tgui_v_color_t rect_color)
 
void vsf_tgui_sv_port_draw_root_tile (vsf_tgui_t *gui_ptr, vsf_tgui_location_t *location_ptr, vsf_tgui_location_t *tile_location_ptr, vsf_tgui_size_t *size_ptr, const vsf_tgui_tile_t *tile_ptr, uint_fast8_t trans_rate, vsf_tgui_v_color_t color, vsf_tgui_v_color_t bg_color)
 
void vsf_tgui_sv_port_draw_char (vsf_tgui_t *gui_ptr, vsf_tgui_location_t *location_ptr, vsf_tgui_location_t *font_location_ptr, vsf_tgui_size_t *size_ptr, uint8_t font_index, uint32_t char_u32, vsf_tgui_v_color_t char_color)
 
vsf_tgui_region_tvsf_tgui_v_refresh_loop_begin (vsf_tgui_t *gui_ptr, const vsf_tgui_region_t *planned_refresh_region_ptr)
 begin a refresh loop !
 
bool vsf_tgui_v_refresh_loop_end (vsf_tgui_t *gui_ptr)
 
uint32_t vsf_tgui_port_get_refresh_rate (vsf_tgui_t *gui_ptr)
 
void vsf_tgui_v_bind_disp (vsf_tgui_t *gui_ptr, vk_disp_t *disp, void *pfb, size_t pfb_size)
 

Macro Definition Documentation

◆ __VSF_DISP_CLASS_INHERIT__

#define __VSF_DISP_CLASS_INHERIT__

◆ __VSF_TGUI_CLASS_INHERIT

#define __VSF_TGUI_CLASS_INHERIT

◆ VSF_TGUI_CFG_SV_PORT_SET_INIT_BG_COLOR

#define VSF_TGUI_CFG_SV_PORT_SET_INIT_BG_COLOR   ENABLED

◆ VSF_TGUI_CFG_SV_PORT_LOG

#define VSF_TGUI_CFG_SV_PORT_LOG   DISABLED

◆ vsf_tgui_disp_color_prefix

#define vsf_tgui_disp_color_prefix   rgb565

◆ __disp_color_to_tgui_color

#define __disp_color_to_tgui_color (   __disp_color)    ((vsf_tgui_v_color_t){ .value = __disp_color})

◆ __tgui_color_to_disp_color

#define __tgui_color_to_disp_color (   __tgui_color)    (__tgui_color.value)

Typedef Documentation

◆ vsf_tgui_disp_pixel_t

◆ vsf_tgui_disp_tgui_pixel_t

◆ vsf_tgui_sv_port_info_t

Function Documentation

◆ vsf_tgui_tile_get_pixelmap()

unsigned char * vsf_tgui_tile_get_pixelmap ( const vsf_tgui_tile_t tile_ptr)

◆ vsf_tgui_sv_port_draw_rect()

void vsf_tgui_sv_port_draw_rect ( vsf_tgui_t *  gui_ptr,
vsf_tgui_location_t location_ptr,
vsf_tgui_size_t size_ptr,
vsf_tgui_v_color_t  rect_color 
)

◆ vsf_tgui_sv_port_draw_root_tile()

void vsf_tgui_sv_port_draw_root_tile ( vsf_tgui_t *  gui_ptr,
vsf_tgui_location_t location_ptr,
vsf_tgui_location_t tile_location_ptr,
vsf_tgui_size_t size_ptr,
const vsf_tgui_tile_t tile_ptr,
uint_fast8_t  trans_rate,
vsf_tgui_v_color_t  color,
vsf_tgui_v_color_t  bg_color 
)

◆ vsf_tgui_sv_port_draw_char()

void vsf_tgui_sv_port_draw_char ( vsf_tgui_t *  gui_ptr,
vsf_tgui_location_t location_ptr,
vsf_tgui_location_t font_location_ptr,
vsf_tgui_size_t size_ptr,
uint8_t  font_index,
uint32_t  char_u32,
vsf_tgui_v_color_t  char_color 
)

◆ vsf_tgui_v_refresh_loop_begin()

vsf_tgui_region_t * vsf_tgui_v_refresh_loop_begin ( vsf_tgui_t *  gui_ptr,
const vsf_tgui_region_t planned_refresh_region_ptr 
)

begin a refresh loop !

Parameters
gui_ptrthe tgui object address !
planned_refresh_region_ptrthe planned refresh region !
Return values
NULLNo need to refresh (or rendering service is not ready) !
!NULLThe actual refresh region ! !
Note
When NULL is returned, current refresh iteration (i.e. a refresh activities ! between vsf_tgui_v_refresh_loop_begin and vsf_tgui_v_refresh_loop_end ) ! will be ignored and vsf_tgui_v_refresh_loop_end is called immediately

◆ vsf_tgui_v_refresh_loop_end()

bool vsf_tgui_v_refresh_loop_end ( vsf_tgui_t *  gui_ptr)

◆ vsf_tgui_port_get_refresh_rate()

uint32_t vsf_tgui_port_get_refresh_rate ( vsf_tgui_t *  gui_ptr)

◆ vsf_tgui_v_bind_disp()

void vsf_tgui_v_bind_disp ( vsf_tgui_t *  gui_ptr,
vk_disp_t disp,
void *  pfb,
size_t  pfb_size 
)