From ffc4c126f5416b04a01653e7a03451797b98aba4 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Tue, 7 Dec 2021 17:19:15 +1100 Subject: Cleanup: move public doc-strings into headers for 'blenkernel' - Added space below non doc-string comments to make it clear these aren't comments for the symbols directly below them. - Use doxy sections for some headers. - Minor improvements to doc-strings. Ref T92709 --- source/blender/blenkernel/BKE_subsurf.h | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) (limited to 'source/blender/blenkernel/BKE_subsurf.h') diff --git a/source/blender/blenkernel/BKE_subsurf.h b/source/blender/blenkernel/BKE_subsurf.h index 3816a822279..db57076082c 100644 --- a/source/blender/blenkernel/BKE_subsurf.h +++ b/source/blender/blenkernel/BKE_subsurf.h @@ -66,18 +66,30 @@ struct DerivedMesh *subsurf_make_derived_from_derived(struct DerivedMesh *dm, void subsurf_calculate_limit_positions(struct Mesh *me, float (*r_positions)[3]); -/* get gridsize from 'level', level must be greater than zero */ +/** + * Get grid-size from 'level', level must be greater than zero. + */ int BKE_ccg_gridsize(int level); -/* x/y grid coordinates at 'low_level' can be multiplied by the result - * of this function to convert to grid coordinates at 'high_level' */ +/** + * X/Y grid coordinates at 'low_level' can be multiplied by the result + * of this function to convert to grid coordinates at 'high_level'. + */ int BKE_ccg_factor(int low_level, int high_level); +/** + * Translate #GridHidden into the #ME_HIDE flag for MVerts. Assumes + * vertices are in the order output by #ccgDM_copyFinalVertArray. + */ void subsurf_copy_grid_hidden(struct DerivedMesh *dm, const struct MPoly *mpoly, struct MVert *mvert, const struct MDisps *mdisps); +/** + * Translate #GridPaintMask into vertex paint masks. Assumes vertices + * are in the order output by #ccgDM_copyFinalVertArray. + */ void subsurf_copy_grid_paint_mask(struct DerivedMesh *dm, const struct MPoly *mpoly, float *paint_mask, -- cgit v1.2.3