From 925644fbccecd9eeaf9ff043020dc5b948e12ccf Mon Sep 17 00:00:00 2001 From: Aleix Pol Date: Tue, 2 Nov 2021 15:52:36 +0100 Subject: [PATCH] spa/meta: Expand the documentation of SPA_META_VideoDamage A bit of explanation of how it's meant to be used. --- spa/include/spa/buffer/meta.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spa/include/spa/buffer/meta.h b/spa/include/spa/buffer/meta.h index 1c1089633..952e79366 100644 --- a/spa/include/spa/buffer/meta.h +++ b/spa/include/spa/buffer/meta.h @@ -41,7 +41,7 @@ enum spa_meta_type { SPA_META_Invalid, SPA_META_Header, /**< struct spa_meta_header */ SPA_META_VideoCrop, /**< struct spa_meta_region with cropping data */ - SPA_META_VideoDamage, /**< array of struct spa_meta_region with damage */ + SPA_META_VideoDamage, /**< array of struct spa_meta_region with damage, where an invalid entry or end-of-array marks the end. */ SPA_META_Bitmap, /**< struct spa_meta_bitmap */ SPA_META_Cursor, /**< struct spa_meta_cursor */ SPA_META_Control, /**< metadata contains a spa_meta_control