Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKévin Dietrich <kevin.dietrich@mailoo.org>2022-03-13 20:05:40 +0300
committerKévin Dietrich <kevin.dietrich@mailoo.org>2022-03-13 20:05:40 +0300
commit5a0efc9c8b5ad991109c97d52d476d8c071a78ac (patch)
treee5c8290bc613ef8eea923d0983cb51512c4b1ce7 /source/blender/render/RE_pipeline.h
parent1ca7821b15f3883121552495436142814c73fbb7 (diff)
parent91dbc28363e5450f241eb9696aaca29075c01d20 (diff)
Merge branch 'master' into temp-abc-features
Diffstat (limited to 'source/blender/render/RE_pipeline.h')
-rw-r--r--source/blender/render/RE_pipeline.h10
1 files changed, 7 insertions, 3 deletions
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,