#include <render_types.h>

Inherits BaseRender.

Public Member Functions
	Render ()=default
	~Render () override
blender::render::TilesHighlight *	get_tile_highlight () override
void	compositor_execute (const Scene &scene, const RenderData &render_data, const bNodeTree &node_tree, const char view_name, blender::compositor::RenderContext render_context, blender::compositor::Profiler *profiler, blender::compositor::OutputTypes needed_outputs) override
void	compositor_free () override
void	display_init (RenderResult *render_result) override
void	display_clear (RenderResult *render_result) override
void	display_update (RenderResult render_result, rcti rect) override
void	current_scene_update (struct Scene *scene) override
void	stats_draw (RenderStats *render_stats) override
void	progress (float progress) override
void	draw_lock () override
void	draw_unlock () override
bool	test_break () override
bool	prepare_viewlayer (struct ViewLayer view_layer, struct Depsgraph depsgraph) override
Public Member Functions inherited from BaseRender
	BaseRender ()=default
virtual	~BaseRender ()

Public Attributes
char	name [RE_MAXNAME] = ""
short	flag = 0
bool	ok = false
RenderResult *	pushedresult = nullptr
ListBase	fullresult = {nullptr, nullptr}
bool	result_has_gpu_texture_caches = false
int	winx = 0
int	winy = 0
rcti	disprect = {0, 0, 0, 0}
rctf	viewplane = {0, 0, 0, 0}
int	rectx = 0
int	recty = 0
float	winmat [4][4] = {{0}}
float	clip_start = 0.0f
float	clip_end = 0.0f
struct Main *	main = nullptr
Scene *	scene = nullptr
RenderData	r = {}
char	single_view_layer [MAX_NAME] = ""
struct Object *	camera_override = nullptr
blender::render::TilesHighlight	tile_highlight
struct Depsgraph *	pipeline_depsgraph = nullptr
Scene *	pipeline_scene_eval = nullptr
blender::render::Compositor *	compositor = nullptr
blender::Mutex	compositor_mutex
void(*	display_init_cb )(void handle, RenderResult rr) = nullptr
void *	dih = nullptr
void(*	display_clear_cb )(void handle, RenderResult rr) = nullptr
void *	dch = nullptr
void(*	display_update_cb )(void handle, RenderResult rr, rcti *rect) = nullptr
void *	duh = nullptr
void(*	current_scene_update_cb )(void handle, struct Scene scene) = nullptr
void *	suh = nullptr
void(*	stats_draw_cb )(void handle, RenderStats ri) = nullptr
void *	sdh = nullptr
void(*	progress_cb )(void *handle, float i) = nullptr
void *	prh = nullptr
void(*	draw_lock_cb )(void *handle, bool lock) = nullptr
void *	dlh = nullptr
bool(*	test_break_cb )(void *handle) = nullptr
void *	tbh = nullptr
bool(*	prepare_viewlayer_cb )(void handle, struct ViewLayer vl, struct Depsgraph *depsgraph)
void *	prepare_vl_handle
RenderStats	i = {}
struct ReportList *	reports = nullptr
blender::Vector< MovieWriter * >	movie_writers
char	viewname [MAX_NAME] = ""
void *	system_gpu_context = nullptr
void *	blender_gpu_context = nullptr
Public Attributes inherited from BaseRender
RenderResult *	result = nullptr
ThreadRWMutex	resultmutex = BLI_RWLOCK_INITIALIZER
struct RenderEngine *	engine = nullptr
ThreadMutex	engine_draw_mutex = BLI_MUTEX_INITIALIZER

Detailed Description

Controls state of render, everything that's read-only during render stage.

Definition at line 136 of file render_types.h.

Constructor & Destructor Documentation

◆ Render()

Render::Render ( )

default

◆ ~Render()

Render::~Render ( )

override

Definition at line 30 of file render_types.cc.

References BKE_curvemapping_free_data(), pushedresult, r, RE_blender_gpu_context_free(), RE_compositor_free(), RE_system_gpu_context_free(), and render_result_free().

Member Function Documentation

◆ compositor_execute()

