render_internal.cc File Reference

#include <cstddef>
#include <cstring>
#include "MEM_guardedalloc.h"
#include "BLI_listbase.h"
#include "BLI_math_base.hh"
#include "BLI_rect.h"
#include "BLI_string_utf8.h"
#include "BLI_string_utils.hh"
#include "BLI_time.h"
#include "BLI_timecode.h"
#include "BLI_utildefines.h"
#include "BLT_translation.hh"
#include "DNA_object_types.h"
#include "DNA_scene_types.h"
#include "DNA_userdef_types.h"
#include "DNA_view3d_types.h"
#include "BKE_colortools.hh"
#include "BKE_context.hh"
#include "BKE_global.hh"
#include "BKE_image.hh"
#include "BKE_image_format.hh"
#include "BKE_layer.hh"
#include "BKE_lib_id.hh"
#include "BKE_main.hh"
#include "BKE_node_tree_update.hh"
#include "BKE_object.hh"
#include "BKE_report.hh"
#include "BKE_scene.hh"
#include "BKE_screen.hh"
#include "NOD_composite.hh"
#include "DEG_depsgraph.hh"
#include "WM_api.hh"
#include "WM_types.hh"
#include "ED_render.hh"
#include "ED_screen.hh"
#include "ED_util.hh"
#include "BIF_glutil.hh"
#include "RE_engine.h"
#include "RE_pipeline.h"
#include "IMB_colormanagement.hh"
#include "IMB_imbuf_types.hh"
#include "RNA_access.hh"
#include "RNA_define.hh"
#include "SEQ_relations.hh"
#include "render_intern.hh"

Go to the source code of this file.

Classes
struct	RenderJob

Functions
static bool	render_break (void *rjv)
static bool	image_buffer_calc_tile_rect (const RenderResult *rr, const ImBuf *ibuf, rcti *renrect, rcti *r_ibuf_rect, int *r_offset_x, int *r_offset_y)
static void	image_buffer_rect_update (RenderJob *rj, RenderResult *rr, ImBuf *ibuf, ImageUser *iuser, const rcti *tile_rect, int offset_x, int offset_y, const char *viewname)
static void	screen_render_single_layer_set (wmOperator *op, Main *mainp, ViewLayer *active_layer, Scene **scene, ViewLayer **single_layer)
static bool	render_operator_has_custom_frame_range (wmOperator *render_operator)
static void	get_render_operator_frame_range (wmOperator *render_operator, const Scene *scene, int &frame_start, int &frame_end)
static wmOperatorStatus	screen_render_exec (bContext *C, wmOperator *op)
static void	render_freejob (void *rjv)
static void	make_renderinfo_string (const RenderStats *rs, const Scene *scene, const bool v3d_override, const char *error, char ret[IMA_MAX_RENDER_TEXT_SIZE])
static void	image_renderinfo_cb (void *rjv, RenderStats *rs)
static void	render_progress_update (void *rjv, float progress)
static void	render_image_update_pass_and_layer (RenderJob *rj, RenderResult *rr, ImageUser *iuser)
static void	image_rect_update (void *rjv, RenderResult *rr, rcti *renrect)
static void	current_scene_update (void *rjv, Scene *scene)
static void	render_startjob (void *rjv, wmJobWorkerStatus *worker_status)
static void	render_image_restore_scene_and_layer (RenderJob *rj)
static void	render_endjob (void *rjv)
static bool	render_breakjob (void *rjv)
static void	render_drawlock (void *rjv, bool lock)
static wmOperatorStatus	screen_render_modal (bContext *C, wmOperator *op, const wmEvent *event)
static void	screen_render_cancel (bContext *C, wmOperator *op)
static void	clean_viewport_memory_base (Base *base)
static void	clean_viewport_memory (Main *bmain, Scene *scene)
static wmOperatorStatus	screen_render_invoke (bContext *C, wmOperator *op, const wmEvent *event)
static std::string	screen_render_get_description (bContext *, wmOperatorType *, PointerRNA *ptr)
void	RENDER_OT_render (wmOperatorType *ot)
static RenderJobBase *	render_job_get (const bContext *C)
Scene *	ED_render_job_get_scene (const bContext *C)
Scene *	ED_render_job_get_current_scene (const bContext *C)
static wmOperatorStatus	render_shutter_curve_preset_exec (bContext *C, wmOperator *op)
void	RENDER_OT_shutter_curve_preset (wmOperatorType *ot)

