VSF Documented
Data Structures | Macros | Typedefs | Enumerations | Functions | Variables
vsf_disp.h File Reference
#include "component/ui/vsf_ui_cfg.h"
#include "utilities/vsf_utilities.h"
#include "kernel/vsf_kernel.h"
#include "utilities/ooc_class.h"
#include "./driver/sdl2/vsf_disp_sdl2.h"
#include "./driver/usbd_uvc/vsf_disp_usbd_uvc.h"
#include "./driver/sitronix/st7789/vsf_disp_st7789.h"
#include "./driver/sitronix/st7735/vsf_disp_st7735.h"
#include "./driver/solomon-systech/ssd1306/vsf_disp_ssd1306.h"
#include "./driver/vga/m480/vsf_disp_vga_m480.h"
#include "./driver/fb/vsf_disp_fb.h"
#include "./driver/mipi_lcd/vsf_disp_mipi_spi_lcd.h"
#include "./driver/did/vsf_disp_did.h"

Go to the source code of this file.

Data Structures

struct  vk_disp_point_t
 
struct  vk_disp_area_t
 
class  vk_disp_drv_t
 
struct  vk_disp_param_t
 
class  vk_disp_t
 
class  vk_reentrant_disp_t
 

Macros

#define VSF_DISP_COLOR_IDX_DEF(__NAME)    VSF_DISP_COLOR_IDX_##__NAME
 
#define VSF_DISP_COLOR_VALUE(__INDEX, __BITLEN, __BYTELEN, __HAS_ALPHA)
 
#define VSF_DISP_COLOR_DEF(__NAME, __BITLEN, __BYTELEN, __HAS_ALPHA)
 
#define vsf_disp_get_pixel_format_bytesize(__color_format)    ((((__color_format) >> 13) & 0x03) + 1)
 
#define vsf_disp_get_pixel_format_bitsize(__color_format)    ((((__color_format) >> 8) & 0x1F) + 1)
 
#define vsf_disp_get_pixel_format_has_alpha(__color_format)    ((__color_format) & (1 << 15))
 
#define vsf_disp_get_pixel_format(__disp)    ((vk_disp_t *)(__disp))->param.color
 
#define vsf_disp_get_width(__disp)   ((__disp)->param.width)
 
#define vsf_disp_get_height(__disp)   ((__disp)->param.height)
 
#define vsf_disp_get_pixel_bitsize(__disp)    vsf_disp_get_pixel_format_bitsize(vsf_disp_get_pixel_format(__disp))
 
#define vsf_disp_get_pixel_bytesize(__disp)    vsf_disp_get_pixel_format_bytesize(vsf_disp_get_pixel_format(__disp))
 
#define vsf_disp_get_has_alpha(__disp)    vsf_disp_get_pixel_format_has_alpha(vsf_disp_get_pixel_format(__disp))
 
#define vsf_disp_get_pitch(__disp)    ((__disp)->param.width * vsf_disp_get_pixel_bytesize(__disp))
 
#define vsf_disp_get_frame_size(__disp)    ((__disp)->param.height * vsf_disp_get_pitch(__disp))
 
#define vk_disp_coord_t   int16_t
 
#define vk_disp_fast_coord_t   uint_fast16_t
 

Typedefs

typedef enum vk_disp_color_idx_t vk_disp_color_idx_t
 
typedef enum vk_disp_color_type_t vk_disp_color_type_t
 
typedef struct vk_disp_point_t vk_disp_point_t
 
typedef struct vk_disp_area_t vk_disp_area_t
 
typedef struct vk_disp_param_t vk_disp_param_t
 
typedef void(* vk_disp_on_ready_t) (vk_disp_t *disp)
 

Enumerations

enum  vk_disp_color_idx_t {
  VSF_DISP_COLOR_IDX_DEF =(INVALID) ,
  VSF_DISP_COLOR_IDX_DEF =(INVALID) ,
  VSF_DISP_COLOR_IDX_DEF =(INVALID) ,
  VSF_DISP_COLOR_IDX_DEF =(INVALID) ,
  VSF_DISP_COLOR_IDX_DEF =(INVALID) ,
  VSF_DISP_COLOR_IDX_DEF =(INVALID) ,
  VSF_DISP_COLOR_IDX_DEF =(INVALID) ,
  VSF_DISP_COLOR_IDX_DEF =(INVALID) ,
  VSF_DISP_COLOR_IDX_DEF =(INVALID) ,
  VSF_DISP_COLOR_IDX_DEF =(INVALID) ,
  VSF_DISP_COLOR_IDX_DEF =(INVALID) ,
  VSF_DISP_COLOR_IDX_DEF =(INVALID) ,
  VSF_DISP_COLOR_IDX_DEF =(INVALID)
}
 
