1
0
mirror of https://github.com/lvgl/lvgl.git synced 2025-01-28 07:03:00 +08:00

chore(img): update API comments

fix: #3350
This commit is contained in:
Gabor Kiss-Vamosi 2022-05-16 17:23:20 +02:00
parent 76de7c6b7b
commit ccbb41dedc

View File

@ -114,6 +114,7 @@ void lv_img_set_offset_y(lv_obj_t * obj, lv_coord_t y);
/** /**
* Set the rotation angle of the image. * Set the rotation angle of the image.
* The image will be rotated around the set pivot set by `lv_img_set_pivot()` * The image will be rotated around the set pivot set by `lv_img_set_pivot()`
* Note that indexed and alpha only images can't be transformed.
* @param obj pointer to an image object * @param obj pointer to an image object
* @param angle rotation angle in degree with 0.1 degree resolution (0..3600: clock wise) * @param angle rotation angle in degree with 0.1 degree resolution (0..3600: clock wise)
*/ */
@ -121,7 +122,7 @@ void lv_img_set_angle(lv_obj_t * obj, int16_t angle);
/** /**
* Set the rotation center of the image. * Set the rotation center of the image.
* The image will be rotated around this point * The image will be rotated around this point.
* @param obj pointer to an image object * @param obj pointer to an image object
* @param x rotation center x of the image * @param x rotation center x of the image
* @param y rotation center y of the image * @param y rotation center y of the image
@ -131,6 +132,7 @@ void lv_img_set_pivot(lv_obj_t * obj, lv_coord_t x, lv_coord_t y);
/** /**
* Set the zoom factor of the image. * Set the zoom factor of the image.
* Note that indexed and alpha only images can't be transformed.
* @param img pointer to an image object * @param img pointer to an image object
* @param zoom the zoom factor. * @param zoom the zoom factor.
* @example 256 or LV_ZOOM_IMG_NONE for no zoom * @example 256 or LV_ZOOM_IMG_NONE for no zoom