Blender  V3.3
Public Member Functions | List of all members
blender::compositor::CompositorContext Class Reference

Overall context of the compositor. More...

#include <COM_CompositorContext.h>

Public Member Functions

 CompositorContext ()
 constructor initializes the context with default values. More...
 
void set_rendering (bool rendering)
 set the rendering field of the context More...
 
bool is_rendering () const
 get the rendering field of the context More...
 
void set_render_data (RenderData *rd)
 set the scene of the context More...
 
void set_bnodetree (bNodeTree *bnodetree)
 set the bnodetree of the context More...
 
const bNodeTreeget_bnodetree () const
 get the bnodetree of the context More...
 
const RenderDataget_render_data () const
 get the scene of the context More...
 
void set_scene (Scene *scene)
 
Sceneget_scene () const
 
void set_preview_hash (bNodeInstanceHash *previews)
 set the preview image hash table More...
 
bNodeInstanceHashget_preview_hash () const
 get the preview image hash table More...
 
void set_quality (eCompositorQuality quality)
 set the quality More...
 
eCompositorQuality get_quality () const
 get the quality More...
 
int get_framenumber () const
 get the current frame-number of the scene in this context More...
 
bool get_has_active_opencl_devices () const
 has this system active opencl_devices? More...
 
void setHasActiveOpenCLDevices (bool hasAvtiveOpenCLDevices)
 set has this system active opencl_devices? More...
 
bool has_explicit_view () const
 
const char * get_view_name () const
 get the active rendering view More...
 
void set_view_name (const char *view_name)
 set the active rendering view More...
 
int get_chunksize () const
 
void set_fast_calculation (bool fast_calculation)
 
bool is_fast_calculation () const
 
bool is_groupnode_buffer_enabled () const
 
float get_render_percentage_as_factor () const
 Get the render percentage as a factor. The compositor uses a factor i.o. a percentage. More...
 
Size2f get_render_size () const
 
eExecutionModel get_execution_model () const
 

Detailed Description

Overall context of the compositor.

Definition at line 19 of file COM_CompositorContext.h.

Constructor & Destructor Documentation

◆ CompositorContext()

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

constructor initializes the context with default values.

Definition at line 8 of file COM_CompositorContext.cc.

References blender::compositor::High.

Member Function Documentation

◆ get_bnodetree()

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

◆ get_chunksize()

int blender::compositor::CompositorContext::get_chunksize ( ) const
inline

◆ get_execution_model()

eExecutionModel blender::compositor::CompositorContext::get_execution_model ( ) const

◆ get_framenumber()

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

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

Definition at line 18 of file COM_CompositorContext.cc.

References BLI_assert, and RenderData::cfra.

◆ get_has_active_opencl_devices()

bool blender::compositor::CompositorContext::get_has_active_opencl_devices ( ) const
inline

has this system active opencl_devices?

Definition at line 175 of file COM_CompositorContext.h.

◆ get_preview_hash()

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

get the preview image hash table

Definition at line 146 of file COM_CompositorContext.h.

◆ get_quality()

eCompositorQuality blender::compositor::CompositorContext::get_quality ( ) const
inline

get the quality

Definition at line 162 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 121 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 232 of file COM_CompositorContext.h.

References RenderData::size.

Referenced by get_render_size().

◆ get_render_size()

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

◆ get_scene()

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

Definition at line 130 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 197 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 189 of file COM_CompositorContext.h.

◆ is_fast_calculation()

bool blender::compositor::CompositorContext::is_fast_calculation ( ) const
inline

◆ is_groupnode_buffer_enabled()

bool blender::compositor::CompositorContext::is_groupnode_buffer_enabled ( ) const
inline

Definition at line 223 of file COM_CompositorContext.h.

References get_bnodetree(), and NTREE_COM_GROUPNODE_BUFFER.

◆ is_rendering()

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

◆ set_bnodetree()

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

set the bnodetree of the context

Definition at line 105 of file COM_CompositorContext.h.

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

◆ set_fast_calculation()

void blender::compositor::CompositorContext::set_fast_calculation ( bool  fast_calculation)
inline

◆ set_preview_hash()

void blender::compositor::CompositorContext::set_preview_hash ( bNodeInstanceHash previews)
inline

set the preview image hash table

Definition at line 138 of file COM_CompositorContext.h.

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

◆ set_quality()

void blender::compositor::CompositorContext::set_quality ( eCompositorQuality  quality)
inline

set the quality

Definition at line 154 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 97 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 81 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 126 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 205 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 opencl_devices?

Definition at line 183 of file COM_CompositorContext.h.

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


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