void Render::compositor_execute	(	const Scene &	scene,
		const RenderData &	render_data,
		const bNodeTree &	node_tree,
		const char *	view_name,
		blender::compositor::RenderContext *	render_context,
		blender::compositor::Profiler *	profiler,
		blender::compositor::OutputTypes	needed_outputs )

overridevirtual

Implements BaseRender.

Definition at line 675 of file render/intern/compositor.cc.

References compositor, compositor_mutex, lock, and scene.

Referenced by RE_compositor_execute().

◆ compositor_free()

void Render::compositor_free ( )

overridevirtual

Implements BaseRender.

Definition at line 705 of file render/intern/compositor.cc.

References compositor, compositor_mutex, and lock.

Referenced by RE_compositor_free().

◆ current_scene_update()

void Render::current_scene_update ( struct Scene * scene )

overridevirtual

Implements BaseRender.

Definition at line 63 of file render_types.cc.

References current_scene_update_cb, scene, and suh.

Referenced by do_render_compositor_scenes(), and do_render_engine().

◆ display_clear()

void Render::display_clear ( RenderResult * render_result )

overridevirtual

Implements BaseRender.

Definition at line 49 of file render_types.cc.

References dch, and display_clear_cb.

Referenced by render_init_from_main().

◆ display_init()

void Render::display_init ( RenderResult * render_result )

overridevirtual

Implements BaseRender.

Definition at line 42 of file render_types.cc.

References dih, and display_init_cb.

Referenced by render_init_from_main(), and render_result_uncrop().

◆ display_update()

void Render::display_update	(	RenderResult *	render_result,
		rcti *	rect )

overridevirtual

Implements BaseRender.

Definition at line 56 of file render_types.cc.

References display_update_cb, and duh.

Referenced by do_render_compositor(), do_render_full_pipeline(), do_render_sequencer(), RE_engine_end_result(), RE_engine_update_result(), and render_result_uncrop().

◆ draw_lock()

void Render::draw_lock ( )

overridevirtual

Implements BaseRender.

Definition at line 84 of file render_types.cc.

References dlh, and draw_lock_cb.

Referenced by engine_render_view_layer(), and RE_engine_render().

◆ draw_unlock()

void Render::draw_unlock ( )

overridevirtual

Implements BaseRender.

Definition at line 90 of file render_types.cc.

References dlh, and draw_lock_cb.

Referenced by engine_render_view_layer(), and RE_engine_render().

◆ get_tile_highlight()

blender::render::TilesHighlight * Render::get_tile_highlight ( )

inlineoverridevirtual

Implements BaseRender.

Definition at line 142 of file render_types.h.

References tile_highlight.

Referenced by RE_engine_end_result(), RE_engine_get_current_tiles(), RE_engine_tile_highlight_clear_all(), and RE_engine_tile_highlight_set().

◆ prepare_viewlayer()

bool Render::prepare_viewlayer	(	struct ViewLayer *	view_layer,
		struct Depsgraph *	depsgraph )

overridevirtual

Executed right before the initialization of the depsgraph, in order to modify some stuff in the viewlayer. The modified ids must be tagged in the depsgraph.

If false is returned then rendering is aborted,

Implements BaseRender.

Definition at line 106 of file render_types.cc.

References depsgraph, prepare_viewlayer_cb, and prepare_vl_handle.

Referenced by engine_render_view_layer().

◆ progress()

void Render::progress ( float progress )

overridevirtual

Implements BaseRender.

Definition at line 77 of file render_types.cc.

References prh, progress(), and progress_cb.

Referenced by do_render_sequencer(), progress(), and RE_engine_update_progress().

◆ stats_draw()

void Render::stats_draw ( RenderStats * render_stats )

overridevirtual

Implements BaseRender.

Definition at line 70 of file render_types.cc.

References sdh, and stats_draw_cb.

Referenced by do_render_full_pipeline(), FRS_do_stroke_rendering(), prepare(), RE_engine_update_stats(), and render_compositor_stats().

◆ test_break()

bool Render::test_break ( )

overridevirtual

Implements BaseRender.

Definition at line 97 of file render_types.cc.

References tbh, and test_break_cb.

Referenced by do_render_compositor(), do_render_full_pipeline(), FRS_do_stroke_rendering(), prepare(), RE_engine_end_result(), and RE_engine_test_break().

