lv_arc.h

API reference for lv_arc.h

Summary

Functions

public/widgets/lv_arc.h:84function

lv_arc_set_start_angle

Set the start angle of an arc. 0 deg: right, 90 bottom, etc.

void lv_arc_set_start_angle(lv_obj_t *obj, lv_value_precise_t start)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to an arc object
`start`	`lv_value_precise_t`	the start angle. (if `LV_USE_FLOAT` is enabled it can be fractional too.)

public/widgets/lv_arc.h:91function

lv_arc_set_end_angle

Set the end angle of an arc. 0 deg: right, 90 bottom, etc.

void lv_arc_set_end_angle(lv_obj_t *obj, lv_value_precise_t end)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to an arc object
`end`	`lv_value_precise_t`	the end angle (if `LV_USE_FLOAT` is enabled it can be fractional too.)

public/widgets/lv_arc.h:99function

lv_arc_set_angles

Set the start and end angles

void lv_arc_set_angles(lv_obj_t *obj, lv_value_precise_t start, lv_value_precise_t end)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to an arc object
`start`	`lv_value_precise_t`	the start angle (if `LV_USE_FLOAT` is enabled it can be fractional too.)
`end`	`lv_value_precise_t`	the end angle (if `LV_USE_FLOAT` is enabled it can be fractional too.)

public/widgets/lv_arc.h:106function

lv_arc_set_bg_start_angle

Set the start angle of an arc background. 0 deg: right, 90 bottom, etc.

void lv_arc_set_bg_start_angle(lv_obj_t *obj, lv_value_precise_t start)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to an arc object
`start`	`lv_value_precise_t`	the start angle (if `LV_USE_FLOAT` is enabled it can be fractional too.)

public/widgets/lv_arc.h:113function

lv_arc_set_bg_end_angle

Set the start angle of an arc background. 0 deg: right, 90 bottom etc.

void lv_arc_set_bg_end_angle(lv_obj_t *obj, lv_value_precise_t end)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to an arc object
`end`	`lv_value_precise_t`	the end angle (if `LV_USE_FLOAT` is enabled it can be fractional too.)

public/widgets/lv_arc.h:121function

lv_arc_set_bg_angles

Set the start and end angles of the arc background

void lv_arc_set_bg_angles(lv_obj_t *obj, lv_value_precise_t start, lv_value_precise_t end)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to an arc object
`start`	`lv_value_precise_t`	the start angle (if `LV_USE_FLOAT` is enabled it can be fractional too.)
`end`	`lv_value_precise_t`	the end angle (if `LV_USE_FLOAT` is enabled it can be fractional too.)

public/widgets/lv_arc.h:128function

lv_arc_set_rotation

Set the rotation for the whole arc

void lv_arc_set_rotation(lv_obj_t *obj, int32_t rotation)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to an arc object
`rotation`	`int32_t`	rotation angle

public/widgets/lv_arc.h:135function

lv_arc_set_mode

Set in which direction the indicator should grow.

void lv_arc_set_mode(lv_obj_t *obj, lv_arc_mode_t type)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to arc object
`type`	`lv_arc_mode_t`	arc's mode

public/widgets/lv_arc.h:142function

lv_arc_set_value

Set a new value on the arc

void lv_arc_set_value(lv_obj_t *obj, int32_t value)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to an arc object
`value`	`int32_t`	new value

public/widgets/lv_arc.h:150function

lv_arc_set_range

Set minimum and the maximum values of an arc

void lv_arc_set_range(lv_obj_t *obj, int32_t min, int32_t max)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to the arc object
`min`	`int32_t`	minimum value
`max`	`int32_t`	maximum value

public/widgets/lv_arc.h:157function

lv_arc_set_min_value

Set the minimum values of an arc

void lv_arc_set_min_value(lv_obj_t *obj, int32_t min)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to the arc object
`min`	`int32_t`	minimum value

public/widgets/lv_arc.h:164function

lv_arc_set_max_value

Set the maximum values of an arc

void lv_arc_set_max_value(lv_obj_t *obj, int32_t max)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to the arc object
`max`	`int32_t`	maximum value

