From c73840005811ff6d2dbe3bab20d43ebbcad73a1a Mon Sep 17 00:00:00 2001 From: Yuxuan Shui Date: Tue, 6 Feb 2024 12:46:29 +0000 Subject: [PATCH] backend: clarify what clone_image does Signed-off-by: Yuxuan Shui --- src/backend/backend.h | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/backend/backend.h b/src/backend/backend.h index 5896e19d..fba17bbd 100644 --- a/src/backend/backend.h +++ b/src/backend/backend.h @@ -335,9 +335,10 @@ struct backend_operations { bool (*image_op)(backend_t *backend_data, enum image_operations op, void *image_data, const region_t *reg_op, const region_t *reg_visible, void *args); - /// Create another instance of the `image_data`. All `image_op` and - /// `set_image_property` calls on the returned image should not affect the - /// original image + /// Create another instance of the `image_data`. The newly created image + /// inherits its content and all image properties from the image being + /// cloned. All `image_op` and `set_image_property` calls on the + /// returned image should not affect the original image. void *(*clone_image)(backend_t *base, const void *image_data, const region_t *reg_visible);