Member Data Documentation

◆ blender_gpu_context

void* Render::blender_gpu_context = nullptr

Definition at line 256 of file render_types.h.

Referenced by RE_blender_gpu_context_ensure(), RE_blender_gpu_context_free(), and RE_system_gpu_context_free().

◆ camera_override

struct Object* Render::camera_override = nullptr

Definition at line 206 of file render_types.h.

Referenced by RE_engine_render(), RE_GetCamera(), RE_SetOverrideCamera(), and render_init_from_main().

◆ clip_end

float Render::clip_end = 0.0f

Definition at line 199 of file render_types.h.

Referenced by RE_GetCameraWindowWithOverscan(), RE_SetCamera(), and blender::eevee::Camera::sync().

◆ clip_start

float Render::clip_start = 0.0f

Definition at line 198 of file render_types.h.

Referenced by RE_GetCameraWindowWithOverscan(), RE_SetCamera(), and blender::eevee::Camera::sync().

◆ compositor

blender::render::Compositor* Render::compositor = nullptr

Definition at line 217 of file render_types.h.

Referenced by compositor_execute(), compositor_free(), and re_gpu_texture_caches_free().

◆ compositor_mutex

blender::Mutex Render::compositor_mutex

Definition at line 218 of file render_types.h.

Referenced by compositor_execute(), and compositor_free().

◆ current_scene_update_cb

void(* Render::current_scene_update_cb) (void *handle, struct Scene *scene) = nullptr

Definition at line 227 of file render_types.h.

Referenced by current_scene_update(), do_render_compositor_scene(), do_render_full_pipeline(), RE_current_scene_update_cb(), and RE_InitRenderCB().

◆ dch

void* Render::dch = nullptr

Definition at line 224 of file render_types.h.

Referenced by display_clear(), RE_display_clear_cb(), and RE_InitRenderCB().

◆ dih

void* Render::dih = nullptr

Definition at line 222 of file render_types.h.

Referenced by display_init(), RE_display_init_cb(), and RE_InitRenderCB().

◆ display_clear_cb

void(* Render::display_clear_cb) (void *handle, RenderResult *rr) = nullptr

Definition at line 223 of file render_types.h.

Referenced by display_clear(), RE_display_clear_cb(), and RE_InitRenderCB().

◆ display_init_cb

void(* Render::display_init_cb) (void *handle, RenderResult *rr) = nullptr

Definition at line 221 of file render_types.h.

Referenced by display_init(), RE_display_init_cb(), and RE_InitRenderCB().

◆ display_update_cb

void(* Render::display_update_cb) (void *handle, RenderResult *rr, rcti *rect) = nullptr

Definition at line 225 of file render_types.h.

Referenced by display_update(), do_render_compositor_scene(), RE_display_update_cb(), and RE_InitRenderCB().

◆ disprect

rcti Render::disprect = {0, 0, 0, 0}

Definition at line 188 of file render_types.h.

Referenced by Freestyle::BlenderStrokeRenderer::BlenderStrokeRenderer(), do_render_compositor(), do_render_compositor_scene(), engine_render_create_result(), init_view(), RE_AcquireResultImage(), RE_AcquireResultImageViews(), RE_engine_begin_result(), RE_GetViewPlane(), re_init_resolution(), render_init_from_main(), render_result_disprect_to_full_resolution(), render_result_new(), and render_result_uncrop().

◆ dlh

void* Render::dlh = nullptr

Definition at line 236 of file render_types.h.

Referenced by draw_lock(), draw_unlock(), RE_draw_lock_cb(), and RE_InitRenderCB().

◆ draw_lock_cb

void(* Render::draw_lock_cb) (void *handle, bool lock) = nullptr

Definition at line 235 of file render_types.h.

Referenced by draw_lock(), draw_unlock(), RE_draw_lock_cb(), and RE_InitRenderCB().

◆ duh

void* Render::duh = nullptr

Definition at line 226 of file render_types.h.

Referenced by display_update(), do_render_compositor_scene(), RE_display_update_cb(), and RE_InitRenderCB().

◆ flag

short Render::flag = 0

Definition at line 174 of file render_types.h.