enum  vk_disp_color_type_t {
  __VSF_DISP_COLOR_LEAST_MAX = INT16_MAX ,
  __VSF_DISP_COLOR_LEAST_MIN = INT16_MIN ,
  VSF_DISP_COLOR_DEF =(INVALID, 0, 0, 0) ,
  VSF_DISP_COLOR_DEF =(INVALID, 0, 0, 0) ,
  VSF_DISP_COLOR_DEF =(INVALID, 0, 0, 0) ,
  VSF_DISP_COLOR_DEF =(INVALID, 0, 0, 0) ,
  VSF_DISP_COLOR_DEF =(INVALID, 0, 0, 0) ,
  VSF_DISP_COLOR_DEF =(INVALID, 0, 0, 0) ,
  VSF_DISP_COLOR_DEF =(INVALID, 0, 0, 0) ,
  VSF_DISP_COLOR_DEF =(INVALID, 0, 0, 0) ,
  VSF_DISP_COLOR_DEF =(INVALID, 0, 0, 0) ,
  VSF_DISP_COLOR_DEF =(INVALID, 0, 0, 0) ,
  VSF_DISP_COLOR_DEF =(INVALID, 0, 0, 0) ,
  VSF_DISP_COLOR_DEF =(INVALID, 0, 0, 0) ,
  VSF_DISP_COLOR_DEF =(INVALID, 0, 0, 0)
}
 

Functions

vsf_err_t vk_disp_init (vk_disp_t *pthis)
 
vsf_err_t vk_disp_refresh (vk_disp_t *pthis, vk_disp_area_t *area, void *disp_buff)
 

Variables

const vk_disp_drv_t vk_reentrant_disp_drv
 

Macro Definition Documentation

◆ VSF_DISP_COLOR_IDX_DEF

#define VSF_DISP_COLOR_IDX_DEF (   __NAME)     VSF_DISP_COLOR_IDX_##__NAME

◆ VSF_DISP_COLOR_VALUE

#define VSF_DISP_COLOR_VALUE (   __INDEX,
  __BITLEN,
  __BYTELEN,
  __HAS_ALPHA 
)
Value:
( (__INDEX) \
| ((((__BITLEN) - 1) & 0x1F) << 8) \
| ((((__BYTELEN) - 1) & 0x03) << 13) \
| ((__HAS_ALPHA) ? 1 << 15 : 0) \
)

◆ VSF_DISP_COLOR_DEF