Function Documentation

clean_viewport_memory()

void clean_viewport_memory ( Main * bmain, Scene * scene )

static

Definition at line 984 of file render_internal.cc.

References b, BKE_main_id_tag_listbase(), BKE_view_layer_object_bases_get(), BKE_view_layer_synced_ensure(), clean_viewport_memory_base(), ID_TAG_DOIT, LISTBASE_FOREACH, Main::objects, SETLOOPER_SET_ONLY, Main::wm, and WM_window_get_active_view_layer().

Referenced by screen_render_invoke().

clean_viewport_memory_base()

void clean_viewport_memory_base ( Base * base )

static

Definition at line 966 of file render_internal.cc.

References BASE_ENABLED_AND_MAYBE_VISIBLE_IN_VIEWPORT, BKE_object_free_derived_caches(), Base::flag, Object::id, ID_TAG_DOIT, Base::object, RE_allow_render_generic_object(), and ID::tag.

Referenced by clean_viewport_memory().

current_scene_update()

void current_scene_update ( void * rjv, Scene * scene )

static

Definition at line 730 of file render_internal.cc.

References BKE_image_partial_update_mark_full_update(), RenderJobBase::current_scene, RenderJob::image, RenderJob::iuser, and ImageUser::scene.

Referenced by screen_render_invoke().

ED_render_job_get_current_scene()

Scene * ED_render_job_get_current_scene

(

const bContext *

C

)

Definition at line 1341 of file render_internal.cc.

References C, RenderJobBase::current_scene, and render_job_get().

Referenced by DRW_engine_external_acquire_for_image_editor(), and image_user_refresh_scene().

ED_render_job_get_scene()

Scene * ED_render_job_get_scene

(

const bContext *

C

)

Definition at line 1335 of file render_internal.cc.

References C, render_job_get(), and RenderJobBase::scene.

Referenced by draw_render_info().

get_render_operator_frame_range()

void get_render_operator_frame_range ( wmOperator * render_operator, const Scene * scene, int & frame_start, int & frame_end )

static

Definition at line 306 of file render_internal.cc.

References RenderData::efra, wmOperator::ptr, Scene::r, RNA_int_get(), RNA_struct_property_is_set(), and RenderData::sfra.

Referenced by screen_render_exec(), and screen_render_invoke().

image_buffer_calc_tile_rect()

bool image_buffer_calc_tile_rect ( const RenderResult * rr, const ImBuf * ibuf, rcti * renrect, rcti * r_ibuf_rect, int * r_offset_x, int * r_offset_y )

static

Definition at line 100 of file render_internal.cc.

References RenderResult::rectx, RenderResult::recty, RenderResult::renlay, RenderResult::tilerect, ImBuf::x, rcti::xmax, rcti::xmin, ImBuf::y, rcti::ymax, and rcti::ymin.

Referenced by image_rect_update().

image_buffer_rect_update()

void image_buffer_rect_update ( RenderJob * rj, RenderResult * rr, ImBuf * ibuf, ImageUser * iuser, const rcti * tile_rect, int offset_x, int offset_y, const char * viewname )

static

Definition at line 167 of file render_internal.cc.

References BKE_scene_multiview_view_id_get(), BLI_rcti_size_x(), BLI_rcti_size_y(), ImBuf::byte_buffer, ImBufByteBuffer::data, ImBufFloatBuffer::data, Scene::display_settings, ImBuf::float_buffer, IB_DISPLAY_BUFFER_INVALID, RenderView::ibuf, IMB_partial_display_buffer_update(), ImageUser::pass, Scene::r, RE_PASSNAME_COMBINED, RE_RenderLayerGetPass(), RE_RenderViewGetById(), RenderResult::rectx, RenderResult::renlay, RenderJobBase::scene, ImBuf::userflags, Scene::view_settings, ImBuf::x, rcti::xmin, and rcti::ymin.

Referenced by image_rect_update().

image_rect_update()

