diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-10-05 03:10:25 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-10-05 03:10:25 +0300 |
commit | 2b66b372bc39e12f938488a008f38b1945d86aa9 (patch) | |
tree | d8f2409d99bd91d8998c129f76fd4dc82a2a91d5 /source/blender/gpu/intern/gpu_select.c | |
parent | 2dace5f3ef54cc25ed31fe20fd33df727f10a9ac (diff) |
Cleanup: use doxygen sections
Diffstat (limited to 'source/blender/gpu/intern/gpu_select.c')
-rw-r--r-- | source/blender/gpu/intern/gpu_select.c | 30 |
1 files changed, 23 insertions, 7 deletions
diff --git a/source/blender/gpu/intern/gpu_select.c b/source/blender/gpu/intern/gpu_select.c index 661c462f60d..3c89f082e9b 100644 --- a/source/blender/gpu/intern/gpu_select.c +++ b/source/blender/gpu/intern/gpu_select.c @@ -38,6 +38,10 @@ #include "gpu_select_private.h" +/* -------------------------------------------------------------------- */ +/** \name Internal Types + * \{ */ + /* Internal algorithm used */ enum { /** glBegin/EndQuery(GL_SAMPLES_PASSED... ), `gpu_select_query.c` @@ -61,6 +65,12 @@ typedef struct GPUSelectState { static GPUSelectState g_select_state = {0}; +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Public API + * \{ */ + /** * initialize and provide buffer for results */ @@ -149,12 +159,14 @@ uint GPU_select_end(void) return hits; } -/* ---------------------------------------------------------------------------- - * Caching +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Caching * * Support multiple begin/end's as long as they are within the initial region. - * Currently only used by ALGO_GL_PICK. - */ + * Currently only used by #ALGO_GL_PICK. + * \{ */ void GPU_select_cache_begin(void) { @@ -187,9 +199,11 @@ bool GPU_select_is_cached(void) return g_select_state.use_cache && gpu_select_pick_is_cached(); } -/* ---------------------------------------------------------------------------- - * Utilities - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Utilities + * \{ */ /** * Helper function, nothing special but avoids doing inline since hits aren't sorted by depth @@ -269,3 +283,5 @@ void GPU_select_buffer_stride_realign(const rcti *src, const rcti *dst, uint *r_ } memset(r_buf, 0, (last_px_id + 1) * sizeof(*r_buf)); } + +/** \} */ |