vsf_disp.c File Reference

#include "component/ui/vsf_ui_cfg.h"
#include "./vsf_disp.h"

Data Structures
struct	vk_disp_cvrt_ctx_t

Macros
#define	__VSF_DISP_CLASS_IMPLEMENT
#define	__VSF_EDA_CLASS_INHERIT__
#define	__VK_DISP_CVRT_IMPLEMENT(__COLOR_SRC, __COLOR_DST)
#define	__VK_DISP_CVRT_DECLARE(__COLOR_SRC, __COLOR_DST)    __VK_DISP_CVRT_IMPLEMENT(__COLOR_SRC, __COLOR_DST)
#define	__VK_DISP_CVRT_DEFINE(__COLOR_SRC, __COLOR_DST)

Typedefs
typedef void(*	vk_disp_fn_cvrt_t) (uint16_t width, uint16_t height, void *pixels_src, uint32_t pitch_src, void *pixels_dst, uint32_t pitch_dst)
typedef struct vk_disp_cvrt_ctx_t	vk_disp_cvrt_ctx_t

Enumerations
enum	{ VSF_EVT_REFRESH = VSF_EVT_USER }

Functions
	__VK_DISP_CVRT_DECLARE (ARGB8888, RGB565)
void	vk_disp_on_ready (vk_disp_t *pthis)
vsf_err_t	vk_disp_init (vk_disp_t *pthis)
	Initialize a display instance (asynchronous)
void	vk_disp_fini (vk_disp_t *pthis)
	Deinitialize a display instance (asynchronous)
vsf_err_t	vk_disp_refresh (vk_disp_t *pthis, vk_disp_area_t *area, void *disp_buff)
	Refresh a display area (asynchronous)
	__VK_DISP_CVRT_IMPLEMENT (ARGB8888, RGB565)

Variables
const vk_disp_drv_t	vk_disp_reentrant_drv
const vk_disp_drv_t	vk_disp_dummy_drv
const vk_disp_drv_t	vk_disp_cvrt_drv

Macro Definition Documentation

__VSF_DISP_CLASS_IMPLEMENT

#define __VSF_DISP_CLASS_IMPLEMENT

__VSF_EDA_CLASS_INHERIT__

#define __VSF_EDA_CLASS_INHERIT__

__VK_DISP_CVRT_IMPLEMENT

#define __VK_DISP_CVRT_IMPLEMENT	(		__COLOR_SRC,
			__COLOR_DST
	)

Value:

    static void VSF_MCONNECT(vk_disp_color_cvrt_, __COLOR_SRC, _to_, __COLOR_DST)\
        (uint16_t width, uint16_t height, void *pixels_src, uint32_t pitch_src, void *pixels_dst, uint32_t pitch_dst)

__VK_DISP_CVRT_DECLARE

#define __VK_DISP_CVRT_DECLARE	(		__COLOR_SRC,
			__COLOR_DST
	)		__VK_DISP_CVRT_IMPLEMENT(__COLOR_SRC, __COLOR_DST)

__VK_DISP_CVRT_DEFINE

#define __VK_DISP_CVRT_DEFINE	(		__COLOR_SRC,
			__COLOR_DST
	)

Value:

    {                                                                           \
        .color_src  = VSF_MCONNECT(VSF_DISP_COLOR_, __COLOR_SRC),               \
        .color_dst  = VSF_MCONNECT(VSF_DISP_COLOR_, __COLOR_DST),               \
        .fn_cvrt    = VSF_MCONNECT(vk_disp_color_cvrt_, __COLOR_SRC, _to_, __COLOR_DST),\
    }

Typedef Documentation

vk_disp_fn_cvrt_t

typedef void(* vk_disp_fn_cvrt_t) (uint16_t width, uint16_t height, void *pixels_src, uint32_t pitch_src, void *pixels_dst, uint32_t pitch_dst)

vk_disp_cvrt_ctx_t

typedef struct vk_disp_cvrt_ctx_t vk_disp_cvrt_ctx_t

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
VSF_EVT_REFRESH

Function Documentation

__VK_DISP_CVRT_DECLARE()

__VK_DISP_CVRT_DECLARE	(	ARGB8888	,
		RGB565
	)

vk_disp_on_ready()

void vk_disp_on_ready

(

vk_disp_t *

pthis

)

vk_disp_init()

vsf_err_t vk_disp_init

(

vk_disp_t *

pthis

)

Initialize a display instance (asynchronous)

Parameters

[in]

pthis

a pointer to structure vk_disp_t

Returns

vsf_err_t: VSF_ERR_NONE if initialization started successfully, otherwise returns error code

Note

Completion is signaled via the ui_on_ready callback.

vk_disp_fini()

void vk_disp_fini

(

vk_disp_t *

pthis

)

Deinitialize a display instance (asynchronous)

Parameters

[in]

pthis

a pointer to structure vk_disp_t

Note

Completion is signaled via the ui_on_ready callback.

vk_disp_refresh()

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

Refresh a display area (asynchronous)

Parameters

[in]	pthis	a pointer to structure vk_disp_t
[in]	area	a pointer to structure vk_disp_area_t specifying the region to refresh
[in]	disp_buff	pointer to the pixel data for the area. Pixels must be tightly packed per row: row stride equals area->size.x * bytes_per_pixel. The buffer only needs to cover the area, NOT the full screen — rows are contiguous without any padding to the display width.

Returns

vsf_err_t: VSF_ERR_NONE if refresh started successfully, otherwise returns error code

Precondition

vk_disp_init must have been called and its asynchronous completion signaled via ui_on_ready before calling this function.

__VK_DISP_CVRT_IMPLEMENT()

__VK_DISP_CVRT_IMPLEMENT	(	ARGB8888	,
		RGB565
	)

Variable Documentation

vk_disp_reentrant_drv

const vk_disp_drv_t vk_disp_reentrant_drv

Initial value:

= {
    .init           = __vk_disp_reentrant_init,
    .refresh        = __vk_disp_reentrant_refresh,
}

vk_disp_dummy_drv

const vk_disp_drv_t vk_disp_dummy_drv

Initial value:

= {
    .refresh        = __vk_disp_dummy_refresh,
}

vk_disp_cvrt_drv

const vk_disp_drv_t vk_disp_cvrt_drv

Initial value:

= {
    .refresh        = __vk_disp_cvrt_refresh,
}