void image_rect_update ( void * rjv, RenderResult * rr, rcti * renrect )

static

Definition at line 665 of file render_internal.cc.

References BKE_image_acquire_ibuf(), BKE_image_free_buffers, BKE_image_get_tile, BKE_image_release_ibuf(), BKE_image_update_gputexture_delayed(), BLI_rcti_size_x(), BLI_rcti_size_y(), ImBuf::channels, RenderJob::do_update, ED_draw_imbuf_method(), RenderJob::image, image_buffer_calc_tile_rect(), image_buffer_rect_update(), IMAGE_DRAW_METHOD_GLSL, RenderJob::image_outdated, RenderJob::iuser, Image::last_render_slot, lock, RenderJob::re, RE_GetActiveRenderView(), render_image_update_pass_and_layer(), and Image::render_slot.

Referenced by screen_render_invoke().

image_renderinfo_cb()

void image_renderinfo_cb ( void * rjv, RenderStats * rs )

static

Definition at line 568 of file render_internal.cc.

References RenderJob::do_update, RenderResult::error, IMA_MAX_RENDER_TEXT_SIZE, make_renderinfo_string(), MEM_calloc_arrayN(), RenderJob::re, RE_AcquireResultRead(), RE_ReleaseResult(), RenderJobBase::scene, RenderResult::text, and RenderJob::v3d_override.

Referenced by screen_render_invoke().

make_renderinfo_string()

void make_renderinfo_string ( const RenderStats * rs, const Scene * scene, const bool v3d_override, const char * error, char ret[IMA_MAX_RENDER_TEXT_SIZE] )

static

Definition at line 450 of file render_internal.cc.

References BLI_assert, BLI_string_join_array(), BLI_string_len_array(), BLI_time_now_seconds(), BLI_timecode_string_from_time_simple(), ceilf, RenderData::cfra, error(), G, G_DEBUG, i, IMA_MAX_RENDER_TEXT_SIZE, RenderStats::infostr, RenderStats::lastframetime, RenderStats::localview, MEM_get_memory_in_use, MEM_get_peak_memory, mem_in_use, RenderStats::mem_peak, RenderStats::mem_used, printf, Scene::r, ret, RPT_, SNPRINTF_UTF8, RenderStats::starttime, and RenderStats::statstr.

Referenced by image_renderinfo_cb().

render_break()

bool render_break ( void * )

static

For exec() when there is no render job NOTE: this won't check for the escape key being pressed, but doing so isn't thread-safe.

Definition at line 923 of file render_internal.cc.

References G.

Referenced by screen_render_exec().

render_breakjob()

bool render_breakjob ( void * rjv )

static

Definition at line 906 of file render_internal.cc.

References G, and RenderJob::stop.

Referenced by screen_render_invoke().

render_drawlock()

void render_drawlock ( void * rjv, bool lock )

static

Definition at line 933 of file render_internal.cc.

References BKE_spacedata_draw_locks(), RenderJob::interface_locked, lock, REGION_DRAW_LOCK_NONE, and REGION_DRAW_LOCK_RENDER.

Referenced by screen_render_invoke().

render_endjob()

void render_endjob ( void * rjv )

static

Definition at line 817 of file render_internal.cc.

References RenderJob::anim, RenderJob::area, BKE_image_acquire_ibuf(), BKE_image_release_ibuf(), BKE_main_free(), BKE_ntree_update(), BKE_ntree_update_tag_id_changed(), BKE_scene_get_depsgraph(), BLI_findindex(), Scene::compositing_node_group, DEG_tag_on_visible_update(), depsgraph, ED_update_for_newframe(), ListBase::first, G, G_MAIN, IB_DISPLAY_BUFFER_INVALID, Scene::id, RenderJob::image, RenderJob::image_outdated, RenderJob::interface_locked, RenderJob::iuser, ListBase::last, lock, RenderJob::main, NA_EDITED, NC_NODE, NC_SCENE, ND_RENDER_RESULT, ntreeCompositClearTags(), Scene::r, R_NO_FRAME_UPDATE, RenderJob::re, RE_display_free(), render_image_restore_scene_and_layer(), RenderData::scemode, RenderJobBase::scene, RenderJob::single_layer, ImBuf::userflags, RenderJob::view_layer, Scene::view_layers, WM_locked_interface_set(), and WM_main_add_notifier().

