BaseRender Struct Reference

#include <render_types.h>

Inherited by Render, and ViewRender.

Public Member Functions
	BaseRender ()=default
virtual blender::render::TilesHighlight *	get_tile_highlight ()=0
virtual 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)=0
virtual void	compositor_free ()=0
virtual bool	prepare_viewlayer (struct ViewLayer *view_layer, struct Depsgraph *depsgraph)=0
Render
virtual	~BaseRender ()

Public Attributes
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

Definition at line 42 of file render_types.h.

Constructor & Destructor Documentation

BaseRender()

BaseRender::BaseRender ( )

default

~BaseRender()

BaseRender::~BaseRender ( )

virtual

Definition at line 30 of file render_types.cc.

References BLI_mutex_end(), BLI_rw_mutex_end(), display, engine, engine_draw_mutex, RE_engine_free(), render_result_free(), result, and resultmutex.

Member Function Documentation

compositor_execute()

virtual void BaseRender::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 )

pure virtual

Implemented in Render, and ViewRender.

compositor_free()

virtual void BaseRender::compositor_free ( )

pure virtual

Implemented in Render, and ViewRender.

get_tile_highlight()

virtual blender::render::TilesHighlight * BaseRender::get_tile_highlight ( )

pure virtual

Implemented in Render, and ViewRender.

prepare_viewlayer()

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

pure virtual

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,

Implemented in Render, and ViewRender.

References depsgraph.

Member Data Documentation

display

std::shared_ptr<RenderDisplay> BaseRender::display

GPU context and callbacks. This can be shared for recursive compositor and sequencer renders that we want to display in the same place.

Definition at line 86 of file render_types.h.

Referenced by do_render_compositor(), do_render_compositor_scenes(), do_render_engine(), do_render_full_pipeline(), do_render_sequencer(), engine_render_view_layer(), FRS_do_stroke_rendering(), prepare(), RE_blender_gpu_context_ensure(), RE_current_scene_update_cb(), RE_display_ensure_gpu_context(), RE_display_init(), RE_display_share(), RE_display_update_cb(), RE_draw_lock_cb(), RE_engine_end_result(), RE_engine_render(), RE_engine_test_break(), RE_engine_update_progress(), RE_engine_update_result(), RE_engine_update_stats(), RE_progress_cb(), RE_RenderAnim(), RE_stats_draw_cb(), RE_system_gpu_context_get(), RE_test_break_cb(), Render::Render(), render_compositor_stats(), render_result_uncrop(), and ~BaseRender().

display_shared

bool BaseRender::display_shared = false

Definition at line 87 of file render_types.h.

Referenced by RE_display_init(), RE_display_share(), and RE_FreeUnusedGPUResources().

engine

struct RenderEngine* BaseRender::engine = nullptr

Definition at line 77 of file render_types.h.

Referenced by engine_render_create_result(), engine_render_view_layer(), RE_bake_engine(), RE_engine_draw_acquire(), RE_engine_end_result(), RE_engine_get(), RE_engine_is_external(), RE_engine_render(), re_free_persistent_data(), RE_FreeAllPersistentData(), RE_NewViewRender(), RE_PreviewRender(), RE_view_engine_get(), render_pipeline_free(), and ~BaseRender().

engine_draw_mutex

ThreadMutex BaseRender::engine_draw_mutex = BLI_MUTEX_INITIALIZER

Definition at line 80 of file render_types.h.

Referenced by engine_render_view_layer(), RE_engine_draw_acquire(), RE_engine_draw_release(), and ~BaseRender().

result

RenderResult* BaseRender::result = nullptr

Definition at line 69 of file render_types.h.

Referenced by do_render_compositor(), do_render_full_pipeline(), do_render_sequencer(), engine_render_view_layer(), FRS_composite_result(), prepare(), RE_AcquireResultImage(), RE_AcquireResultImageViews(), RE_AcquireResultRead(), RE_AcquireResultWrite(), RE_ClearResult(), RE_engine_add_pass(), RE_engine_begin_result(), RE_engine_end_result(), RE_engine_get_result(), RE_engine_render(), RE_engine_update_result(), re_ensure_passes_allocated_thread_safe(), RE_FreeAllRenderResults(), RE_InitState(), RE_SwapResult(), render_result_clone_passes(), render_result_exr_file_cache_read(), render_result_exr_file_cache_write(), render_result_single_layer_begin(), render_result_single_layer_end(), render_result_uncrop(), blender::draw::gpencil::Engine::render_to_image(), renderresult_set_passes_metadata(), renderresult_stampinfo(), and ~BaseRender().

resultmutex

ThreadRWMutex BaseRender::resultmutex = BLI_RWLOCK_INITIALIZER

Definition at line 74 of file render_types.h.

Referenced by do_render_compositor(), do_render_sequencer(), RE_AcquireResultImage(), RE_AcquireResultImageViews(), RE_AcquireResultRead(), RE_AcquireResultWrite(), RE_engine_render(), re_ensure_passes_allocated_thread_safe(), RE_InitState(), RE_ReadRenderResult(), RE_ReleaseResult(), RE_ReleaseResultImage(), RE_ReleaseResultImageViews(), render_init_from_main(), render_result_uncrop(), renderresult_set_passes_metadata(), and ~BaseRender().

---

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

• render_types.h
• render_types.cc