[Bf-blender-cvs] [fae45a43fab] master: Cleanup: use doxy-sections for pipeline, text_drag & effects
Campbell Barton
noreply at git.blender.org
Mon Mar 7 01:58:49 CET 2022
Commit: fae45a43fab410eb1e46a9bf4d4b6133b5a7bbdd
Author: Campbell Barton
Date: Mon Mar 7 10:51:22 2022 +1100
Branches: master
https://developer.blender.org/rBfae45a43fab410eb1e46a9bf4d4b6133b5a7bbdd
Cleanup: use doxy-sections for pipeline, text_drag & effects
Also improve on the doc-string for RE_RenderFrame & RE_RenderAnim.
===================================================================
M source/blender/editors/space_text/text_draw.c
M source/blender/render/RE_pipeline.h
M source/blender/render/intern/pipeline.c
M source/blender/sequencer/intern/effects.c
M source/blender/sequencer/intern/effects.h
===================================================================
diff --git a/source/blender/editors/space_text/text_draw.c b/source/blender/editors/space_text/text_draw.c
index 8fefd258f7a..0e29c68cf23 100644
--- a/source/blender/editors/space_text/text_draw.c
+++ b/source/blender/editors/space_text/text_draw.c
@@ -36,7 +36,9 @@
#include "WM_api.h"
#include "WM_types.h"
-/******************** text font drawing ******************/
+/* -------------------------------------------------------------------- */
+/** \name Text Font Drawing
+ * \{ */
typedef struct TextDrawContext {
int font_id;
@@ -141,7 +143,11 @@ static void format_draw_color(const TextDrawContext *tdc, char formatchar)
}
}
-/************************** draw text *****************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Draw Text
+ * \{ */
/**
* Notes on word-wrap
@@ -556,7 +562,11 @@ static void text_draw(const SpaceText *st,
flatten_string_free(&fs);
}
-/************************ cache utilities *****************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Cache Utilities
+ * \{ */
typedef struct DrawCache {
int *line_height;
@@ -766,7 +776,11 @@ void text_free_caches(SpaceText *st)
}
}
-/************************ word-wrap utilities *****************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Word-Wrap Utilities
+ * \{ */
/* cache should be updated in caller */
static int text_get_visible_lines_no(const SpaceText *st, int lineno)
@@ -845,7 +859,11 @@ int text_get_total_lines(SpaceText *st, ARegion *region)
return drawcache->total_lines;
}
-/************************ draw scrollbar *****************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Draw Scroll-Bar
+ * \{ */
static void calc_text_rcts(SpaceText *st, ARegion *region, rcti *scroll, rcti *back)
{
@@ -1006,7 +1024,11 @@ static void draw_textscroll(const SpaceText *st, rcti *scroll, rcti *back)
col);
}
-/*********************** draw documentation *******************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Draw Documentation
+ * \{ */
#if 0
static void draw_documentation(const SpaceText *st, ARegion *region)
@@ -1118,7 +1140,11 @@ static void draw_documentation(const SpaceText *st, ARegion *region)
}
#endif
-/*********************** draw suggestion list *******************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Draw Suggestion List
+ * \{ */
static void draw_suggestion_list(const SpaceText *st, const TextDrawContext *tdc, ARegion *region)
{
@@ -1221,7 +1247,11 @@ static void draw_suggestion_list(const SpaceText *st, const TextDrawContext *tdc
}
}
-/*********************** draw cursor ************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Draw Cursor
+ * \{ */
static void draw_text_decoration(SpaceText *st, ARegion *region)
{
@@ -1383,7 +1413,11 @@ static void draw_text_decoration(SpaceText *st, ARegion *region)
immUnbindProgram();
}
-/******************* draw matching brackets *********************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Draw Matching Brackets
+ * \{ */
static void draw_brackets(const SpaceText *st, const TextDrawContext *tdc, ARegion *region)
{
@@ -1544,7 +1578,11 @@ static void draw_brackets(const SpaceText *st, const TextDrawContext *tdc, ARegi
}
}
-/*********************** main region drawing *************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Main Region Drawing
+ * \{ */
void draw_text_main(SpaceText *st, ARegion *region)
{
@@ -1707,7 +1745,11 @@ void draw_text_main(SpaceText *st, ARegion *region)
text_font_end(&tdc);
}
-/************************** update ***************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Update & Coordinate Conversion
+ * \{ */
void text_update_character_width(SpaceText *st)
{
@@ -1861,3 +1903,5 @@ error:
r_pixel_co[0] = r_pixel_co[1] = -1;
return false;
}
+
+/** \} */
diff --git a/source/blender/render/RE_pipeline.h b/source/blender/render/RE_pipeline.h
index 2d43aa7b27f..f532c705534 100644
--- a/source/blender/render/RE_pipeline.h
+++ b/source/blender/render/RE_pipeline.h
@@ -322,9 +322,13 @@ bool RE_WriteRenderViewsMovie(struct ReportList *reports,
bool preview);
/**
- * Only #RE_NewRender() needed, main Blender render calls.
- *
* General Blender frame render call.
+ *
+ * \note Only #RE_NewRender() needed, main Blender render calls.
+ *
+ * \param write_still: Saves frames to disk (typically disabled). Useful for batch-operations
+ * (rendering from Python for e.g.) when an additional save action for is inconvenient.
+ * This is the default behavior for #RE_RenderAnim.
*/
void RE_RenderFrame(struct Render *re,
struct Main *bmain,
@@ -334,7 +338,7 @@ void RE_RenderFrame(struct Render *re,
int frame,
bool write_still);
/**
- * Saves images to disk.
+ * A version of #RE_RenderFrame that saves images to disk.
*/
void RE_RenderAnim(struct Render *re,
struct Main *bmain,
diff --git a/source/blender/render/intern/pipeline.c b/source/blender/render/intern/pipeline.c
index 2a93fb2c46b..aa006713755 100644
--- a/source/blender/render/intern/pipeline.c
+++ b/source/blender/render/intern/pipeline.c
@@ -116,14 +116,20 @@
* - save file or append in movie
*/
-/* ********* globals ******** */
+/* -------------------------------------------------------------------- */
+/** \name Globals
+ * \{ */
/* here we store all renders */
static struct {
ListBase renderlist;
} RenderGlobal = {{NULL, NULL}};
-/* ********* callbacks ******** */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Callbacks
+ * \{ */
static void render_callback_exec_null(Render *re, Main *bmain, eCbEvent evt)
{
@@ -141,7 +147,11 @@ static void render_callback_exec_id(Render *re, Main *bmain, ID *id, eCbEvent ev
BKE_callback_exec_id(bmain, id, evt);
}
-/* ********* alloc and free ******** */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Allocation & Free
+ * \{ */
static int do_write_image_or_movie(Render *re,
Main *bmain,
@@ -308,7 +318,11 @@ static bool render_scene_has_layers_to_render(Scene *scene, ViewLayer *single_la
return false;
}
-/* *************************************************** */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Public Render API
+ * \{ */
Render *RE_GetRender(const char *name)
{
@@ -686,7 +700,11 @@ void RE_FreePersistentData(const Scene *scene)
}
}
-/* ********* initialize state ******** */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Initialize State
+ * \{ */
static void re_init_resolution(Render *re, Render *source, int winx, int winy, rcti *disprect)
{
@@ -905,7 +923,11 @@ void RE_test_break_cb(Render *re, void *handle, int (*f)(void *handle))
re->tbh = handle;
}
-/* ********* GL Context ******** */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name OpenGL Context
+ * \{ */
void RE_gl_context_create(Render *re)
{
@@ -944,6 +966,16 @@ void *RE_gpu_context_get(Render *re)
return re->gpu_context;
}
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Render & Composite Scenes (Implementation & Public API)
+ *
+ * Main high-level functions defined here are:
+ * - #RE_RenderFrame
+ * - #RE_RenderAnim
+ * \{ */
+
/* ************ This part uses API, for rendering Blender scenes ********** */
/* make sure disprect is not affected by the render border */
@@ -1940,6 +1972,12 @@ void RE_RenderFreestyleExternal(Render *re)
}
#endif
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Read/Write Render Result (Images & Movies)
+ * \{ */
+
bool RE_WriteRenderViewsImage(
ReportList *reports, RenderResult *rr, Scene *scene, const bool stamp, char *name)
{
@@ -2600,11 +2638,6 @@ bool RE_ReadRenderResult(Scene *scene, Scene *scenode)
return success;
}
-void RE_init_threadcount(Render *re)
-{
- re->r.threads = BKE_render_num_threads(&re->r);
-}
-
void RE_layer_load_from_file(
RenderLayer *layer, ReportList *reports, const char *filename, int x, int y)
{
@@ -2785,6 +2818,12 @@ RenderPass *RE_create_gp_pass(RenderResult *rr, const char *layername, const cha
return render_layer_add_pass(rr, rl, 4, RE_PASSNAME_COMBINED, viewname, "RGBA", true);
}
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Miscellaneous Public Render API
+ * \{ */
+
bool RE_allow_render_generic_object(Object *ob)
{
/* override not showing object when duplis are used with particles */
@@ -2796,3 +2835,10 @@ bool RE_allow_render_generic_object(Object *ob)
}
return true;
}
+
+void RE_init_threadcount(Render *re)
+{
+ re->r.threads = BKE_render_num_threads(&re->r);
+}
+
+/** \} */
diff --git a/source/blender/sequencer/intern/effects.c b/source/blender/sequencer/intern/effects.c
index aa433eeed09..faa4cd14825 100644
--- a/source/blender/sequencer/intern/effects.c
+++ b/source/blender/sequencer/intern/effects.c
@@ -58,6 +58,10 @@
static struct SeqEffectHandle get_sequence_effect_impl(int seq_type);
+/* -------------------------------------------------------------------- */
+/** \name Internal Utilities
+ * \{ */
+
static void slice_get_byte_buffers(const SeqRenderData *context,
const ImBuf *i
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list