lv_svg_render.h

API reference for lv_svg_render.h

Summary

Functions

private/image/svg/lv_svg_render.h:94function

lv_svg_render_get_size

Get size of render objects.

uint32_t lv_svg_render_get_size(const lv_svg_render_obj_t *render)

Name	Type	Description
`render`	`const lv_svg_render_obj_t *`	pointer to the SVG render object

Returns: uint32_t — the bytes of SVG render objects

private/image/svg/lv_svg_render.h:103function

lv_svg_render_get_viewport_size

Get viewport's width and height of the render object.

lv_result_t lv_svg_render_get_viewport_size(const lv_svg_render_obj_t *render, float *width, float *height)

Name	Type	Description
`render`	`const lv_svg_render_obj_t *`	pointer to the SVG render object
`width`	`float *`	pointer to save the width of the viewport of the SVG render object
`height`	`float *`	pointer to save the height of the viewport of the SVG render object

Returns: lv_result_t — lv_result_t, LV_RESULT_OK if success, LV_RESULT_INVALID if fail

private/image/svg/lv_svg_render.h:74function

lv_svg_render_init

Initialize the SVG render.

void lv_svg_render_init(const lv_svg_render_hal_t *hal)

Name	Type	Description
`hal`	`const lv_svg_render_hal_t *`	pointer to a structure with rendering functions

private/image/svg/lv_svg_render.h:81function

lv_svg_render_create

Create a new SVG render from an SVG document.

lv_svg_render_obj_t * lv_svg_render_create(const lv_svg_node_t *svg_doc)

Name	Type	Description
`svg_doc`	`const lv_svg_node_t *`	pointer to the SVG document

Returns: lv_svg_render_obj_t * — pointer to the new SVG render object

private/image/svg/lv_svg_render.h:87function

lv_svg_render_delete

Delete an SVG render object.

void lv_svg_render_delete(lv_svg_render_obj_t *render)

Name	Type	Description
`render`	`lv_svg_render_obj_t *`	pointer to the SVG render object to delete

private/image/svg/lv_svg_render.h:110function

lv_draw_svg_render

Render an SVG object to a vector graphics.

void lv_draw_svg_render(lv_draw_vector_dsc_t *dsc, const lv_svg_render_obj_t *render)

Name	Type	Description
`dsc`	`lv_draw_vector_dsc_t *`	pointer to the vector graphics descriptor
`render`	`const lv_svg_render_obj_t *`	pointer to the SVG render object to render

Structs

struct

_lv_svg_render_obj

Member	Type	Description
`next`	`struct _lv_svg_render_obj *`
`tag`	`lv_svg_tag_t`
`flags`	`uint32_t`
`id`	`char *`
`dsc`	`lv_vector_path_ctx_t`
`matrix`	`lv_matrix_t`
`head`	`struct _lv_svg_render_obj *`
`fill_ref`	`char *`
`stroke_ref`	`char *`
`clz`	`struct _lv_svg_render_class *`

struct

_lv_svg_render_class

Member	Type	Description
`set_paint_ref`	`void()(lv_svg_render_obj_t obj, lv_vector_path_ctx_t dsc, const lv_svg_render_obj_t target_obj, bool fill)`
`init`	`void()(lv_svg_render_obj_t obj, const lv_svg_node_t *node)`
`render`	`void()(const lv_svg_render_obj_t obj, lv_draw_vector_dsc_t dsc, const lv_matrix_t matrix)`
`set_attr`	`void()(lv_svg_render_obj_t obj, lv_vector_path_ctx_t dsc, const lv_svg_attr_t attr)`
`get_bounds`	`void()(const lv_svg_render_obj_t obj, lv_area_t *area)`
`get_size`	`void()(const lv_svg_render_obj_t obj, uint32_t *size)`
`destroy`	`void()(lv_svg_render_obj_t obj)`

struct

lv_svg_render_hal_t

Member	Type	Description
`load_image`	`void()(const char image_url, lv_draw_image_dsc_t *img_dsc)`
`get_font_path`	`const char ()(const char *font_family)`

Used by 1 function

lv_svg_render_init — param hal

Typedefs

private/image/svg/lv_svg_render.h:46typedef

lv_svg_render_obj_t

typedef struct _lv_svg_render_obj lv_svg_render_obj_t

Used by 4 functions

lv_svg_render_delete — param render
lv_svg_render_get_size — param render
lv_svg_render_get_viewport_size — param render
lv_draw_svg_render — param render

private/image/svg/lv_svg_render.h:58typedef

lv_svg_render_class

typedef struct _lv_svg_render_class lv_svg_render_class

Macros

private/image/svg/lv_svg_render.h:26macro

LV_SVG_RENDER_OBJ

#define LV_SVG_RENDER_OBJ(n) \
    ((lv_svg_render_obj_t*)(n))

Dependencies

lvgl_private.h

Indirect dependencies

lv_svg_render.h

On this page