From c097c7b855d4b01950494dc369e9def59486b0fd Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Tue, 14 Dec 2021 15:49:31 +1100 Subject: Cleanup: correct unbalanced doxygen groups Also add groups in some files. --- source/blender/draw/intern/draw_cache.c | 16 +++++++++++++ .../blender/draw/intern/draw_cache_extract_mesh.cc | 7 ++++-- .../intern/draw_cache_extract_mesh_render_data.c | 2 +- .../blender/draw/intern/draw_cache_impl_gpencil.c | 26 +++++++++++++++++----- .../blender/draw/intern/draw_cache_impl_metaball.c | 9 ++++++-- source/blender/draw/intern/draw_instance_data.c | 1 + source/blender/draw/intern/draw_manager.c | 2 ++ source/blender/draw/intern/draw_select_buffer.c | 1 + source/blender/draw/intern/draw_view.c | 1 + .../draw/intern/mesh_extractors/extract_mesh.h | 2 ++ .../mesh_extractors/extract_mesh_ibo_edituv.cc | 2 -- .../mesh_extractors/extract_mesh_ibo_fdots.cc | 3 +-- .../extract_mesh_ibo_lines_adjacency.cc | 6 ++--- .../extract_mesh_ibo_lines_paint_mask.cc | 6 ++--- .../mesh_extractors/extract_mesh_ibo_points.cc | 5 +++-- .../mesh_extractors/extract_mesh_vbo_fdots_nor.cc | 2 ++ .../mesh_extractors/extract_mesh_vbo_lnor.cc | 1 + 17 files changed, 68 insertions(+), 24 deletions(-) (limited to 'source/blender/draw/intern') diff --git a/source/blender/draw/intern/draw_cache.c b/source/blender/draw/intern/draw_cache.c index 8cf0eaad5e8..03fb3b92277 100644 --- a/source/blender/draw/intern/draw_cache.c +++ b/source/blender/draw/intern/draw_cache.c @@ -47,6 +47,10 @@ #include "draw_cache_impl.h" #include "draw_manager.h" +/* -------------------------------------------------------------------- */ +/** \name Internal Defines + * \{ */ + #define VCLASS_LIGHT_AREA_SHAPE (1 << 0) #define VCLASS_LIGHT_SPOT_SHAPE (1 << 1) #define VCLASS_LIGHT_SPOT_BLEND (1 << 2) @@ -77,6 +81,12 @@ #define DRW_SPHERE_SHAPE_LATITUDE_HIGH 80 #define DRW_SPHERE_SHAPE_LONGITUDE_HIGH 60 +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Internal Types + * \{ */ + typedef struct Vert { float pos[3]; int class; @@ -163,6 +173,8 @@ void DRW_shape_cache_free(void) } } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name Procedural Batches * \{ */ @@ -765,6 +777,8 @@ GPUBatch *DRW_cache_normal_arrow_get(void) return SHC.drw_normal_arrow; } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name Dummy VBO's * @@ -3137,6 +3151,8 @@ GPUBatch *DRW_cache_pointcloud_surface_get(Object *object) return DRW_pointcloud_batch_cache_get_surface(object); } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name Volume * \{ */ diff --git a/source/blender/draw/intern/draw_cache_extract_mesh.cc b/source/blender/draw/intern/draw_cache_extract_mesh.cc index f3b72503907..485b803310c 100644 --- a/source/blender/draw/intern/draw_cache_extract_mesh.cc +++ b/source/blender/draw/intern/draw_cache_extract_mesh.cc @@ -56,6 +56,7 @@ namespace blender::draw { /* ---------------------------------------------------------------------- */ /** \name Mesh Elements Extract Struct * \{ */ + using TaskId = int; using TaskLen = int; @@ -158,6 +159,7 @@ class ExtractorRunDatas : public Vector { /* ---------------------------------------------------------------------- */ /** \name ExtractTaskData * \{ */ + struct ExtractTaskData { const MeshRenderData *mr = nullptr; MeshBatchCache *cache = nullptr; @@ -495,6 +497,7 @@ static struct TaskNode *extract_task_node_create(struct TaskGraph *task_graph, /* ---------------------------------------------------------------------- */ /** \name Task Node - Update Mesh Render Data * \{ */ + struct MeshRenderDataUpdateTaskData { MeshRenderData *mr = nullptr; MeshBufferCache *cache = nullptr; @@ -778,6 +781,8 @@ static void mesh_buffer_cache_create_requested(struct TaskGraph *task_graph, #endif } +/** \} */ + } // namespace blender::draw extern "C" { @@ -814,5 +819,3 @@ void mesh_buffer_cache_create_requested(struct TaskGraph *task_graph, } } // extern "C" - -/** \} */ diff --git a/source/blender/draw/intern/draw_cache_extract_mesh_render_data.c b/source/blender/draw/intern/draw_cache_extract_mesh_render_data.c index 4a543db2574..8b0fbf86360 100644 --- a/source/blender/draw/intern/draw_cache_extract_mesh_render_data.c +++ b/source/blender/draw/intern/draw_cache_extract_mesh_render_data.c @@ -174,8 +174,8 @@ void mesh_render_data_update_loose_geom(MeshRenderData *mr, /** \name Polygons sorted per material * * Contains polygon indices sorted based on their material. - * * \{ */ + static void mesh_render_data_polys_sorted_load(MeshRenderData *mr, const MeshBufferCache *cache); static void mesh_render_data_polys_sorted_ensure(MeshRenderData *mr, MeshBufferCache *cache); static void mesh_render_data_polys_sorted_build(MeshRenderData *mr, MeshBufferCache *cache); diff --git a/source/blender/draw/intern/draw_cache_impl_gpencil.c b/source/blender/draw/intern/draw_cache_impl_gpencil.c index 24bc03ef154..483e52ed547 100644 --- a/source/blender/draw/intern/draw_cache_impl_gpencil.c +++ b/source/blender/draw/intern/draw_cache_impl_gpencil.c @@ -47,7 +47,10 @@ #define BEZIER_HANDLE (1 << 3) #define COLOR_SHIFT 5 -/* ---------------------------------------------------------------------- */ +/* -------------------------------------------------------------------- */ +/** \name Internal Types + * \{ */ + typedef struct GpencilBatchCache { /** Instancing Data */ GPUVertBuf *vbo; @@ -74,6 +77,12 @@ typedef struct GpencilBatchCache { int cache_frame; } GpencilBatchCache; +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Internal Utilities + * \{ */ + static bool gpencil_batch_cache_valid(GpencilBatchCache *cache, bGPdata *gpd, int cfra) { bool valid = true; @@ -151,6 +160,12 @@ static GpencilBatchCache *gpencil_batch_cache_get(Object *ob, int cfra) return cache; } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name BKE Callbacks + * \{ */ + void DRW_gpencil_batch_cache_dirty_tag(bGPdata *gpd) { gpd->flag |= GP_DATA_CACHE_IS_DIRTY; @@ -166,7 +181,7 @@ void DRW_gpencil_batch_cache_free(bGPdata *gpd) /** \} */ /* -------------------------------------------------------------------- */ -/** \name Vertex Formats. +/** \name Vertex Formats * \{ */ /* MUST match the format below. */ @@ -247,7 +262,7 @@ static GPUVertFormat *gpencil_color_format(void) /** \} */ /* -------------------------------------------------------------------- */ -/** \name Vertex Buffers. +/** \name Vertex Buffers * \{ */ typedef struct gpIterData { @@ -681,8 +696,9 @@ void DRW_cache_gpencil_sbuffer_clear(Object *ob) /** \} */ -/* ---------------------------------------------------------------------- */ -/* Edit GPencil Batches */ +/* -------------------------------------------------------------------- */ +/** \name Edit GPencil Batches + * \{ */ #define GP_EDIT_POINT_SELECTED (1 << 0) #define GP_EDIT_STROKE_SELECTED (1 << 1) diff --git a/source/blender/draw/intern/draw_cache_impl_metaball.c b/source/blender/draw/intern/draw_cache_impl_metaball.c index 4d3a990ec72..63bffed0eaf 100644 --- a/source/blender/draw/intern/draw_cache_impl_metaball.c +++ b/source/blender/draw/intern/draw_cache_impl_metaball.c @@ -41,8 +41,9 @@ static void metaball_batch_cache_clear(MetaBall *mb); -/* ---------------------------------------------------------------------- */ -/* MetaBall GPUBatch Cache */ +/* -------------------------------------------------------------------- */ +/** \name MetaBall GPUBatch Cache + * \{ */ typedef struct MetaBallBatchCache { GPUBatch *batch; @@ -175,6 +176,8 @@ static GPUIndexBuf *mball_batch_cache_get_edges_adj_lines(Object *ob, MetaBallBa return cache->edges_adj_lines; } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name Public Object/MetaBall API * \{ */ @@ -303,3 +306,5 @@ int DRW_metaball_material_count_get(MetaBall *mb) { return max_ii(1, mb->totcol); } + +/** \} */ diff --git a/source/blender/draw/intern/draw_instance_data.c b/source/blender/draw/intern/draw_instance_data.c index ddfa5058ec5..7e1d1208698 100644 --- a/source/blender/draw/intern/draw_instance_data.c +++ b/source/blender/draw/intern/draw_instance_data.c @@ -407,6 +407,7 @@ void DRW_instance_data_list_resize(DRWInstanceDataList *idatalist) } /** \} */ + /* -------------------------------------------------------------------- */ /** \name Sparse Uniform Buffer * \{ */ diff --git a/source/blender/draw/intern/draw_manager.c b/source/blender/draw/intern/draw_manager.c index b5401e725ed..930fb6eabef 100644 --- a/source/blender/draw/intern/draw_manager.c +++ b/source/blender/draw/intern/draw_manager.c @@ -3226,6 +3226,8 @@ void DRW_xr_drawing_end(void) #endif +/** \} */ + /* -------------------------------------------------------------------- */ /** \name Internal testing API for gtests * \{ */ diff --git a/source/blender/draw/intern/draw_select_buffer.c b/source/blender/draw/intern/draw_select_buffer.c index 4b9b3da5635..bae07753336 100644 --- a/source/blender/draw/intern/draw_select_buffer.c +++ b/source/blender/draw/intern/draw_select_buffer.c @@ -497,4 +497,5 @@ void DRW_select_buffer_context_create(Base **bases, const uint bases_len, short select_ctx->select_mode = select_mode; memset(select_ctx->persmat, 0, sizeof(select_ctx->persmat)); } + /** \} */ diff --git a/source/blender/draw/intern/draw_view.c b/source/blender/draw/intern/draw_view.c index b9c040c5162..6fe0abf1adf 100644 --- a/source/blender/draw/intern/draw_view.c +++ b/source/blender/draw/intern/draw_view.c @@ -283,6 +283,7 @@ void DRW_draw_cursor_2d(void) DRW_draw_cursor_2d_ex(region, sima->cursor); } } + /** \} */ /* **************************** 3D Gizmo ******************************** */ diff --git a/source/blender/draw/intern/mesh_extractors/extract_mesh.h b/source/blender/draw/intern/mesh_extractors/extract_mesh.h index 0210b832c9b..7d21804c08f 100644 --- a/source/blender/draw/intern/mesh_extractors/extract_mesh.h +++ b/source/blender/draw/intern/mesh_extractors/extract_mesh.h @@ -168,7 +168,9 @@ BLI_INLINE const float *bm_face_no_get(const MeshRenderData *mr, const BMFace *e /* ---------------------------------------------------------------------- */ /** \name Mesh Elements Extract Struct * \{ */ + /* TODO(jbakker): move parameters inside a struct. */ + typedef void(ExtractTriBMeshFn)(const MeshRenderData *mr, BMLoop **elt, const int elt_index, diff --git a/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_edituv.cc b/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_edituv.cc index d06fb91411e..4cc9a875f79 100644 --- a/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_edituv.cc +++ b/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_edituv.cc @@ -388,5 +388,3 @@ const MeshExtract extract_edituv_lines = blender::draw::create_extractor_edituv_ const MeshExtract extract_edituv_points = blender::draw::create_extractor_edituv_points(); const MeshExtract extract_edituv_fdots = blender::draw::create_extractor_edituv_fdots(); } - -/** \} */ diff --git a/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_fdots.cc b/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_fdots.cc index ea58e1aeed8..2e8b85250f3 100644 --- a/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_fdots.cc +++ b/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_fdots.cc @@ -110,10 +110,9 @@ constexpr MeshExtract create_extractor_fdots() } /** \} */ + } // namespace blender::draw extern "C" { const MeshExtract extract_fdots = blender::draw::create_extractor_fdots(); } - -/** \} */ diff --git a/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_lines_adjacency.cc b/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_lines_adjacency.cc index 522afcd44a1..e7dabfa9ee2 100644 --- a/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_lines_adjacency.cc +++ b/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_lines_adjacency.cc @@ -173,8 +173,6 @@ static void extract_lines_adjacency_finish(const MeshRenderData *UNUSED(mr), #undef NO_EDGE -/** \} */ - constexpr MeshExtract create_extractor_lines_adjacency() { MeshExtract extractor = {nullptr}; @@ -189,10 +187,10 @@ constexpr MeshExtract create_extractor_lines_adjacency() return extractor; } +/** \} */ + } // namespace blender::draw extern "C" { const MeshExtract extract_lines_adjacency = blender::draw::create_extractor_lines_adjacency(); } - -/** \} */ diff --git a/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_lines_paint_mask.cc b/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_lines_paint_mask.cc index 494a43e97d1..f7eb5022cdc 100644 --- a/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_lines_paint_mask.cc +++ b/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_lines_paint_mask.cc @@ -103,8 +103,6 @@ static void extract_lines_paint_mask_finish(const MeshRenderData *UNUSED(mr), MEM_freeN(data->select_map); } -/** \} */ - constexpr MeshExtract create_extractor_lines_paint_mask() { MeshExtract extractor = {nullptr}; @@ -118,10 +116,10 @@ constexpr MeshExtract create_extractor_lines_paint_mask() return extractor; } +/** \} */ + } // namespace blender::draw extern "C" { const MeshExtract extract_lines_paint_mask = blender::draw::create_extractor_lines_paint_mask(); } - -/** \} */ diff --git a/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_points.cc b/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_points.cc index b801ba04162..01e14a004ed 100644 --- a/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_points.cc +++ b/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_points.cc @@ -32,6 +32,7 @@ namespace blender::draw { /* ---------------------------------------------------------------------- */ /** \name Extract Point Indices * \{ */ + static void extract_points_init(const MeshRenderData *mr, struct MeshBatchCache *UNUSED(cache), void *UNUSED(buf), @@ -173,10 +174,10 @@ constexpr MeshExtract create_extractor_points() return extractor; } +/** \} */ + } // namespace blender::draw extern "C" { const MeshExtract extract_points = blender::draw::create_extractor_points(); } - -/** \} */ diff --git a/source/blender/draw/intern/mesh_extractors/extract_mesh_vbo_fdots_nor.cc b/source/blender/draw/intern/mesh_extractors/extract_mesh_vbo_fdots_nor.cc index fed66f0057d..b2ebff08abf 100644 --- a/source/blender/draw/intern/mesh_extractors/extract_mesh_vbo_fdots_nor.cc +++ b/source/blender/draw/intern/mesh_extractors/extract_mesh_vbo_fdots_nor.cc @@ -28,6 +28,7 @@ namespace blender::draw { /* ---------------------------------------------------------------------- */ /** \name Extract Face-dots Normal and edit flag * \{ */ + #define NOR_AND_FLAG_DEFAULT 0 #define NOR_AND_FLAG_SELECT 1 #define NOR_AND_FLAG_ACTIVE -1 @@ -114,6 +115,7 @@ constexpr MeshExtract create_extractor_fdots_nor() /* ---------------------------------------------------------------------- */ /** \name Extract Face-dots High Quality Normal and edit flag * \{ */ + static void extract_fdots_nor_hq_init(const MeshRenderData *mr, struct MeshBatchCache *UNUSED(cache), void *buf, diff --git a/source/blender/draw/intern/mesh_extractors/extract_mesh_vbo_lnor.cc b/source/blender/draw/intern/mesh_extractors/extract_mesh_vbo_lnor.cc index f9f66c27aaa..3c3ac7a7a0a 100644 --- a/source/blender/draw/intern/mesh_extractors/extract_mesh_vbo_lnor.cc +++ b/source/blender/draw/intern/mesh_extractors/extract_mesh_vbo_lnor.cc @@ -121,6 +121,7 @@ constexpr MeshExtract create_extractor_lnor() } /** \} */ + /* ---------------------------------------------------------------------- */ /** \name Extract HQ Loop Normal * \{ */ -- cgit v1.2.3