# lv_area.h (/api/misc/lv_area_h) Functions [#functions] lv_area_set [#lv_area_set] Initialize an area ```c title=" " lineNumbers=1 void lv_area_set(lv_area_t *area_p, int32_t x1, int32_t y1, int32_t x2, int32_t y2) ``` Parameters | Name | Type | Description | | -------- | -------------------------------------------------- | ----------------------------- | | `area_p` | | pointer to an area | | `x1` | | left coordinate of the area | | `y1` | | top coordinate of the area | | `x2` | | right coordinate of the area | | `y2` | | bottom coordinate of the area | lv_area_set_width [#lv_area_set_width] Set the width of an area ```c title=" " lineNumbers=1 void lv_area_set_width(lv_area_t *area_p, int32_t w) ``` Parameters | Name | Type | Description | | -------- | -------------------------------------------------- | ------------------------------------------------- | | `area_p` | | pointer to an area | | `w` | | the new width of the area (w == 1 makes x1 == x2) | lv_area_set_height [#lv_area_set_height] Set the height of an area ```c title=" " lineNumbers=1 void lv_area_set_height(lv_area_t *area_p, int32_t h) ``` Parameters | Name | Type | Description | | -------- | -------------------------------------------------- | -------------------------------------------------- | | `area_p` | | pointer to an area | | `h` | | the new height of the area (h == 1 makes y1 == y2) | lv_point_set [#lv_point_set] ```c title=" " lineNumbers=1 void lv_point_set(lv_point_t *p, int32_t x, int32_t y) ``` Parameters | Name | Type | | ---- | ---------------------------------------------------- | | `p` | | | `x` | | | `y` | | lv_point_precise_set [#lv_point_precise_set] ```c title=" " lineNumbers=1 void lv_point_precise_set(lv_point_precise_t *p, lv_value_precise_t x, lv_value_precise_t y) ``` Parameters | Name | Type | | ---- | -------------------------------------------------------------------- | | `p` | | | `x` | | | `y` | | lv_area_get_width [#lv_area_get_width] Get the width of an area ```c title=" " lineNumbers=1 int32_t lv_area_get_width(const lv_area_t *area_p) ``` Parameters | Name | Type | Description | | -------- | -------------------------------------------------------- | ------------------ | | `area_p` | | pointer to an area | **Returns:** — the width of the area (if x1 == x2 -> width = 1) lv_area_get_height [#lv_area_get_height] Get the height of an area ```c title=" " lineNumbers=1 int32_t lv_area_get_height(const lv_area_t *area_p) ``` Parameters | Name | Type | Description | | -------- | -------------------------------------------------------- | ------------------ | | `area_p` | | pointer to an area | **Returns:** — the height of the area (if y1 == y2 -> height = 1) lv_area_get_size [#lv_area_get_size] Return with area of an area (x \* y) ```c title=" " lineNumbers=1 uint32_t lv_area_get_size(const lv_area_t *area_p) ``` Parameters | Name | Type | Description | | -------- | -------------------------------------------------------- | ------------------ | | `area_p` | | pointer to an area | **Returns:** — size of area lv_area_copy [#lv_area_copy] Copy an area ```c title=" " lineNumbers=1 static void lv_area_copy(lv_area_t *dest, const lv_area_t *src) ``` Parameters | Name | Type | Description | | ------ | -------------------------------------------------------- | ------------------------------- | | `dest` | | pointer to the destination area | | `src` | | pointer to the source area | lv_area_increase [#lv_area_increase] ```c title=" " lineNumbers=1 void lv_area_increase(lv_area_t *area, int32_t w_extra, int32_t h_extra) ``` Parameters | Name | Type | | --------- | -------------------------------------------------- | | `area` | | | `w_extra` | | | `h_extra` | | lv_area_move [#lv_area_move] ```c title=" " lineNumbers=1 void lv_area_move(lv_area_t *area, int32_t x_ofs, int32_t y_ofs) ``` Parameters | Name | Type | | ------- | -------------------------------------------------- | | `area` | | | `x_ofs` | | | `y_ofs` | | lv_area_align [#lv_area_align] Align an area to another ```c title=" " lineNumbers=1 void lv_area_align(const lv_area_t *base, lv_area_t *to_align, lv_align_t align, int32_t ofs_x, int32_t ofs_y) ``` Parameters | Name | Type | Description | | ---------- | -------------------------------------------------------- | --------------------------------------- | | `base` | | an area where the other will be aligned | | `to_align` | | the area to align | | `align` | | `LV_ALIGN_...` | | `ofs_x` | | X offset | | `ofs_y` | | Y offset | lv_point_transform [#lv_point_transform] Transform a point ```c title=" " lineNumbers=1 void lv_point_transform(lv_point_t *point, int32_t angle, int32_t scale_x, int32_t scale_y, const lv_point_t *pivot, bool zoom_first) ``` Parameters | Name | Type | Description | | ------------ | ---------------------------------------------------------- | ------------------------------------------------------------ | | `point` | | pointer to a point | | `angle` | | angle with 0.1 resolutions (123 means 12.3°) | | `scale_x` | | horizontal zoom, 256 means 100% | | `scale_y` | | vertical zoom, 256 means 100% | | `pivot` | | pointer to the pivot point of the transformation | | `zoom_first` | | true: zoom first and rotate after that; else: opposite order | lv_point_array_transform [#lv_point_array_transform] Transform an array of points ```c title=" " lineNumbers=1 void lv_point_array_transform(lv_point_t *points, size_t count, int32_t angle, int32_t scale_x, int32_t scale_y, const lv_point_t *pivot, bool zoom_first) ``` Parameters | Name | Type | Description | | ------------ | ---------------------------------------------------------- | ------------------------------------------------------------ | | `points` | | pointer to an array of points | | `count` | | number of points in the array | | `angle` | | angle with 0.1 resolutions (123 means 12.3°) | | `scale_x` | | horizontal zoom, 256 means 100% | | `scale_y` | | vertical zoom, 256 means 100% | | `pivot` | | pointer to the pivot point of the transformation | | `zoom_first` | | true: zoom first and rotate after that; else: opposite order | lv_point_from_precise [#lv_point_from_precise] ```c title=" " lineNumbers=1 lv_point_t lv_point_from_precise(const lv_point_precise_t *p) ``` Parameters | Name | Type | | ---- | -------------------------------------------------------------------------- | | `p` | | lv_point_to_precise [#lv_point_to_precise] ```c title=" " lineNumbers=1 lv_point_precise_t lv_point_to_precise(const lv_point_t *p) ``` Parameters | Name | Type | | ---- | ---------------------------------------------------------- | | `p` | | lv_point_swap [#lv_point_swap] ```c title=" " lineNumbers=1 void lv_point_swap(lv_point_t *p1, lv_point_t *p2) ``` Parameters | Name | Type | | ---- | ---------------------------------------------------- | | `p1` | | | `p2` | | lv_point_precise_swap [#lv_point_precise_swap] ```c title=" " lineNumbers=1 void lv_point_precise_swap(lv_point_precise_t *p1, lv_point_precise_t *p2) ``` Parameters | Name | Type | | ---- | -------------------------------------------------------------------- | | `p1` | | | `p2` | | lv_pct [#lv_pct] Convert a percentage value to `int32_t`. Percentage values are stored in special range ```c title=" " lineNumbers=1 int32_t lv_pct(int32_t x) ``` Parameters | Name | Type | Description | | ---- | -------------------------- | ------------------------ | | `x` | | the percentage (0..1000) | **Returns:** — a coordinate that stores the percentage lv_pct_to_px [#lv_pct_to_px] ```c title=" " lineNumbers=1 int32_t lv_pct_to_px(int32_t v, int32_t base) ``` Parameters | Name | Type | | ------ | -------------------------- | | `v` | | | `base` | | Enums [#enums] lv_align_t [#lv_align_t] Alignments | Name | Value | | --------------------------- | ----- | | `LV_ALIGN_DEFAULT` | `0` | | `LV_ALIGN_TOP_LEFT` | | | `LV_ALIGN_TOP_MID` | | | `LV_ALIGN_TOP_RIGHT` | | | `LV_ALIGN_BOTTOM_LEFT` | | | `LV_ALIGN_BOTTOM_MID` | | | `LV_ALIGN_BOTTOM_RIGHT` | | | `LV_ALIGN_LEFT_MID` | | | `LV_ALIGN_RIGHT_MID` | | | `LV_ALIGN_CENTER` | | | `LV_ALIGN_OUT_TOP_LEFT` | | | `LV_ALIGN_OUT_TOP_MID` | | | `LV_ALIGN_OUT_TOP_RIGHT` | | | `LV_ALIGN_OUT_BOTTOM_LEFT` | | | `LV_ALIGN_OUT_BOTTOM_MID` | | | `LV_ALIGN_OUT_BOTTOM_RIGHT` | | | `LV_ALIGN_OUT_LEFT_TOP` | | | `LV_ALIGN_OUT_LEFT_MID` | | | `LV_ALIGN_OUT_LEFT_BOTTOM` | | | `LV_ALIGN_OUT_RIGHT_TOP` | | | `LV_ALIGN_OUT_RIGHT_MID` | | | `LV_ALIGN_OUT_RIGHT_BOTTOM` | | * `lv_obj_set_align` — param `align` * `lv_obj_align` — param `align` * `lv_obj_align_to` — param `align` * `lv_obj_set_style_align` — param `value` * `lv_area_align` — param `align` * `lv_style_set_align` — param `value` lv_dir_t [#lv_dir_t] | Name | Value | | --------------- | ----------------------------- | | `LV_DIR_NONE` | `0x00` | | `LV_DIR_LEFT` | `(1 << 0)` | | `LV_DIR_RIGHT` | `(1 << 1)` | | `LV_DIR_TOP` | `(1 << 2)` | | `LV_DIR_BOTTOM` | `(1 << 3)` | | `LV_DIR_HOR` | `LV_DIR_LEFT \| LV_DIR_RIGHT` | | `LV_DIR_VER` | `LV_DIR_TOP \| LV_DIR_BOTTOM` | | `LV_DIR_ALL` | `LV_DIR_HOR \| LV_DIR_VER` | * `lv_obj_set_scroll_dir` — param `dir` * `lv_indev_scroll_throw_predict` — param `dir` * `lv_barcode_set_direction` — param `direction` * `lv_chart_add_cursor` — param `dir` * `lv_dropdown_set_dir` — param `dir` * `lv_spinbox_set_digit_step_direction` — param `direction` * `lv_tabview_set_tab_bar_position` — param `dir` * `lv_tileview_add_tile` — param `dir` Structs [#structs] lv_point_t [#lv_point_t] Represents a point on the screen. | Member | Type | Description | | ------ | -------------------------- | ----------- | | `x` | | | | `y` | | | * `lv_obj_transform_point` — param `p` * `lv_obj_transform_point_array` — param `points` * `lv_obj_hit_test` — param `point` * `lv_obj_get_scroll_end` — param `end` * `lv_test_gesture_set_pinch_data` — param `point_0` * `lv_test_gesture_set_pinch_data` — param `point_1` * `lv_test_gesture_pinch` — param `point_begin_0` * `lv_test_gesture_pinch` — param `point_begin_1` * `lv_test_gesture_pinch` — param `point_end_0` * `lv_test_gesture_pinch` — param `point_end_1` * `lv_display_rotate_point` — param `point` * `lv_image_buf_get_transformed_area` — param `pivot` * `lv_draw_character` — param `point` * `lv_draw_letter` — param `point` * `lv_draw_unit_draw_letter` — param `pos` * `lv_uefi_simple_pointer_indev_create` — param `display_res` * `lv_uefi_absolute_pointer_indev_create` — param `display_res` * `lv_indev_set_button_points` — param `points` * `lv_indev_get_point` — param `point` * `lv_indev_get_vect` — param `point` * `lv_indev_search_obj` — param `point` * `lv_indev_get_gesture_center_point` — param `point` * `lv_indev_get_gesture_primary_point` — param `point` * `lv_indev_scroll_get_snap_dist` — param `p` * `lv_freetype_italic_transform_on_pos` — param `point` * `lv_gltf_get_ray_from_2d_coordinate` — param `screen_pos` * `lv_gltf_world_to_screen` — param `screen_pos` * `lv_point_transform` — param `point` * `lv_point_transform` — param `pivot` * `lv_point_array_transform` — param `points` * `lv_point_array_transform` — param `pivot` * `lv_point_to_precise` — param `p` * `lv_point_set` — param `p` * `lv_point_swap` — param `p1` * `lv_point_swap` — param `p2` * `lv_area_is_point_on` — param `p_p` * `lv_text_get_size` — param `size_res` * `lv_text_get_size_attributes` — param `size_res` * `lv_chart_get_point_pos_by_id` — param `p_out` * `lv_chart_set_cursor_pos` — param `pos` * `lv_image_get_pivot` — param `pivot` * `lv_label_get_letter_pos` — param `pos` * `lv_label_get_letter_on` — param `pos_in` * `lv_label_is_char_under_pos` — param `pos` * `lv_spangroup_get_span_by_point` — param `point` lv_point_precise_t [#lv_point_precise_t] | Member | Type | Description | | ------ | ------------------------------------- | ----------- | | `x` | | | | `y` | | | * `lv_vg_lite_matrix_transform_point` — param `point` * `lv_point_from_precise` — param `p` * `lv_point_precise_set` — param `p` * `lv_point_precise_swap` — param `p1` * `lv_point_precise_swap` — param `p2` * `lv_matrix_transform_precise_point` — param `point` * `lv_line_set_points` — param `points` * `lv_line_set_points_mutable` — param `points` lv_area_t [#lv_area_t] Represents an area of the screen. | Member | Type | Description | | ------ | -------------------------- | ----------- | | `x1` | | | | `y1` | | | | `x2` | | | | `y2` | | | Macros [#macros] LV_COORD_TYPE_SHIFT [#lv_coord_type_shift] ```c title=" " lineNumbers=1 #define LV_COORD_TYPE_SHIFT (29U) ``` LV_COORD_TYPE_MASK [#lv_coord_type_mask] ```c title=" " lineNumbers=1 #define LV_COORD_TYPE_MASK (3 << LV_COORD_TYPE_SHIFT) ``` LV_COORD_TYPE [#lv_coord_type] ```c title=" " lineNumbers=1 #define LV_COORD_TYPE(x) \ ((x) & LV_COORD_TYPE_MASK) /*Extract type specifiers*/ ``` LV_COORD_PLAIN [#lv_coord_plain] ```c title=" " lineNumbers=1 #define LV_COORD_PLAIN(x) \ ((x) & ~LV_COORD_TYPE_MASK) /*Remove type specifiers*/ ``` LV_COORD_TYPE_PX [#lv_coord_type_px] ```c title=" " lineNumbers=1 #define LV_COORD_TYPE_PX (0 << LV_COORD_TYPE_SHIFT) ``` LV_COORD_TYPE_SPEC [#lv_coord_type_spec] ```c title=" " lineNumbers=1 #define LV_COORD_TYPE_SPEC (1 << LV_COORD_TYPE_SHIFT) ``` LV_COORD_TYPE_PX_NEG [#lv_coord_type_px_neg] ```c title=" " lineNumbers=1 #define LV_COORD_TYPE_PX_NEG (3 << LV_COORD_TYPE_SHIFT) ``` LV_COORD_IS_PX [#lv_coord_is_px] ```c title=" " lineNumbers=1 #define LV_COORD_IS_PX(x) \ (LV_COORD_TYPE(x) == LV_COORD_TYPE_PX || LV_COORD_TYPE(x) == LV_COORD_TYPE_PX_NEG) ``` LV_COORD_IS_SPEC [#lv_coord_is_spec] ```c title=" " lineNumbers=1 #define LV_COORD_IS_SPEC(x) \ (LV_COORD_TYPE(x) == LV_COORD_TYPE_SPEC) ``` LV_COORD_SET_SPEC [#lv_coord_set_spec] ```c title=" " lineNumbers=1 #define LV_COORD_SET_SPEC(x) \ ((x) | LV_COORD_TYPE_SPEC) ``` LV_COORD_MAX [#lv_coord_max] ```c title=" " lineNumbers=1 #define LV_COORD_MAX ((1 << LV_COORD_TYPE_SHIFT) - 1) ``` Max coordinate value LV_COORD_MIN [#lv_coord_min] ```c title=" " lineNumbers=1 #define LV_COORD_MIN (-LV_COORD_MAX) ``` LV_SIZE_CONTENT [#lv_size_content] ```c title=" " lineNumbers=1 #define LV_SIZE_CONTENT LV_COORD_SET_SPEC(LV_COORD_MAX) ``` LV_PCT_STORED_MAX [#lv_pct_stored_max] ```c title=" " lineNumbers=1 #define LV_PCT_STORED_MAX (LV_COORD_MAX - 1) ``` LV_PCT_POS_MAX [#lv_pct_pos_max] ```c title=" " lineNumbers=1 #define LV_PCT_POS_MAX (LV_PCT_STORED_MAX / 2) ``` LV_PCT [#lv_pct-1] ```c title=" " lineNumbers=1 #define LV_PCT(x) \ (LV_COORD_SET_SPEC(((x) < 0 ? (LV_PCT_POS_MAX - LV_MAX((x), -LV_PCT_POS_MAX)) : LV_MIN((x), LV_PCT_POS_MAX)))) ``` LV_COORD_IS_PCT [#lv_coord_is_pct] ```c title=" " lineNumbers=1 #define LV_COORD_IS_PCT(x) \ ((LV_COORD_IS_SPEC(x) && LV_COORD_PLAIN(x) <= LV_PCT_STORED_MAX)) ``` LV_COORD_GET_PCT [#lv_coord_get_pct] ```c title=" " lineNumbers=1 #define LV_COORD_GET_PCT(x) \ (LV_COORD_PLAIN(x) > LV_PCT_POS_MAX ? LV_PCT_POS_MAX - LV_COORD_PLAIN(x) : LV_COORD_PLAIN(x)) ``` Dependencies [#dependencies]