lv_x11.h

API reference for lv_x11.h

Summary

Functions

drivers/x11/lv_x11.h:52function

lv_x11_inputs_create

create and add keyboard, mouse and scrollwheel objects and connect them to x11 display.

This is a convenience method handling the typical input initialisation of an X11 window:

create keyboard (lv_x11_keyboard_create)
create mouse (with scrollwheel, lv_x11_mouse_create lv_x11_mousewheel_create)

void lv_x11_inputs_create(lv_display_t *disp, lv_image_dsc_t const *mouse_img)

Name	Type	Description
[in] `disp`	`lv_display_t *`	the created X11 display object from `lv_x11_window_create`
[in] `mouse_img`	`lv_image_dsc_t const *`	optional image description for the mouse cursor (NULL for no/invisible mouse cursor)

drivers/x11/lv_x11.h:74function

lv_x11_window_create

create the X11 display

The minimal initialisation for initializing the X11 display driver with keyboard/mouse support:

lv_display_t* disp = lv_x11_window_create("My Window Title", window_width, window_width);
lv_x11_inputs_create(disp, NULL);

or with mouse cursor icon:

lv_image_dsc_t mouse_symbol = {.....};
lv_display_t* disp = lv_x11_window_create("My Window Title", window_width, window_width);
lv_x11_inputs_create(disp, &mouse_symbol);

lv_display_t * lv_x11_window_create(char const *title, int32_t hor_res, int32_t ver_res)

Name	Type	Description
[in] `title`	`char const *`	title of the created X11 window
[in] `hor_res`	`int32_t`	horizontal resolution (=width) of the X11 window
[in] `ver_res`	`int32_t`	vertical resolution (=height) of the X11 window

Returns: lv_display_t * — pointer to the display object

Structs

struct

_x11_user_hdr_t

Header of private display driver user data - for internal use only

Member	Type	Description
`display`	`struct _XDisplay *`	X11 display object <br/>
`inp_data`	`struct _x11_inp_data *`	input user data object

Typedefs

drivers/x11/lv_x11.h:36typedef

lv_x11_close_cb

typedef void(* lv_x11_close_cb) (void *user_data)

optional window close callback function type