Referenced by screen_render_invoke().

render_freejob()

void render_freejob ( void * rjv )

static

Definition at line 442 of file render_internal.cc.

References BKE_color_managed_view_settings_free(), and RenderJob::view_settings.

Referenced by screen_render_invoke().

render_image_restore_scene_and_layer()

void render_image_restore_scene_and_layer ( RenderJob * rj )

static

Definition at line 777 of file render_internal.cc.

References RenderJob::area, bScreen::areabase, ImageUser::flag, IMA_SHOW_SEQUENCER_SCENE, SpaceImage::iuser, ImageUser::layer, LISTBASE_FOREACH, RenderJob::main, RenderJob::orig_layer, RenderJob::re, RE_AcquireResultRead(), RE_HasCombinedLayer(), RE_HasSingleLayer(), RE_ReleaseResult(), SET_FLAG_FROM_TEST, SPACE_IMAGE, RenderJob::use_sequencer_scene, Main::wm, and WM_window_get_active_screen().

Referenced by render_endjob().

render_image_update_pass_and_layer()

void render_image_update_pass_and_layer ( RenderJob * rj, RenderResult * rr, ImageUser * iuser )

static

Definition at line 607 of file render_internal.cc.

References RenderJob::area, bScreen::areabase, BLI_findstringindex(), ListBase::first, RenderJob::image, SpaceImage::image, SpaceImage::iuser, RenderJob::last_layer, ImageUser::layer, RenderResult::layers, LISTBASE_FOREACH, RenderJob::main, name, RenderLayer::name, wmWindow::next, offsetof, ImageUser::pass, RenderJob::re, RE_AcquireResultRead(), RE_ReleaseResult(), RenderResult::renlay, SPACE_IMAGE, Main::wm, and WM_window_get_active_screen().

Referenced by image_rect_update().

render_job_get()

RenderJobBase * render_job_get ( const bContext * C )

static

Definition at line 1317 of file render_internal.cc.

References C, CTX_data_scene(), CTX_data_sequencer_scene(), CTX_wm_manager(), WM_JOB_TYPE_RENDER, and WM_jobs_customdata_from_type().

Referenced by ED_render_job_get_current_scene(), and ED_render_job_get_scene().

render_operator_has_custom_frame_range()

bool render_operator_has_custom_frame_range ( wmOperator * render_operator )

static

Definition at line 300 of file render_internal.cc.

References wmOperator::ptr, and RNA_struct_property_is_set().

Referenced by screen_render_exec(), and screen_render_invoke().

RENDER_OT_render()

void RENDER_OT_render

(

wmOperatorType *

ot

)

Contextual render, using current scene, view3d?

Definition at line 1233 of file render_internal.cc.

References ED_operator_screenactive(), MAX_ID_NAME, ot, PROP_SKIP_SAVE, RE_MAXNAME, RNA_def_boolean(), RNA_def_int(), RNA_def_property_flag(), RNA_def_string(), screen_render_cancel(), screen_render_exec(), screen_render_get_description(), screen_render_invoke(), and screen_render_modal().

Referenced by ED_operatortypes_render().

RENDER_OT_shutter_curve_preset()

void RENDER_OT_shutter_curve_preset

(

wmOperatorType *

ot

)

Definition at line 1367 of file render_internal.cc.

References BLT_I18NCONTEXT_ID_CURVE_LEGACY, CURVE_PRESET_LINE, CURVE_PRESET_MAX, CURVE_PRESET_ROOT, CURVE_PRESET_ROUND, CURVE_PRESET_SHARP, CURVE_PRESET_SMOOTH, ot, render_shutter_curve_preset_exec(), RNA_def_enum(), and RNA_def_property_translation_context().

Referenced by ED_operatortypes_render().

render_progress_update()

void render_progress_update ( void * rjv, float progress )

static

Definition at line 590 of file render_internal.cc.

References RenderJob::do_update, and RenderJob::progress.

Referenced by screen_render_invoke().

render_shutter_curve_preset_exec()

wmOperatorStatus render_shutter_curve_preset_exec ( bContext * C, wmOperator * op )

