Overall context of the compositor. More...

#include <COM_CompositorContext.h>

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

void	setRendering (bool rendering)
	set the rendering field of the context More...

bool	isRendering () const
	get the rendering field of the context More...

void	setRenderData (RenderData *rd)
	set the scene of the context More...

void	setbNodeTree (bNodeTree *bnodetree)
	set the bnodetree of the context More...

const bNodeTree *	getbNodeTree () const
	get the bnodetree of the context More...

const RenderData *	getRenderData () const
	get the scene of the context More...

void	setScene (Scene *scene)

Scene *	getScene () const

void	setPreviewHash (bNodeInstanceHash *previews)
	set the preview image hash table More...

bNodeInstanceHash *	getPreviewHash () const
	get the preview image hash table More...

void	setViewSettings (const ColorManagedViewSettings *viewSettings)
	set view settings of color color management More...

const ColorManagedViewSettings *	getViewSettings () const
	get view settings of color color management More...

void	setDisplaySettings (const ColorManagedDisplaySettings *displaySettings)
	set display settings of color color management More...

const ColorManagedDisplaySettings *	getDisplaySettings () const
	get display settings of color color management More...

void	setQuality (eCompositorQuality quality)
	set the quality More...

eCompositorQuality	getQuality () const
	get the quality More...

int	getFramenumber () const
	get the current frame-number of the scene in this context More...

bool	getHasActiveOpenCLDevices () const
	has this system active openclDevices? More...

void	setHasActiveOpenCLDevices (bool hasAvtiveOpenCLDevices)
	set has this system active openclDevices? More...

const char *	getViewName () const
	get the active rendering view More...

void	setViewName (const char *viewName)
	set the active rendering view More...

int	getChunksize () const

void	setFastCalculation (bool fastCalculation)

bool	isFastCalculation () const

bool	isGroupnodeBufferEnabled () const

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

Detailed Description

Overall context of the compositor.

Definition at line 37 of file COM_CompositorContext.h.

Constructor & Destructor Documentation

◆ CompositorContext()

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

constructor initializes the context with default values.

Definition at line 27 of file COM_CompositorContext.cc.

References blender::compositor::High.

Member Function Documentation

◆ getbNodeTree()

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

inline

get the bnodetree of the context

Definition at line 135 of file COM_CompositorContext.h.

Referenced by blender::compositor::NodeOperationBuilder::add_input_buffers(), blender::compositor::NodeOperationBuilder::add_output_buffers(), blender::compositor::ExecutionSystem::execute(), getChunksize(), isGroupnodeBufferEnabled(), and blender::compositor::NodeOperationBuilder::registerViewer().

◆ getChunksize()

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

inline

Definition at line 258 of file COM_CompositorContext.h.

References bNodeTree::chunksize, and getbNodeTree().

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

◆ getDisplaySettings()

const ColorManagedDisplaySettings* blender::compositor::CompositorContext::getDisplaySettings ( ) const

inline

get display settings of color color management

Definition at line 200 of file COM_CompositorContext.h.

◆ getFramenumber()

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

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

Definition at line 38 of file COM_CompositorContext.cc.

References BLI_assert, and RenderData::cfra.

◆ getHasActiveOpenCLDevices()

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

inline

has this system active openclDevices?

Definition at line 229 of file COM_CompositorContext.h.

◆ getPreviewHash()

bNodeInstanceHash* blender::compositor::CompositorContext::getPreviewHash ( ) const

inline

get the preview image hash table

Definition at line 168 of file COM_CompositorContext.h.

◆ getQuality()

eCompositorQuality blender::compositor::CompositorContext::getQuality ( ) const

inline

get the quality

Definition at line 216 of file COM_CompositorContext.h.

◆ getRenderData()

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

inline

get the scene of the context

Definition at line 143 of file COM_CompositorContext.h.

◆ getRenderPercentageAsFactor()

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