Referenced by do_render_compositor(), RE_engine_render(), RE_RenderAnim(), RE_RenderFrame(), and render_init_from_main().

◆ fullresult

ListBase Render::fullresult = {nullptr, nullptr}

A list of #RenderResults, for full-samples.

Definition at line 180 of file render_types.h.

◆ i

RenderStats Render::i = {}

Definition at line 243 of file render_types.h.

Referenced by do_render_compositor(), do_render_full_pipeline(), do_render_sequencer(), do_write_image_or_movie(), FRS_do_stroke_rendering(), prepare(), RE_bake_engine(), RE_engine_render(), RE_engine_update_memory_stats(), RE_engine_update_stats(), RE_GetStats(), RE_InitState(), and render_compositor_stats().

◆ main

◆ movie_writers

blender::Vector<MovieWriter *> Render::movie_writers

Definition at line 251 of file render_types.h.

Referenced by do_write_image_or_movie(), re_movie_free_all(), and RE_RenderAnim().

◆ name

char Render::name[RE_MAXNAME] = ""

Definition at line 171 of file render_types.h.

Referenced by RE_FreeUnusedGPUResources(), RE_GetRender(), RE_NewInteractiveCompositorRender(), RE_NewRender(), and renderresult_stampinfo().

◆ ok

bool Render::ok = false

Definition at line 175 of file render_types.h.

Referenced by RE_InitState(), and render_init_from_main().

◆ pipeline_depsgraph

struct Depsgraph* Render::pipeline_depsgraph = nullptr

Definition at line 212 of file render_types.h.

Referenced by do_render_full_pipeline(), do_render_sequencer(), RE_RenderAnim(), render_init_depsgraph(), render_pipeline_free(), render_update_depsgraph(), and renderresult_stampinfo().

◆ pipeline_scene_eval

Scene* Render::pipeline_scene_eval = nullptr

Definition at line 213 of file render_types.h.

Referenced by do_render_compositor(), do_render_sequencer(), possibly_using_gpu_compositor(), RE_RenderAnim(), render_init_depsgraph(), and render_pipeline_free().

◆ prepare_viewlayer_cb

bool(* Render::prepare_viewlayer_cb) (void *handle, struct ViewLayer *vl, struct Depsgraph *depsgraph)

Definition at line 240 of file render_types.h.

Referenced by prepare_viewlayer(), RE_InitRenderCB(), and RE_prepare_viewlayer_cb().

◆ prepare_vl_handle

void* Render::prepare_vl_handle

Definition at line 241 of file render_types.h.

Referenced by prepare_viewlayer(), and RE_prepare_viewlayer_cb().

◆ prh

void* Render::prh = nullptr

Definition at line 233 of file render_types.h.

Referenced by do_render_compositor(), progress(), RE_InitRenderCB(), and RE_progress_cb().

◆ progress_cb

void(* Render::progress_cb) (void *handle, float i) = nullptr

Definition at line 232 of file render_types.h.

Referenced by do_render_compositor(), progress(), RE_InitRenderCB(), and RE_progress_cb().

◆ pushedresult

RenderResult* Render::pushedresult = nullptr

Definition at line 178 of file render_types.h.

Referenced by RE_FreeAllRenderResults(), render_result_single_layer_begin(), render_result_single_layer_end(), and ~Render().

◆ r

RenderData Render::r = {}

Definition at line 204 of file render_types.h.

Referenced by Freestyle::BlenderStrokeRenderer::BlenderStrokeRenderer(), do_render_compositor(), do_render_compositor_scene(), do_render_full_pipeline(), do_render_sequencer(), do_write_image_or_movie(), engine_depsgraph_init(), engine_keep_depsgraph(), engine_render_create_result(), get_videos_dimensions(), init_view(), possibly_using_gpu_compositor(), RE_bake_engine(), RE_bake_engine_set_engine_parameters(), RE_bake_has_engine(), RE_engine_end_result(), RE_engine_get_camera_model_matrix(), RE_engine_get_camera_shift_x(), RE_engine_get_render_data(), RE_engine_get_spherical_stereo(), RE_engine_render(), RE_engine_use_persistent_data(), RE_GetCameraModelMatrix(), RE_GetViewPlane(), RE_HasSingleLayer(), re_init_resolution(), RE_init_threadcount(), RE_InitState(), RE_RenderAnim(), RE_ResultGet32(), RE_SetCamera(), render_callback_exec_id(), render_callback_exec_string(), render_result_from_bake(), render_result_new(), render_result_uncrop(), and ~Render().

