diff options
Diffstat (limited to 'source/blender/render/intern/render_result.h')
| -rw-r--r-- | source/blender/render/intern/render_result.h | 37 |
1 files changed, 36 insertions, 1 deletions
diff --git a/source/blender/render/intern/render_result.h b/source/blender/render/intern/render_result.h index 34b8143869c..ede0a0d21ea 100644 --- a/source/blender/render/intern/render_result.h +++ b/source/blender/render/intern/render_result.h @@ -46,6 +46,12 @@ extern "C" { /* New */ +/** + * Called by main render as well for parts will read info from Render *re to define layers. + * \note Called in threads. + * + * `re->winx`, `re->winy` is coordinate space of entire image, `partrct` the part within. + */ struct RenderResult *render_result_new(struct Render *re, struct rcti *partrct, const char *layername, @@ -53,6 +59,10 @@ struct RenderResult *render_result_new(struct Render *re, void render_result_passes_allocated_ensure(struct RenderResult *rr); +/** + * From imbuf, if a handle was returned and + * it's not a single-layer multi-view we convert this to render result. + */ struct RenderResult *render_result_new_from_exr( void *exrhandle, const char *colorspace, bool predivide, int rectx, int recty); @@ -61,6 +71,11 @@ void render_result_views_new(struct RenderResult *rr, const struct RenderData *r /* Merge */ +/** + * Used when rendering to a full buffer, or when reading the EXR part-layer-pass file. + * no test happens here if it fits... we also assume layers are in sync. + * \note Is used within threads. + */ void render_result_merge(struct RenderResult *rr, struct RenderResult *rrpart); /* Add Passes */ @@ -70,14 +85,22 @@ void render_result_clone_passes(struct Render *re, struct RenderResult *rr, cons /* Free */ void render_result_free(struct RenderResult *rr); +/** + * Version that's compatible with full-sample buffers. + */ void render_result_free_list(struct ListBase *lb, struct RenderResult *rr); /* Single Layer Render */ void render_result_single_layer_begin(struct Render *re); +/** + * If #RenderData.scemode is #R_SINGLE_LAYER, at end of rendering, merge the both render results. + */ void render_result_single_layer_end(struct Render *re); -/* render pass wrapper for gpencil */ +/** + * Render pass wrapper for grease-pencil. + */ struct RenderPass *render_layer_add_pass(struct RenderResult *rr, struct RenderLayer *rl, int channels, @@ -86,6 +109,9 @@ struct RenderPass *render_layer_add_pass(struct RenderResult *rr, const char *chan_id, const bool allocate); +/** + * Called for reading temp files, and for external engines. + */ int render_result_exr_file_read_path(struct RenderResult *rr, struct RenderLayer *rl_single, const char *filepath); @@ -93,6 +119,9 @@ int render_result_exr_file_read_path(struct RenderResult *rr, /* EXR cache */ void render_result_exr_file_cache_write(struct Render *re); +/** + * For cache, makes exact copy of render result. + */ bool render_result_exr_file_cache_read(struct Render *re); /* Combined Pixel Rect */ @@ -110,7 +139,13 @@ void render_result_rect_get_pixels(struct RenderResult *rr, const struct ColorManagedDisplaySettings *display_settings, const int view_id); +/** + * Create a new views #ListBase in rr without duplicating the memory pointers. + */ void render_result_views_shallowcopy(struct RenderResult *dst, struct RenderResult *src); +/** + * Free the views created temporarily. + */ void render_result_views_shallowdelete(struct RenderResult *rr); bool render_result_has_views(const struct RenderResult *rr); |