inline

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

Definition at line 280 of file COM_CompositorContext.h.

References RenderData::size.

◆ getScene()

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

inline

Definition at line 152 of file COM_CompositorContext.h.

◆ getViewName()

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

inline

get the active rendering view

Definition at line 245 of file COM_CompositorContext.h.

◆ getViewSettings()

const ColorManagedViewSettings* blender::compositor::CompositorContext::getViewSettings ( ) const

inline

get view settings of color color management

Definition at line 184 of file COM_CompositorContext.h.

◆ isFastCalculation()

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

inline

Definition at line 267 of file COM_CompositorContext.h.

◆ isGroupnodeBufferEnabled()

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

inline

Definition at line 271 of file COM_CompositorContext.h.

References getbNodeTree(), and NTREE_COM_GROUPNODE_BUFFER.

◆ isRendering()

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

inline

get the rendering field of the context

Definition at line 111 of file COM_CompositorContext.h.

Referenced by blender::compositor::NodeOperationBuilder::determineResolutions(), blender::compositor::NodeOperationBuilder::group_operations(), and blender::compositor::NodeOperationBuilder::prune_operations().

◆ setbNodeTree()

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

inline

set the bnodetree of the context

Definition at line 127 of file COM_CompositorContext.h.

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

◆ setDisplaySettings()

void blender::compositor::CompositorContext::setDisplaySettings ( const ColorManagedDisplaySettings * displaySettings )

inline

set display settings of color color management

Definition at line 192 of file COM_CompositorContext.h.

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

◆ setFastCalculation()

void blender::compositor::CompositorContext::setFastCalculation ( bool fastCalculation )

inline

Definition at line 263 of file COM_CompositorContext.h.

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

◆ setHasActiveOpenCLDevices()

void blender::compositor::CompositorContext::setHasActiveOpenCLDevices ( bool hasAvtiveOpenCLDevices )

inline

set has this system active openclDevices?

Definition at line 237 of file COM_CompositorContext.h.

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

◆ setPreviewHash()

void blender::compositor::CompositorContext::setPreviewHash ( bNodeInstanceHash * previews )

inline

set the preview image hash table

Definition at line 160 of file COM_CompositorContext.h.

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

◆ setQuality()

void blender::compositor::CompositorContext::setQuality ( eCompositorQuality quality )

inline

set the quality

Definition at line 208 of file COM_CompositorContext.h.

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

◆ setRenderData()

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

inline

set the scene of the context

Definition at line 119 of file COM_CompositorContext.h.

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

◆ setRendering()

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

inline

set the rendering field of the context

Definition at line 103 of file COM_CompositorContext.h.

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

◆ setScene()

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

inline

Definition at line 148 of file COM_CompositorContext.h.

References scene.

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

◆ setViewName()

void blender::compositor::CompositorContext::setViewName ( const char * viewName )

inline

set the active rendering view

Definition at line 253 of file COM_CompositorContext.h.

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

◆ setViewSettings()

void blender::compositor::CompositorContext::setViewSettings ( const ColorManagedViewSettings * viewSettings )

inline

set view settings of color color management

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

◆ getbNodeTree()

◆ getChunksize()

◆ getDisplaySettings()

◆ getFramenumber()

◆ getHasActiveOpenCLDevices()

◆ getPreviewHash()

◆ getQuality()

◆ getRenderData()

◆ getRenderPercentageAsFactor()

◆ getScene()

◆ getViewName()

◆ getViewSettings()

◆ isFastCalculation()

◆ isGroupnodeBufferEnabled()

◆ isRendering()

◆ setbNodeTree()

◆ setDisplaySettings()

◆ setFastCalculation()

◆ setHasActiveOpenCLDevices()

◆ setPreviewHash()

◆ setQuality()

◆ setRenderData()

◆ setRendering()

◆ setScene()

◆ setViewName()

◆ setViewSettings()