Overall context of the compositor. More...

#include <COM_CompositorContext.h>

Public Member Functions
	CompositorContext ()
	constructor initializes the context with default values.

void	set_rendering (bool rendering)
	set the rendering field of the context

bool	is_rendering () const
	get the rendering field of the context

void	set_render_data (RenderData *rd)
	set the scene of the context

void	set_bnodetree (bNodeTree *bnodetree)
	set the bnodetree of the context

const bNodeTree *	get_bnodetree () const
	get the bnodetree of the context

const RenderData *	get_render_data () const
	get the scene of the context

void	set_scene (Scene *scene)

Scene *	get_scene () const

void	set_preview_hash (bke::bNodeInstanceHash *previews)
	set the preview image hash table

bke::bNodeInstanceHash *	get_preview_hash () const
	get the preview image hash table

int	get_framenumber () const
	get the current frame-number of the scene in this context

bool	has_explicit_view () const

realtime_compositor::RenderContext *	get_render_context () const
	get the render context

void	set_render_context (realtime_compositor::RenderContext *render_context)
	set the render context

realtime_compositor::Profiler *	get_profiler () const
	get the profiler

void	set_profiler (realtime_compositor::Profiler *profiler)
	set the profiler

const char *	get_view_name () const
	get the active rendering view

void	set_view_name (const char *view_name)
	set the active rendering view

float	get_render_percentage_as_factor () const
	Get the render percentage as a factor. The compositor uses a factor i.o. a percentage.

Size2f	get_render_size () const

Detailed Description

Overall context of the compositor.

Definition at line 27 of file COM_CompositorContext.h.

Constructor & Destructor Documentation

◆ CompositorContext()

blender::compositor::CompositorContext::CompositorContext ( )

constructor initializes the context with default values.

Definition at line 9 of file COM_CompositorContext.cc.

Member Function Documentation

◆ get_bnodetree()

const bNodeTree * blender::compositor::CompositorContext::get_bnodetree ( ) const

inline

get the bnodetree of the context

Definition at line 116 of file COM_CompositorContext.h.

Referenced by blender::compositor::ExecutionSystem::execute(), blender::compositor::FullFrameExecutionModel::execute(), blender::compositor::ExecutionModel::ExecutionModel(), and blender::compositor::ExecutionSystem::is_breaked().

◆ get_framenumber()

int blender::compositor::CompositorContext::get_framenumber ( ) const

get the current frame-number of the scene in this context

Definition at line 16 of file COM_CompositorContext.cc.

References BLI_assert, and RenderData::cfra.

◆ get_preview_hash()

bke::bNodeInstanceHash * blender::compositor::CompositorContext::get_preview_hash ( ) const

inline

get the preview image hash table

Definition at line 149 of file COM_CompositorContext.h.

◆ get_profiler()

realtime_compositor::Profiler * blender::compositor::CompositorContext::get_profiler ( ) const

inline

get the profiler

Definition at line 184 of file COM_CompositorContext.h.

Referenced by blender::compositor::ExecutionSystem::execute().

◆ get_render_context()

realtime_compositor::RenderContext * blender::compositor::CompositorContext::get_render_context ( ) const

inline

get the render context

Definition at line 168 of file COM_CompositorContext.h.

◆ get_render_data()

const RenderData * blender::compositor::CompositorContext::get_render_data ( ) const

inline

get the scene of the context

Definition at line 124 of file COM_CompositorContext.h.

Referenced by blender::compositor::ExecutionModel::ExecutionModel(), and get_render_size().

◆ get_render_percentage_as_factor()

float blender::compositor::CompositorContext::get_render_percentage_as_factor ( ) const

inline

Get the render percentage as a factor. The compositor uses a factor i.o. a percentage.

Definition at line 217 of file COM_CompositorContext.h.

References RenderData::size.

Referenced by get_render_size().

◆ get_render_size()

Size2f blender::compositor::CompositorContext::get_render_size ( ) const

