lv_arc.h

API reference for lv_arc.h

Summary

Functions

widgets/arc/lv_arc.h:83function

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.)

widgets/arc/lv_arc.h:90function

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.)

widgets/arc/lv_arc.h:98function

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.)

widgets/arc/lv_arc.h:105function

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.)

widgets/arc/lv_arc.h:112function

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.)

widgets/arc/lv_arc.h:120function

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.)

widgets/arc/lv_arc.h:127function

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

widgets/arc/lv_arc.h:134function

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

widgets/arc/lv_arc.h:141function

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

widgets/arc/lv_arc.h:149function

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

widgets/arc/lv_arc.h:156function

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

widgets/arc/lv_arc.h:163function

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

widgets/arc/lv_arc.h:170function

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

widgets/arc/lv_arc.h:177function

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

Enums

widgets/arc/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

widgets/arc/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

widgets/arc/lv_arc.h:40variable

lv_arc_class

const lv_obj_class_t lv_arc_class