static

Definition at line 1349 of file render_internal.cc.

References BKE_curvemap_reset(), BKE_curvemapping_changed(), C, CurveMapping::clipr, CurveMapping::cm, CTX_data_scene(), CUMA_EXTEND_EXTRAPOLATE, CurveMapping::flag, RenderData::mblur_shutter_curve, OPERATOR_FINISHED, PositiveNegative, CurveMapping::preset, wmOperator::ptr, Scene::r, and RNA_enum_get().

Referenced by RENDER_OT_shutter_curve_preset().

render_startjob()

void render_startjob ( void * rjv, wmJobWorkerStatus * worker_status )

static

Definition at line 743 of file render_internal.cc.

References RenderJob::anim, RenderJob::camera_override, RenderData::cfra, RenderJob::do_update, wmJobWorkerStatus::do_update, RenderJob::frame_end, RenderJob::frame_start, RenderData::frame_step, RenderJob::main, RenderJob::progress, wmJobWorkerStatus::progress, Scene::r, RenderJob::re, RE_RenderAnim(), RE_RenderFrame(), RE_SetReports(), RenderJob::reports, RenderJobBase::scene, RenderJob::single_layer, RenderJob::stop, wmJobWorkerStatus::stop, RenderData::subframe, and RenderJob::write_still.

Referenced by screen_render_invoke().

screen_render_cancel()

void screen_render_cancel ( bContext * C, wmOperator * op )

static

Definition at line 957 of file render_internal.cc.

References C, CTX_wm_manager(), wmOperator::customdata, WM_JOB_TYPE_RENDER, and WM_jobs_kill_type().

Referenced by RENDER_OT_render().

screen_render_exec()

wmOperatorStatus screen_render_exec ( bContext * C, wmOperator * op )

static

Definition at line 327 of file render_internal.cc.

References BKE_image_backup_render(), BKE_image_ensure_viewer(), BKE_image_signal(), BKE_imtype_is_movie(), BKE_report(), BKE_view_layer_default_render(), C, blender::seq::cache_cleanup(), RenderData::cfra, CTX_data_depsgraph_pointer(), CTX_data_main(), CTX_data_scene(), CTX_data_sequencer_scene(), CTX_data_view_layer(), CTX_wm_view3d(), ED_update_for_newframe(), RenderData::engine, RenderResult::error, RenderData::frame_step, G, get_render_operator_frame_range(), RenderData::im_format, IMA_SIGNAL_FREE, IMA_TYPE_R_RESULT, ImageFormatData::imtype, NC_SCENE, ND_RENDER_RESULT, OPERATOR_CANCELLED, OPERATOR_FINISHED, wmOperator::ptr, Scene::r, RE_AcquireResultRead(), RE_draw_lock_cb(), RE_engines_find(), RE_NewSceneRender(), RE_ReleaseResult(), RE_RenderAnim(), RE_RenderFrame(), RE_seq_render_active(), RE_SetReports(), RE_test_break_cb(), RenderEngineType::render, render_break(), render_operator_has_custom_frame_range(), wmOperator::reports, RNA_boolean_get(), RPT_ERROR, screen_render_single_layer_set(), RenderData::subframe, V3D_CAMERA_LOCAL, and WM_event_add_notifier().

Referenced by RENDER_OT_render().

screen_render_get_description()

std::string screen_render_get_description ( bContext * , wmOperatorType * , PointerRNA * ptr )

static

Definition at line 1222 of file render_internal.cc.

References ptr, RNA_boolean_get(), and TIP_.

Referenced by RENDER_OT_render().

screen_render_invoke()

wmOperatorStatus screen_render_invoke ( bContext * C, wmOperator * op, const wmEvent * event )

static

Definition at line 1012 of file render_internal.cc.