#define VSF_DISP_COLOR_DEF (   __NAME,
  __BITLEN,
  __BYTELEN,
  __HAS_ALPHA 
)
Value:
VSF_DISP_COLOR_##__NAME = VSF_DISP_COLOR_VALUE( \
(VSF_DISP_COLOR_IDX_##__NAME), __BITLEN, __BYTELEN, __HAS_ALPHA)
VSF_DISP_COLOR_VALUE
#define VSF_DISP_COLOR_VALUE(__INDEX, __BITLEN, __BYTELEN, __HAS_ALPHA)
Definition vsf_disp.h:50

◆ vsf_disp_get_pixel_format_bytesize

#define vsf_disp_get_pixel_format_bytesize (   __color_format)     ((((__color_format) >> 13) & 0x03) + 1)

◆ vsf_disp_get_pixel_format_bitsize

#define vsf_disp_get_pixel_format_bitsize (   __color_format)     ((((__color_format) >> 8) & 0x1F) + 1)

◆ vsf_disp_get_pixel_format_has_alpha

#define vsf_disp_get_pixel_format_has_alpha (   __color_format)     ((__color_format) & (1 << 15))

◆ vsf_disp_get_pixel_format

#define vsf_disp_get_pixel_format (   __disp)     ((vk_disp_t *)(__disp))->param.color

◆ vsf_disp_get_width

#define vsf_disp_get_width (   __disp)    ((__disp)->param.width)

◆ vsf_disp_get_height

#define vsf_disp_get_height (   __disp)    ((__disp)->param.height)

◆ vsf_disp_get_pixel_bitsize

#define vsf_disp_get_pixel_bitsize (   __disp)     vsf_disp_get_pixel_format_bitsize(vsf_disp_get_pixel_format(__disp))

◆ vsf_disp_get_pixel_bytesize

#define vsf_disp_get_pixel_bytesize (   __disp)     vsf_disp_get_pixel_format_bytesize(vsf_disp_get_pixel_format(__disp))

◆ vsf_disp_get_has_alpha

#define vsf_disp_get_has_alpha (   __disp)     vsf_disp_get_pixel_format_has_alpha(vsf_disp_get_pixel_format(__disp))

◆ vsf_disp_get_pitch

#define vsf_disp_get_pitch (   __disp)     ((__disp)->param.width * vsf_disp_get_pixel_bytesize(__disp))

◆ vsf_disp_get_frame_size

#define vsf_disp_get_frame_size (   __disp)     ((__disp)->param.height * vsf_disp_get_pitch(__disp))

◆ vk_disp_coord_t

#define vk_disp_coord_t   int16_t

◆ vk_disp_fast_coord_t

#define vk_disp_fast_coord_t   uint_fast16_t

Typedef Documentation

◆ vk_disp_color_idx_t

typedef enum vk_disp_color_idx_t vk_disp_color_idx_t

◆ vk_disp_color_type_t

typedef enum vk_disp_color_type_t vk_disp_color_type_t

◆ vk_disp_point_t

typedef struct vk_disp_point_t vk_disp_point_t

◆ vk_disp_area_t

typedef struct vk_disp_area_t vk_disp_area_t

◆ vk_disp_param_t

typedef struct vk_disp_param_t vk_disp_param_t

◆ vk_disp_on_ready_t

typedef void(* vk_disp_on_ready_t) (vk_disp_t *disp)

Enumeration Type Documentation

◆ vk_disp_color_idx_t

enum vk_disp_color_idx_t
Enumerator
VSF_DISP_COLOR_IDX_DEF 
VSF_DISP_COLOR_IDX_DEF 
VSF_DISP_COLOR_IDX_DEF 
VSF_DISP_COLOR_IDX_DEF 
VSF_DISP_COLOR_IDX_DEF 
VSF_DISP_COLOR_IDX_DEF 
VSF_DISP_COLOR_IDX_DEF 
VSF_DISP_COLOR_IDX_DEF 
VSF_DISP_COLOR_IDX_DEF 
VSF_DISP_COLOR_IDX_DEF 
VSF_DISP_COLOR_IDX_DEF 
VSF_DISP_COLOR_IDX_DEF 
VSF_DISP_COLOR_IDX_DEF 

◆ vk_disp_color_type_t

enum vk_disp_color_type_t
Enumerator
__VSF_DISP_COLOR_LEAST_MAX 
__VSF_DISP_COLOR_LEAST_MIN 
VSF_DISP_COLOR_DEF 
VSF_DISP_COLOR_DEF 
VSF_DISP_COLOR_DEF 
VSF_DISP_COLOR_DEF 
VSF_DISP_COLOR_DEF 
VSF_DISP_COLOR_DEF 
VSF_DISP_COLOR_DEF 
VSF_DISP_COLOR_DEF 
VSF_DISP_COLOR_DEF 
VSF_DISP_COLOR_DEF 
VSF_DISP_COLOR_DEF 
VSF_DISP_COLOR_DEF 
VSF_DISP_COLOR_DEF 

Function Documentation

◆ vk_disp_init()

vsf_err_t vk_disp_init ( vk_disp_t *  pthis)
extern

◆ vk_disp_refresh()

vsf_err_t vk_disp_refresh ( vk_disp_t *  pthis,
vk_disp_area_t *  area,
void *  disp_buff 
)
extern

Variable Documentation

◆ vk_reentrant_disp_drv

const vk_disp_drv_t vk_reentrant_disp_drv
extern
Generated by doxygen 1.9.8