From 3efb31ee310b465f741cd2d0a1bca98d378409e7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sybren=20A=2E=20St=C3=BCvel?= Date: Tue, 20 Dec 2022 14:17:30 +0100 Subject: [PATCH] Cleanup: add some deformation-related comments Add documentation for `BKE_id_defgroup_list_get()` and document that `CD_MDEFORMVERT` mesh layers contain `MDeformVert` structs. No functional changes. --- source/blender/blenkernel/BKE_deform.h | 5 +++++ source/blender/makesdna/DNA_customdata_types.h | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/source/blender/blenkernel/BKE_deform.h b/source/blender/blenkernel/BKE_deform.h index 4023d6829d4..995a17c4f71 100644 --- a/source/blender/blenkernel/BKE_deform.h +++ b/source/blender/blenkernel/BKE_deform.h @@ -37,6 +37,11 @@ int BKE_object_defgroup_active_index_get(const struct Object *ob); */ void BKE_object_defgroup_active_index_set(struct Object *ob, int new_index); +/** + * Return the ID's vertex group names. + * Supports Mesh (ME), Lattice (LT), and GreasePencil (GD) IDs. + * \return ListBase of bDeformGroup pointers. + */ const struct ListBase *BKE_id_defgroup_list_get(const struct ID *id); struct ListBase *BKE_id_defgroup_list_get_mutable(struct ID *id); int BKE_id_defgroup_name_index(const struct ID *id, const char *name); diff --git a/source/blender/makesdna/DNA_customdata_types.h b/source/blender/makesdna/DNA_customdata_types.h index 5a534fa7904..3bff2f4316c 100644 --- a/source/blender/makesdna/DNA_customdata_types.h +++ b/source/blender/makesdna/DNA_customdata_types.h @@ -92,7 +92,7 @@ typedef enum eCustomDataType { #ifdef DNA_DEPRECATED_ALLOW CD_MSTICKY = 1, /* DEPRECATED */ #endif - CD_MDEFORMVERT = 2, + CD_MDEFORMVERT = 2, /* Array of `MDeformVert`. */ CD_MEDGE = 3, CD_MFACE = 4, CD_MTFACE = 5,