public/widgets/lv_arc.h:171function

lv_arc_set_change_rate

Set a change rate to limit the speed how fast the arc should reach the pressed point.

void lv_arc_set_change_rate(lv_obj_t *obj, uint32_t rate)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to an arc object
`rate`	`uint32_t`	the change rate

public/widgets/lv_arc.h:178function

lv_arc_set_knob_offset

Set an offset angle for the knob

void lv_arc_set_knob_offset(lv_obj_t *obj, int32_t offset)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to an arc object
`offset`	`int32_t`	knob offset from main arc in degrees

public/widgets/lv_arc.h:189function

lv_arc_get_angle_start

Get the start angle of an arc.

lv_value_precise_t lv_arc_get_angle_start(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to an arc object

Returns: lv_value_precise_t — the start angle [0..360] (if LV_USE_FLOAT is enabled it can be fractional too.)

public/widgets/lv_arc.h:196function

lv_arc_get_angle_end

Get the end angle of an arc.

lv_value_precise_t lv_arc_get_angle_end(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to an arc object

Returns: lv_value_precise_t — the end angle [0..360] (if LV_USE_FLOAT is enabled it can be fractional too.)

public/widgets/lv_arc.h:203function

lv_arc_get_bg_angle_start

Get the start angle of an arc background.

lv_value_precise_t lv_arc_get_bg_angle_start(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to an arc object

Returns: lv_value_precise_t — the start angle [0..360] (if LV_USE_FLOAT is enabled it can be fractional too.)

public/widgets/lv_arc.h:210function

lv_arc_get_bg_angle_end

Get the end angle of an arc background.

lv_value_precise_t lv_arc_get_bg_angle_end(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to an arc object

Returns: lv_value_precise_t — the end angle [0..360] (if LV_USE_FLOAT is enabled it can be fractional too.)

public/widgets/lv_arc.h:217function

lv_arc_get_value

Get the value of an arc

int32_t lv_arc_get_value(const lv_obj_t *obj)

Name	Type	Description
`obj`	`const lv_obj_t *`	pointer to an arc object

Returns: int32_t — the value of the arc

public/widgets/lv_arc.h:224function

lv_arc_get_min_value

Get the minimum value of an arc

int32_t lv_arc_get_min_value(const lv_obj_t *obj)

Name	Type	Description
`obj`	`const lv_obj_t *`	pointer to an arc object

Returns: int32_t — the minimum value of the arc

public/widgets/lv_arc.h:231function

lv_arc_get_max_value

Get the maximum value of an arc

int32_t lv_arc_get_max_value(const lv_obj_t *obj)

Name	Type	Description
`obj`	`const lv_obj_t *`	pointer to an arc object

Returns: int32_t — the maximum value of the arc

public/widgets/lv_arc.h:238function

lv_arc_get_mode

Get whether the arc is type or not.

lv_arc_mode_t lv_arc_get_mode(const lv_obj_t *obj)

Name	Type	Description
`obj`	`const lv_obj_t *`	pointer to an arc object

Returns: lv_arc_mode_t — arc's mode

public/widgets/lv_arc.h:245function

lv_arc_get_rotation

Get the rotation for the whole arc

int32_t lv_arc_get_rotation(const lv_obj_t *obj)

Name	Type	Description
`obj`	`const lv_obj_t *`	pointer to an arc object

Returns: int32_t — arc's current rotation

public/widgets/lv_arc.h:252function

lv_arc_get_knob_offset

Get the current knob angle offset

int32_t lv_arc_get_knob_offset(const lv_obj_t *obj)

Name	Type	Description
`obj`	`const lv_obj_t *`	pointer to an arc object

Returns: int32_t — arc's current knob offset

public/widgets/lv_arc.h:259function

lv_arc_get_change_rate

Get the change rate of an arc

uint32_t lv_arc_get_change_rate(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to an arc object

Returns: uint32_t — the change rate

public/widgets/lv_arc.h:69function

lv_arc_create

Create an arc object

lv_obj_t * lv_arc_create(lv_obj_t *parent)

Name	Type	Description
`parent`	`lv_obj_t *`	pointer to a parent widget May be `NULL`.. When NULL, the widget is created as a screen on the default display.

Returns: lv_obj_t * — pointer to the created arc

public/widgets/lv_arc.h:272function

lv_arc_bind_value

Bind an integer subject to an Arc's value.

lv_observer_t * lv_arc_bind_value(lv_obj_t *obj, lv_subject_t *subject)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to Arc
`subject`	`lv_subject_t *`	pointer to Subject

Returns: lv_observer_t * — pointer to newly-created Observer

public/widgets/lv_arc.h:282function

lv_arc_align_obj_to_angle

Align an object to the current position of the arc (knob)

void lv_arc_align_obj_to_angle(const lv_obj_t *obj, lv_obj_t *obj_to_align, int32_t r_offset)

Name	Type	Description
`obj`	`const lv_obj_t *`	pointer to an arc object
`obj_to_align`	`lv_obj_t *`	pointer to an object to align
`r_offset`	`int32_t`	consider the radius larger with this value (< 0: for smaller radius)

public/widgets/lv_arc.h:290function

lv_arc_rotate_obj_to_angle

Rotate an object to the current position of the arc (knob)

void lv_arc_rotate_obj_to_angle(const lv_obj_t *obj, lv_obj_t *obj_to_rotate, int32_t r_offset)

Name	Type	Description
`obj`	`const lv_obj_t *`	pointer to an arc object
`obj_to_rotate`	`lv_obj_t *`	pointer to an object to rotate
`r_offset`	`int32_t`	consider the radius larger with this value (< 0: for smaller radius)

Enums

public/widgets/lv_arc.h:34enum

lv_arc_mode_t

In which direction the indicator should grow.

Name	Description
`LV_ARC_MODE_NORMAL`	Clock-wise
`LV_ARC_MODE_SYMMETRICAL`	Left/right from the midpoint
`LV_ARC_MODE_REVERSE`	Counterclock-wise

Used by 1 function

lv_arc_set_mode — param type

public/widgets/lv_arc.h:43enum

_lv_property_arc_id_t

Name	Value
`LV_PROPERTY_ARC_START_ANGLE`	`(LV_PROPERTY_ARC_START + ((int) 0 )) \| (( 2 ) << 28 )`
`LV_PROPERTY_ARC_END_ANGLE`	`(LV_PROPERTY_ARC_START + ((int) 1 )) \| (( 2 ) << 28 )`
`LV_PROPERTY_ARC_BG_START_ANGLE`	`(LV_PROPERTY_ARC_START + ((int) 2 )) \| (( 2 ) << 28 )`
`LV_PROPERTY_ARC_BG_END_ANGLE`	`(LV_PROPERTY_ARC_START + ((int) 3 )) \| (( 2 ) << 28 )`
`LV_PROPERTY_ARC_ROTATION`	`(LV_PROPERTY_ARC_START + ((int) 4 )) \| (( 1 ) << 28 )`
`LV_PROPERTY_ARC_MODE`	`(LV_PROPERTY_ARC_START + ((int) 5 )) \| (( 1 ) << 28 )`
`LV_PROPERTY_ARC_VALUE`	`(LV_PROPERTY_ARC_START + ((int) 6 )) \| (( 1 ) << 28 )`
`LV_PROPERTY_ARC_MIN_VALUE`	`(LV_PROPERTY_ARC_START + ((int) 7 )) \| (( 1 ) << 28 )`
`LV_PROPERTY_ARC_MAX_VALUE`	`(LV_PROPERTY_ARC_START + ((int) 8 )) \| (( 1 ) << 28 )`
`LV_PROPERTY_ARC_CHANGE_RATE`	`(LV_PROPERTY_ARC_START + ((int) 9 )) \| (( 1 ) << 28 )`
`LV_PROPERTY_ARC_KNOB_OFFSET`	`(LV_PROPERTY_ARC_START + ((int) 10 )) \| (( 1 ) << 28 )`
`LV_PROPERTY_ARC_END`

Variables

public/widgets/lv_arc.h:40variable

lv_arc_class

const lv_obj_class_t lv_arc_class