References RenderJob::anim, RenderJob::area, BKE_color_managed_display_settings_copy(), BKE_color_managed_view_settings_copy(), BKE_image_backup_render(), BKE_image_ensure_viewer(), BKE_image_signal(), BKE_imtype_is_movie(), BKE_report(), BKE_view_layer_default_render(), C, blender::seq::cache_cleanup(), Scene::camera, RenderJob::camera_override, clean_viewport_memory(), CTX_data_main(), CTX_data_scene(), CTX_data_sequencer_scene(), CTX_data_view_layer(), CTX_wm_manager(), CTX_wm_screen(), CTX_wm_view3d(), CTX_wm_window(), RenderJobBase::current_scene, current_scene_update(), wmOperator::customdata, RenderJob::display_settings, Scene::display_settings, ED_editors_flush_edits_ex(), ED_screen_animation_play(), ED_screen_animation_playing(), RenderData::engine, ListBase::first, RenderJob::frame_end, RenderJob::frame_start, G, get_render_operator_frame_range(), RenderData::im_format, IMA_SIGNAL_FREE, IMA_TYPE_R_RESULT, RenderJob::image, image_rect_update(), image_renderinfo_cb(), ImageFormatData::imtype, RenderJob::interface_locked, RenderJob::iuser, SpaceImage::iuser, RenderJob::last_layer, ImageUser::layer, RenderJob::main, name, NC_SCENE, ND_RENDER_RESULT, OPERATOR_CANCELLED, OPERATOR_RUNNING_MODAL, RenderJob::orig_layer, wmOperator::ptr, Scene::r, R_DOSEQ, RenderJob::re, RE_current_scene_update_cb(), RE_display_ensure_gpu_context(), RE_display_init(), RE_display_update_cb(), RE_draw_lock_cb(), RE_engines_find(), RE_is_rendering_allowed(), RE_NewSceneRender(), RE_progress_cb(), RE_seq_render_active(), RE_stats_draw_cb(), RE_test_break_cb(), REGION_DRAW_LOCK_RENDER, blender::seq::relations_check_scene_recursion(), RenderEngineType::render, render_breakjob(), render_drawlock(), render_endjob(), render_freejob(), render_operator_has_custom_frame_range(), render_progress_update(), render_startjob(), render_view_open(), RenderJob::reports, wmOperator::reports, RNA_boolean_get(), RNA_struct_property_is_set(), RPT_, RPT_ERROR, RenderData::scemode, ImageUser::scene, RenderJobBase::scene, screen_render_single_layer_set(), RenderJob::single_layer, ScrArea::spacedata, RenderData::use_lock_interface, RenderJob::use_sequencer_scene, V3D_CAMERA_LOCAL, RenderJob::v3d_override, RenderJob::view_layer, RenderJob::view_settings, Scene::view_settings, WM_cursor_wait(), WM_event_add_modal_handler(), WM_event_add_notifier(), WM_JOB_EXCL_RENDER, WM_JOB_PRIORITY, WM_JOB_PROGRESS, WM_JOB_TYPE_RENDER, WM_jobs_callbacks(), WM_jobs_customdata_set(), WM_jobs_delay_start(), WM_jobs_get(), WM_jobs_kill_all_except(), WM_jobs_start(), WM_jobs_test(), WM_jobs_timer(), WM_locked_interface_set_with_flags(), RenderJob::write_still, and wmEvent::xy.

Referenced by RENDER_OT_render().

screen_render_modal()

wmOperatorStatus screen_render_modal ( bContext * C, wmOperator * op, const wmEvent * event )

static

Catch escape key to cancel.

Definition at line 944 of file render_internal.cc.

References C, CTX_wm_manager(), wmOperator::customdata, EVT_ESCKEY, OPERATOR_FINISHED, OPERATOR_PASS_THROUGH, OPERATOR_RUNNING_MODAL, wmEvent::type, WM_JOB_TYPE_RENDER, and WM_jobs_test().

Referenced by RENDER_OT_render().

screen_render_single_layer_set()

void screen_render_single_layer_set ( wmOperator * op, Main * mainp, ViewLayer * active_layer, Scene ** scene, ViewLayer ** single_layer )

static

Definition at line 264 of file render_internal.cc.

References BKE_scene_camera_switch_update(), BLI_findstring(), RenderData::cfra, MAX_ID_NAME, name, offsetof, wmOperator::ptr, Scene::r, R_SINGLE_LAYER, RE_MAXNAME, RNA_string_get(), RNA_struct_property_is_set(), and Main::scenes.

Referenced by screen_render_exec(), and screen_render_invoke().