#include <render_types.h>

Inherits BaseRender.

Public Member Functions
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
Render
	Render ()
	~Render () override
bool	prepare_viewlayer (struct ViewLayer view_layer, struct Depsgraph depsgraph) override
Public Member Functions inherited from BaseRender
	BaseRender ()=default
virtual	~BaseRender ()

Public Attributes
const void *	owner = nullptr
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
bool(*	prepare_viewlayer_cb )(void handle, struct ViewLayer vl, struct Depsgraph *depsgraph) = nullptr
void *	prepare_vl_handle = nullptr
RenderStats	i = {}
struct ReportList *	reports = nullptr
blender::Vector< MovieWriter * >	movie_writers
char	viewname [MAX_NAME] = ""
Public Attributes inherited from BaseRender
RenderResult *	result = nullptr
ThreadRWMutex	resultmutex = BLI_RWLOCK_INITIALIZER
struct RenderEngine *	engine = nullptr
ThreadMutex	engine_draw_mutex = BLI_MUTEX_INITIALIZER
std::shared_ptr< RenderDisplay >	display
bool	display_shared = false

Detailed Description

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

Definition at line 115 of file render_types.h.

Constructor & Destructor Documentation

◆ Render()

Render::Render ( )

Definition at line 45 of file render_types.cc.

References BaseRender::display.

◆ ~Render()

Render::~Render ( )

override

Definition at line 50 of file render_types.cc.

References BKE_curvemapping_free_data(), pushedresult, r, RE_compositor_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 663 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 693 of file render/intern/compositor.cc.

References compositor, compositor_mutex, and lock.

Referenced by RE_compositor_free().

◆ get_tile_highlight()

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

inlineoverridevirtual

Implements BaseRender.

Definition at line 119 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 59 of file render_types.cc.

References depsgraph, prepare_viewlayer_cb, and prepare_vl_handle.

Referenced by engine_render_view_layer().

Member Data Documentation

◆ camera_override

struct Object* Render::camera_override = nullptr

Definition at line 171 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 164 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 163 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 182 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 183 of file render_types.h.

Referenced by compositor_execute(), and compositor_free().

◆ disprect

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

Definition at line 153 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().

◆ flag

short Render::flag = 0

Definition at line 139 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 145 of file render_types.h.

◆ i

RenderStats Render::i = {}

Definition at line 191 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 199 of file render_types.h.

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

◆ ok

bool Render::ok = false

Definition at line 140 of file render_types.h.

Referenced by RE_InitState(), and render_init_from_main().

◆ owner

const void* Render::owner = nullptr

Definition at line 136 of file render_types.h.

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

◆ pipeline_depsgraph

struct Depsgraph* Render::pipeline_depsgraph = nullptr

Definition at line 177 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 178 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) = nullptr

Definition at line 186 of file render_types.h.

Referenced by prepare_viewlayer(), and RE_prepare_viewlayer_cb().

◆ prepare_vl_handle

void* Render::prepare_vl_handle = nullptr

Definition at line 189 of file render_types.h.

Referenced by prepare_viewlayer(), and RE_prepare_viewlayer_cb().

◆ pushedresult

RenderResult* Render::pushedresult = nullptr

Definition at line 143 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 169 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 157 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 157 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 197 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 147 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 168 of file render_types.h.

Referenced by Freestyle::BlenderStrokeRenderer::BlenderStrokeRenderer(), compositor_execute(), 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().

◆ single_view_layer

char Render::single_view_layer[MAX_NAME] = ""

Definition at line 170 of file render_types.h.

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

◆ tile_highlight

blender::render::TilesHighlight Render::tile_highlight

Definition at line 173 of file render_types.h.

Referenced by get_tile_highlight().

◆ viewname

char Render::viewname[MAX_NAME] = ""

Definition at line 200 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 154 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 160 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 152 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 152 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()

◆ get_tile_highlight()

◆ prepare_viewlayer()

Member Data Documentation

◆ camera_override

◆ clip_end

◆ clip_start

◆ compositor

◆ compositor_mutex

◆ disprect

◆ flag

◆ fullresult

◆ i

◆ main

◆ movie_writers

◆ ok

◆ owner

◆ pipeline_depsgraph

◆ pipeline_scene_eval

◆ prepare_viewlayer_cb

◆ prepare_vl_handle

◆ pushedresult

◆ r

◆ rectx

◆ recty

◆ reports

◆ result_has_gpu_texture_caches

◆ scene

◆ single_view_layer

◆ tile_highlight

◆ viewname

◆ viewplane

◆ winmat

◆ winx

◆ winy