diff options
author | Campbell Barton <campbell@blender.org> | 2022-05-05 10:15:36 +0300 |
---|---|---|
committer | Campbell Barton <campbell@blender.org> | 2022-05-05 10:18:50 +0300 |
commit | 0f567ada9d1c60f9ff9a457f83f5c870d0673dab (patch) | |
tree | d9d92897f7357f393361872c3b525d815c03accd /source | |
parent | ddbac88c08ef2f97e4d7b99690cef28322cfb0ed (diff) |
Docs: add doc-string for BMFace.mat_nr struct member
Diffstat (limited to 'source')
-rw-r--r-- | source/blender/bmesh/bmesh_class.h | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/source/blender/bmesh/bmesh_class.h b/source/blender/bmesh/bmesh_class.h index 0246850123a..9d5737a5b71 100644 --- a/source/blender/bmesh/bmesh_class.h +++ b/source/blender/bmesh/bmesh_class.h @@ -265,8 +265,20 @@ typedef struct BMFace { * (the length of #BMFace.l_first circular linked list). */ int len; - float no[3]; /* face normal */ - short mat_nr; /* material index */ + /** + * Face normal, see #BM_face_calc_normal. + */ + float no[3]; + /** + * Material index, typically >= 0 and < #Mesh.totcol although this isn't enforced + * Python for e.g. can set this to any positive value since scripts may create + * mesh data first and setup material slots later. + * + * When using to index into a material array it's range should be checked first, + * values exceeding the range should be ignored or treated as zero + * (if a material slot needs to be used - when drawing for e.g.) + */ + short mat_nr; // short _pad[3]; } BMFace; |