Definition at line 22 of file COM_CompositorContext.cc.

References get_render_data(), get_render_percentage_as_factor(), RenderData::xsch, and RenderData::ysch.

◆ get_scene()

Scene * blender::compositor::CompositorContext::get_scene ( ) const

inline

Definition at line 133 of file COM_CompositorContext.h.

◆ get_view_name()

const char * blender::compositor::CompositorContext::get_view_name ( ) const

inline

get the active rendering view

Definition at line 200 of file COM_CompositorContext.h.

◆ has_explicit_view()

bool blender::compositor::CompositorContext::has_explicit_view ( ) const

inline

Whether it has a view with a specific name and not the default one.

Definition at line 160 of file COM_CompositorContext.h.

◆ is_rendering()

bool blender::compositor::CompositorContext::is_rendering ( ) const

inline

get the rendering field of the context

Definition at line 92 of file COM_CompositorContext.h.

Referenced by blender::compositor::NodeOperationBuilder::determine_canvases(), blender::compositor::DebugInfo::graphviz_operation(), and blender::compositor::NodeOperationBuilder::prune_operations().

◆ set_bnodetree()

void blender::compositor::CompositorContext::set_bnodetree ( bNodeTree * bnodetree )

inline

set the bnodetree of the context

Definition at line 108 of file COM_CompositorContext.h.

Referenced by blender::compositor::ExecutionSystem::ExecutionSystem().

◆ set_preview_hash()

void blender::compositor::CompositorContext::set_preview_hash ( bke::bNodeInstanceHash * previews )

inline

set the preview image hash table

Definition at line 141 of file COM_CompositorContext.h.

Referenced by blender::compositor::ExecutionSystem::ExecutionSystem().

◆ set_profiler()

void blender::compositor::CompositorContext::set_profiler ( realtime_compositor::Profiler * profiler )

inline

set the profiler

Definition at line 192 of file COM_CompositorContext.h.

Referenced by blender::compositor::ExecutionSystem::ExecutionSystem().

◆ set_render_context()

void blender::compositor::CompositorContext::set_render_context ( realtime_compositor::RenderContext * render_context )

inline

set the render context

Definition at line 176 of file COM_CompositorContext.h.

Referenced by blender::compositor::ExecutionSystem::ExecutionSystem().

◆ set_render_data()

void blender::compositor::CompositorContext::set_render_data ( RenderData * rd )

inline

set the scene of the context

Definition at line 100 of file COM_CompositorContext.h.

Referenced by blender::compositor::ExecutionSystem::ExecutionSystem().

◆ set_rendering()

void blender::compositor::CompositorContext::set_rendering ( bool rendering )

inline

set the rendering field of the context

Definition at line 84 of file COM_CompositorContext.h.

Referenced by blender::compositor::ExecutionSystem::ExecutionSystem().

◆ set_scene()

void blender::compositor::CompositorContext::set_scene ( Scene * scene )

inline

Definition at line 129 of file COM_CompositorContext.h.

References scene.

Referenced by blender::compositor::ExecutionSystem::ExecutionSystem().

◆ set_view_name()

void blender::compositor::CompositorContext::set_view_name ( const char * view_name )

inline

set the active rendering view

Definition at line 208 of file COM_CompositorContext.h.

Referenced by blender::compositor::ExecutionSystem::ExecutionSystem().

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CompositorContext()

Member Function Documentation

◆ get_bnodetree()

◆ get_framenumber()

◆ get_preview_hash()

◆ get_profiler()

◆ get_render_context()

◆ get_render_data()

◆ get_render_percentage_as_factor()

◆ get_render_size()

◆ get_scene()

◆ get_view_name()

◆ has_explicit_view()

◆ is_rendering()

◆ set_bnodetree()

◆ set_preview_hash()

◆ set_profiler()

◆ set_render_context()

◆ set_render_data()

◆ set_rendering()

◆ set_scene()

◆ set_view_name()