◆ rectx

int Render::rectx = 0

Definition at line 192 of file render_types.h.

Referenced by Freestyle::BlenderStrokeRenderer::BlenderStrokeRenderer(), FRS_composite_result(), get_videos_dimensions(), re_init_resolution(), RE_InitState(), RE_ResultGet32(), render_result_disprect_to_full_resolution(), and render_result_uncrop().

◆ recty

int Render::recty = 0

Definition at line 192 of file render_types.h.

Referenced by Freestyle::BlenderStrokeRenderer::BlenderStrokeRenderer(), FRS_composite_result(), get_videos_dimensions(), re_init_resolution(), RE_InitState(), RE_ResultGet32(), render_result_disprect_to_full_resolution(), and render_result_uncrop().

◆ reports

struct ReportList* Render::reports = nullptr

Optional report list which may be null (borrowed memory). Callers to rendering functions are responsible for setting can clearing, see: RE_SetReports.

Definition at line 249 of file render_types.h.

Referenced by do_render_engine(), do_write_image_or_movie(), RE_bake_engine(), RE_engine_render(), RE_engine_report(), RE_InitState(), RE_RenderAnim(), RE_RenderFrame(), and RE_SetReports().

◆ result_has_gpu_texture_caches

bool Render::result_has_gpu_texture_caches = false

Definition at line 182 of file render_types.h.

Referenced by RE_ClearResult(), RE_FreeAllRenderResults(), re_gpu_texture_caches_free(), and RE_pass_ensure_gpu_texture_cache().

◆ scene

Scene* Render::scene = nullptr

Definition at line 203 of file render_types.h.

Referenced by Freestyle::BlenderStrokeRenderer::BlenderStrokeRenderer(), compositor_execute(), current_scene_update(), do_render_compositor(), do_render_compositor_scene(), do_render_compositor_scenes(), do_render_engine(), do_render_full_pipeline(), do_render_sequencer(), engine_depsgraph_init(), engine_render_create_result(), engine_render_view_layer(), FRS_do_stroke_rendering(), init_view(), Freestyle::Controller::LoadMesh(), RE_bake_engine(), RE_bake_engine_set_engine_parameters(), RE_engine_frame_set(), RE_engine_render(), RE_GetCamera(), RE_GetScene(), RE_PreviewRender(), RE_ReadRenderResult(), RE_RenderAnim(), RE_ResultGet32(), RE_SetScene(), render_init_depsgraph(), render_init_from_main(), render_result_exr_file_cache_read(), render_result_exr_file_cache_write(), render_result_single_layer_end(), render_update_depsgraph(), and renderresult_stampinfo().

◆ sdh

void* Render::sdh = nullptr

Definition at line 231 of file render_types.h.

Referenced by do_render_compositor_scene(), RE_InitRenderCB(), RE_stats_draw_cb(), and stats_draw().

◆ single_view_layer

char Render::single_view_layer[MAX_NAME] = ""

Definition at line 205 of file render_types.h.

Referenced by RE_InitState(), render_get_single_layer(), render_result_new(), and render_result_single_layer_end().

◆ stats_draw_cb

void(* Render::stats_draw_cb) (void *handle, RenderStats *ri) = nullptr

Definition at line 230 of file render_types.h.

Referenced by do_render_compositor_scene(), RE_InitRenderCB(), RE_stats_draw_cb(), and stats_draw().

◆ suh

void* Render::suh = nullptr

Definition at line 228 of file render_types.h.

Referenced by current_scene_update(), do_render_compositor_scene(), do_render_full_pipeline(), and RE_current_scene_update_cb().

◆ system_gpu_context

void* Render::system_gpu_context = nullptr

Definition at line 255 of file render_types.h.

Referenced by RE_blender_gpu_context_ensure(), RE_blender_gpu_context_free(), RE_system_gpu_context_ensure(), RE_system_gpu_context_free(), and RE_system_gpu_context_get().

