BaseRender Struct Reference

#include <render_types.h>

Inherited by Render, and ViewRender.

Public Member Functions
	BaseRender ()=default
virtual	~BaseRender ()
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::realtime_compositor::RenderContext *render_context, blender::realtime_compositor::Profiler *profiler)=0
virtual void	compositor_free ()=0
virtual void	display_init (RenderResult *render_result)=0
virtual void	display_clear (RenderResult *render_result)=0
virtual void	display_update (RenderResult *render_result, rcti *rect)=0
virtual void	current_scene_update (struct Scene *scene)=0
virtual void	stats_draw (RenderStats *render_stats)=0
virtual void	progress (float progress)=0
virtual void	draw_lock ()=0
virtual void	draw_unlock ()=0
virtual bool	test_break ()=0
virtual bool	prepare_viewlayer (struct ViewLayer *view_layer, struct Depsgraph *depsgraph)=0

Public Attributes
RenderResult *	result = nullptr
ThreadRWMutex	resultmutex = BLI_RWLOCK_INITIALIZER
struct RenderEngine *	engine = nullptr
ThreadMutex	engine_draw_mutex = BLI_MUTEX_INITIALIZER

Detailed Description

Definition at line 39 of file render_types.h.

Constructor & Destructor Documentation

BaseRender()

BaseRender::BaseRender ( )

default

~BaseRender()

BaseRender::~BaseRender ( )

virtual

Definition at line 18 of file render_types.cc.

References BLI_mutex_end(), BLI_rw_mutex_end(), engine, engine_draw_mutex, RE_engine_free(), render_result_free(), 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::realtime_compositor::RenderContext * render_context, blender::realtime_compositor::Profiler * profiler )

pure virtual

Implemented in Render, and ViewRender.

compositor_free()

virtual void BaseRender::compositor_free ( )

pure virtual

Implemented in Render, and ViewRender.

current_scene_update()

virtual void BaseRender::current_scene_update ( struct Scene * scene )

pure virtual

Implemented in Render, and ViewRender.

display_clear()

virtual void BaseRender::display_clear ( RenderResult * render_result )

pure virtual

Implemented in Render, and ViewRender.

display_init()

virtual void BaseRender::display_init ( RenderResult * render_result )

pure virtual

Implemented in Render, and ViewRender.

display_update()

virtual void BaseRender::display_update ( RenderResult * render_result, rcti * rect )

pure virtual

Implemented in Render, and ViewRender.

draw_lock()

virtual void BaseRender::draw_lock ( )

pure virtual

Implemented in Render, and ViewRender.

draw_unlock()

virtual void BaseRender::draw_unlock ( )

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.

progress()

virtual void BaseRender::progress ( float progress )

pure virtual

Implemented in Render, and ViewRender.

stats_draw()

virtual void BaseRender::stats_draw ( RenderStats * render_stats )

pure virtual

Implemented in Render, and ViewRender.

test_break()

virtual bool BaseRender::test_break ( )

pure virtual

Implemented in Render, and ViewRender.

Member Data Documentation

engine

struct RenderEngine* BaseRender::engine = nullptr

Definition at line 89 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_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 92 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 81 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_InitState(), RE_SwapResult(), render_init_from_main(), 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(), renderresult_set_passes_metadata(), and renderresult_stampinfo().

resultmutex

ThreadRWMutex BaseRender::resultmutex = BLI_RWLOCK_INITIALIZER

Definition at line 86 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