◆ tbh

void* Render::tbh = nullptr

Definition at line 238 of file render_types.h.

Referenced by do_render_compositor(), do_render_compositor_scene(), RE_InitRenderCB(), RE_RenderAnim(), RE_test_break_cb(), and test_break().

◆ test_break_cb

bool(* Render::test_break_cb) (void *handle) = nullptr

Definition at line 237 of file render_types.h.

Referenced by do_render_compositor(), do_render_compositor_scene(), RE_InitRenderCB(), RE_RenderAnim(), RE_test_break_cb(), and test_break().

◆ tile_highlight

blender::render::TilesHighlight Render::tile_highlight

Definition at line 208 of file render_types.h.

Referenced by get_tile_highlight().

◆ viewname

char Render::viewname[MAX_NAME] = ""

Definition at line 252 of file render_types.h.

Referenced by FRS_composite_result(), RE_engine_get_camera_model_matrix(), RE_engine_get_camera_shift_x(), RE_GetActiveRenderView(), RE_GetCamera(), RE_GetCameraModelMatrix(), RE_ResultGet32(), RE_SetActiveRenderView(), RE_SetCamera(), and render_init_from_main().

◆ viewplane

rctf Render::viewplane = {0, 0, 0, 0}

Definition at line 189 of file render_types.h.

Referenced by RE_GetCameraWindowWithOverscan(), RE_GetViewPlane(), RE_SetCamera(), and blender::eevee::Camera::sync().

◆ winmat

float Render::winmat[4][4] = {{0}}

Definition at line 195 of file render_types.h.

Referenced by RE_GetCameraWindow(), RE_GetCameraWindowWithOverscan(), and RE_SetCamera().

◆ winx

int Render::winx = 0

Window size, display rect, viewplane.

Note: Buffer width and height with percentage applied without border & crop. convert to long before multiplying together to avoid overflow.

Definition at line 187 of file render_types.h.

Referenced by Freestyle::BlenderStrokeRenderer::BlenderStrokeRenderer(), do_render_compositor_scene(), do_render_sequencer(), get_videos_dimensions(), init_view(), RE_bake_engine(), RE_engine_render(), re_init_resolution(), RE_SetCamera(), render_result_disprect_to_full_resolution(), and render_result_new().

◆ winy

int Render::winy = 0

Definition at line 187 of file render_types.h.

Referenced by Freestyle::BlenderStrokeRenderer::BlenderStrokeRenderer(), do_render_compositor_scene(), do_render_sequencer(), get_videos_dimensions(), init_view(), RE_bake_engine(), RE_engine_render(), re_init_resolution(), RE_SetCamera(), render_result_disprect_to_full_resolution(), and render_result_new().

The documentation for this struct was generated from the following files:

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Render()

◆ ~Render()

Member Function Documentation

◆ compositor_execute()

◆ compositor_free()

◆ current_scene_update()

◆ display_clear()

◆ display_init()

◆ display_update()

◆ draw_lock()

◆ draw_unlock()

◆ get_tile_highlight()

◆ prepare_viewlayer()

◆ progress()

◆ stats_draw()

◆ test_break()

Member Data Documentation

◆ blender_gpu_context

◆ camera_override

◆ clip_end

◆ clip_start

◆ compositor

◆ compositor_mutex

◆ current_scene_update_cb

◆ dch

◆ dih

◆ display_clear_cb

◆ display_init_cb

◆ display_update_cb

◆ disprect

◆ dlh

◆ draw_lock_cb

◆ duh

◆ flag

◆ fullresult

◆ i

◆ main

◆ movie_writers

◆ name

◆ ok

◆ pipeline_depsgraph

◆ pipeline_scene_eval

◆ prepare_viewlayer_cb

◆ prepare_vl_handle

◆ prh

◆ progress_cb

◆ pushedresult

◆ r

◆ rectx

◆ recty

◆ reports

◆ result_has_gpu_texture_caches

◆ scene

◆ sdh

◆ single_view_layer

◆ stats_draw_cb

◆ suh

◆ system_gpu_context

◆ tbh

◆ test_break_cb

◆ tile_highlight

◆ viewname

◆ viewplane

◆ winmat

◆ winx

◆ winy