blender::compositor::Context Class Reference

#include <COM_context.hh>

Inherited by blender::draw::compositor_engine::Context, blender::render::Context, and blender::seq::CompositorContext.

Public Member Functions
virtual const Scene &	get_scene () const =0
virtual const bNodeTree &	get_node_tree () const =0
virtual OutputTypes	needed_outputs () const =0
virtual Bounds< int2 >	get_compositing_region () const =0
virtual Result	get_output (Domain domain)=0
virtual Result	get_viewer_output (Domain domain, bool is_data, ResultPrecision precision)=0
virtual Result	get_input (StringRef name)=0
virtual bool	use_gpu () const =0
virtual Result	get_pass (const Scene *scene, int view_layer, const char *name)
virtual const RenderData &	get_render_data () const
virtual StringRef	get_view_name () const
virtual ResultPrecision	get_precision () const
virtual void	set_info_message (StringRef message) const
virtual bool	treat_viewer_as_compositor_output () const
virtual bool	use_context_bounds_for_input_output () const
virtual void	populate_meta_data_for_pass (const Scene *scene, int view_layer_id, const char *pass_name, MetaData &meta_data) const
virtual RenderContext *	render_context () const
virtual Profiler *	profiler () const
virtual void	evaluate_operation_post () const
virtual bool	is_canceled () const
void	reset ()
int2	get_compositing_region_size () const
bool	is_valid_compositing_region () const
float	get_render_percentage () const
int	get_frame_number () const
float	get_time () const
eCompositorDenoiseQaulity	get_denoise_quality () const
gpu::Shader *	get_shader (const char *info_name, ResultPrecision precision)
gpu::Shader *	get_shader (const char *info_name)
Result	create_result (ResultType type, ResultPrecision precision)
Result	create_result (ResultType type)
StaticCacheManager &	cache_manager ()

Detailed Description

Definition at line 44 of file COM_context.hh.

Member Function Documentation

cache_manager()

StaticCacheManager & blender::compositor::Context::cache_manager

(

)

Definition at line 139 of file compositor/intern/context.cc.

Referenced by blender::nodes::node_composite_image_cc::ImageOperation::compute_output(), blender::nodes::node_composite_bokehimage_cc::BokehImageOperation::execute(), blender::nodes::node_composite_defocus_cc::DefocusOperation::execute(), blender::nodes::node_composite_image_coordinates_cc::ImageCoordinatesOperation::execute(), blender::nodes::node_composite_keyingscreen_cc::KeyingScreenOperation::execute(), blender::nodes::node_composite_mask_cc::MaskOperation::execute(), blender::nodes::node_composite_moviedistortion_cc::MovieDistortionOperation::execute(), blender::nodes::node_composite_blur_cc::BlurOperation::execute_constant_size_cpu(), blender::nodes::node_composite_blur_cc::BlurOperation::execute_constant_size_gpu(), blender::nodes::node_composite_convert_color_space_cc::ConvertColorSpaceOperation::execute_gpu(), blender::nodes::node_composite_convert_to_display_cc::ConvertToDisplayOperation::execute_gpu(), blender::nodes::node_composite_cryptomatte_cc::CryptoMatteOperation::get_layers_from_image(), and get_shader().

create_result() [1/2]

Result blender::compositor::Context::create_result

(

ResultType

type

)

Definition at line 134 of file compositor/intern/context.cc.

References create_result(), and get_precision().

create_result() [2/2]

Result blender::compositor::Context::create_result	(	ResultType	type,
		ResultPrecision	precision )

Definition at line 129 of file compositor/intern/context.cc.

Referenced by blender::nodes::node_composite_keying_cc::KeyingOperation::compute_blurred_input(), blender::nodes::node_composite_glare_cc::GlareOperation::compute_glare(), blender::nodes::node_composite_inpaint_cc::InpaintOperation::compute_inpainting_boundary_cpu(), blender::nodes::node_composite_inpaint_cc::InpaintOperation::compute_inpainting_boundary_gpu(), blender::nodes::node_composite_zcombine_cc::ZCombineOperation::compute_mask_cpu(), blender::nodes::node_composite_zcombine_cc::ZCombineOperation::compute_mask_gpu(), blender::nodes::node_composite_base_cryptomatte_cc::BaseCryptoMatteOperation::compute_matte_cpu(), blender::nodes::node_composite_keying_cc::KeyingOperation::compute_matte_cpu(), blender::nodes::node_composite_base_cryptomatte_cc::BaseCryptoMatteOperation::compute_matte_gpu(), blender::nodes::node_composite_keying_cc::KeyingOperation::compute_matte_gpu(), blender::nodes::node_composite_cornerpin_cc::CornerPinOperation::compute_plane_mask_cpu(), blender::nodes::node_composite_planetrackdeform_cc::PlaneTrackDeformOperation::compute_plane_mask_cpu(), blender::nodes::node_composite_cornerpin_cc::CornerPinOperation::compute_plane_mask_gpu(), blender::nodes::node_composite_planetrackdeform_cc::PlaneTrackDeformOperation::compute_plane_mask_gpu(), blender::render::Context::Context(), blender::compositor::ConversionOperation::ConversionOperation(), create_result(), blender::nodes::node_composite_blur_cc::BlurOperation::execute(), blender::nodes::node_composite_bokehblur_cc::BokehBlurOperation::execute(), blender::nodes::node_composite_cornerpin_cc::CornerPinOperation::execute(), blender::nodes::node_composite_double_edge_mask_cc::DoubleEdgeMaskOperation::execute(), blender::nodes::node_composite_id_mask_cc::IDMaskOperation::execute(), blender::nodes::node_composite_inpaint_cc::InpaintOperation::execute(), blender::nodes::node_composite_kuwahara_cc::ConvertKuwaharaOperation::execute_anisotropic(), blender::nodes::node_composite_zcombine_cc::ZCombineOperation::execute_anti_aliased(), blender::nodes::node_composite_kuwahara_cc::ConvertKuwaharaOperation::execute_classic_summed_area_table(), blender::nodes::node_composite_planetrackdeform_cc::PlaneTrackDeformOperation::execute_cpu(), blender::nodes::node_composite_planetrackdeform_cc::PlaneTrackDeformOperation::execute_gpu(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_highlights_cpu(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_highlights_gpu(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_simple_star_horizontal_pass_cpu(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_simple_star_horizontal_pass_gpu(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_simple_star_vertical_pass_cpu(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_simple_star_vertical_pass_gpu(), blender::nodes::node_composite_dilate_cc::DilateErodeOperation::execute_step_horizontal_pass_cpu(), blender::nodes::node_composite_dilate_cc::DilateErodeOperation::execute_step_horizontal_pass_gpu(), blender::nodes::node_composite_keying_cc::KeyingOperation::extract_input_chroma_cpu(), blender::nodes::node_composite_keying_cc::KeyingOperation::extract_input_chroma_gpu(), blender::draw::compositor_engine::Context::get_input(), blender::render::Context::get_input(), blender::seq::CompositorContext::get_input(), blender::draw::compositor_engine::Context::get_output(), blender::render::Context::get_output(), blender::seq::CompositorContext::get_output(), get_pass(), blender::draw::compositor_engine::Context::get_viewer_output(), blender::render::Context::get_viewer_output(), blender::compositor::RealizeOnDomainOperation::RealizeOnDomainOperation(), blender::nodes::node_composite_keying_cc::KeyingOperation::replace_input_chroma_cpu(), and blender::nodes::node_composite_keying_cc::KeyingOperation::replace_input_chroma_gpu().

evaluate_operation_post()

void blender::compositor::Context::evaluate_operation_post ( ) const

virtual

Reimplemented in blender::render::Context.

Definition at line 65 of file compositor/intern/context.cc.

Referenced by blender::compositor::Operation::evaluate().

get_compositing_region()

virtual Bounds< int2 > blender::compositor::Context::get_compositing_region ( ) const

pure virtual

Implemented in blender::draw::compositor_engine::Context, blender::render::Context, and blender::seq::CompositorContext.

Referenced by blender::nodes::node_composite_group_input_cc::GroupInputOperation::execute_pass_cpu(), blender::nodes::node_composite_render_layer_cc::RenderLayerOperation::execute_pass_cpu(), blender::nodes::node_composite_group_input_cc::GroupInputOperation::execute_pass_gpu(), blender::nodes::node_composite_render_layer_cc::RenderLayerOperation::execute_pass_gpu(), get_compositing_region_size(), blender::nodes::node_composite_cryptomatte_cc::CryptoMatteOperation::get_layers_lower_bound(), and is_valid_compositing_region().

get_compositing_region_size()

int2 blender::compositor::Context::get_compositing_region_size

(

)

const

Definition at line 80 of file compositor/intern/context.cc.

References get_compositing_region(), blender::math::max(), and size().

Referenced by blender::nodes::node_composite_mask_cc::MaskOperation::compute_size(), blender::compositor::ImplicitInputOperation::execute(), and blender::nodes::node_composite_group_input_cc::GroupInputOperation::execute_pass_cpu().

get_denoise_quality()

eCompositorDenoiseQaulity blender::compositor::Context::get_denoise_quality

(

)

const

Definition at line 108 of file compositor/intern/context.cc.

References RenderData::compositor_denoise_final_quality, RenderData::compositor_denoise_preview_quality, get_render_data(), and render_context().

get_frame_number()

int blender::compositor::Context::get_frame_number

(

)

const

Definition at line 95 of file compositor/intern/context.cc.

References RenderData::cfra, and get_render_data().

Referenced by blender::nodes::node_composite_planetrackdeform_cc::PlaneTrackDeformOperation::compute_homography_matrices(), blender::nodes::node_composite_time_curves_cc::TimeCurveOperation::compute_normalized_time(), blender::nodes::node_composite_trackpos_cc::TrackPositionOperation::get_frame(), blender::nodes::node_composite_keyingscreen_cc::KeyingScreenOperation::get_size(), and get_time().

get_input()

virtual Result blender::compositor::Context::get_input ( StringRef name )

pure virtual

Implemented in blender::draw::compositor_engine::Context, blender::render::Context, and blender::seq::CompositorContext.

References name.

Referenced by blender::nodes::node_composite_group_input_cc::GroupInputOperation::execute().

get_node_tree()

virtual const bNodeTree & blender::compositor::Context::get_node_tree ( ) const

pure virtual

Implemented in blender::draw::compositor_engine::Context, blender::render::Context, and blender::seq::CompositorContext.

Referenced by is_canceled().

get_output()

virtual Result blender::compositor::Context::get_output ( Domain domain )

pure virtual

Implemented in blender::draw::compositor_engine::Context, blender::render::Context, and blender::seq::CompositorContext.

get_pass()

Result blender::compositor::Context::get_pass ( const Scene * scene, int view_layer, const char * name )

virtual

Reimplemented in blender::draw::compositor_engine::Context, and blender::render::Context.

Definition at line 21 of file compositor/intern/context.cc.

References blender::compositor::Color, and create_result().

Referenced by blender::nodes::node_composite_render_layer_cc::RenderLayerOperation::execute(), blender::nodes::node_composite_cryptomatte_cc::CryptoMatteOperation::get_layers_from_render(), and use_gpu().

get_precision()

ResultPrecision blender::compositor::Context::get_precision ( ) const

virtual

Reimplemented in blender::draw::compositor_engine::Context, and blender::render::Context.

Definition at line 36 of file compositor/intern/context.cc.

References blender::compositor::Full.

Referenced by create_result(), get_shader(), and use_gpu().

get_render_data()

const RenderData & blender::compositor::Context::get_render_data ( ) const

virtual

Reimplemented in blender::render::Context.

Definition at line 26 of file compositor/intern/context.cc.

References get_scene(), and Scene::r.

Referenced by blender::nodes::node_composite_mask_cc::MaskOperation::get_aspect_ratio(), get_denoise_quality(), get_frame_number(), get_render_percentage(), get_time(), blender::draw::compositor_engine::Context::get_view_name(), blender::nodes::node_composite_file_output_cc::FileOutputOperation::is_multi_view_scene(), and use_gpu().

get_render_percentage()

float blender::compositor::Context::get_render_percentage

(

)

const

Definition at line 90 of file compositor/intern/context.cc.

References get_render_data(), and RenderData::size.

Referenced by blender::nodes::node_composite_mask_cc::MaskOperation::compute_size().

get_scene()

virtual const Scene & blender::compositor::Context::get_scene ( ) const

pure virtual

Implemented in blender::draw::compositor_engine::Context, blender::render::Context, and blender::seq::CompositorContext.

Referenced by get_render_data().

get_shader() [1/2]

gpu::Shader * blender::compositor::Context::get_shader

(

const char *

info_name

)

Definition at line 124 of file compositor/intern/context.cc.

References get_precision(), and get_shader().

get_shader() [2/2]

gpu::Shader * blender::compositor::Context::get_shader	(	const char *	info_name,
		ResultPrecision	precision )

Definition at line 119 of file compositor/intern/context.cc.

References cache_manager(), blender::compositor::StaticCacheManager::cached_shaders, and blender::compositor::CachedShaderContainer::get().

Referenced by blender::nodes::node_composite_double_edge_mask_cc::DoubleEdgeMaskOperation::compute_boundary_gpu(), blender::nodes::node_composite_inpaint_cc::InpaintOperation::compute_inpainting_boundary_gpu(), blender::nodes::node_composite_zcombine_cc::ZCombineOperation::compute_mask_gpu(), blender::nodes::node_composite_base_cryptomatte_cc::BaseCryptoMatteOperation::compute_matte_gpu(), blender::nodes::node_composite_keying_cc::KeyingOperation::compute_matte_gpu(), blender::nodes::node_composite_base_cryptomatte_cc::BaseCryptoMatteOperation::compute_pick_gpu(), blender::nodes::node_composite_cornerpin_cc::CornerPinOperation::compute_plane_gpu(), blender::nodes::node_composite_planetrackdeform_cc::PlaneTrackDeformOperation::compute_plane_gpu(), blender::nodes::node_composite_cornerpin_cc::CornerPinOperation::compute_plane_mask_gpu(), blender::nodes::node_composite_planetrackdeform_cc::PlaneTrackDeformOperation::compute_plane_mask_gpu(), blender::compositor::ConversionOperation::execute(), blender::nodes::node_composite_crop_cc::CropOperation::execute_alpha_crop_gpu(), blender::nodes::node_composite_kuwahara_cc::ConvertKuwaharaOperation::execute_anisotropic_gpu(), blender::nodes::node_composite_zcombine_cc::ZCombineOperation::execute_anti_aliased_depth_gpu(), blender::nodes::node_composite_zcombine_cc::ZCombineOperation::execute_anti_aliased_image_gpu(), blender::nodes::node_composite_kuwahara_cc::ConvertKuwaharaOperation::execute_classic_convolution_gpu(), blender::nodes::node_composite_kuwahara_cc::ConvertKuwaharaOperation::execute_classic_summed_area_table_gpu(), blender::nodes::node_composite_blur_cc::BlurOperation::execute_constant_size_gpu(), blender::nodes::node_composite_bokehblur_cc::BokehBlurOperation::execute_constant_size_gpu(), blender::nodes::node_composite_viewer_cc::ViewerOperation::execute_copy_gpu(), blender::nodes::node_composite_bilateralblur_cc::BilateralBlurOperation::execute_gpu(), blender::nodes::node_composite_boxmask_cc::BoxMaskOperation::execute_gpu(), blender::nodes::node_composite_defocus_cc::DefocusOperation::execute_gpu(), blender::nodes::node_composite_despeckle_cc::DespeckleOperation::execute_gpu(), blender::nodes::node_composite_directionalblur_cc::DirectionalBlurOperation::execute_gpu(), blender::nodes::node_composite_displace_cc::DisplaceOperation::execute_gpu(), blender::nodes::node_composite_ellipsemask_cc::EllipseMaskOperation::execute_gpu(), blender::nodes::node_composite_filter_cc::FilterOperation::execute_gpu(), blender::nodes::node_composite_flip_cc::FlipOperation::execute_gpu(), blender::nodes::node_composite_id_mask_cc::IDMaskOperation::execute_gpu(), blender::nodes::node_composite_map_uv_cc::MapUVOperation::execute_gpu(), blender::nodes::node_composite_moviedistortion_cc::MovieDistortionOperation::execute_gpu(), blender::nodes::node_composite_normalize_cc::NormalizeOperation::execute_gpu(), blender::nodes::node_composite_pixelate_cc::PixelateOperation::execute_gpu(), blender::nodes::node_composite_split_cc::SplitOperation::execute_gpu(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_highlights_gpu(), blender::nodes::node_composite_lensdist_cc::LensDistortionOperation::execute_horizontal_distortion_gpu(), blender::nodes::node_composite_crop_cc::CropOperation::execute_image_crop_gpu(), blender::nodes::node_composite_group_input_cc::GroupInputOperation::execute_pass_gpu(), blender::nodes::node_composite_render_layer_cc::RenderLayerOperation::execute_pass_gpu(), blender::nodes::node_composite_lensdist_cc::LensDistortionOperation::execute_radial_distortion_gpu(), blender::nodes::node_composite_zcombine_cc::ZCombineOperation::execute_simple_depth_gpu(), blender::nodes::node_composite_tonemap_cc::ToneMapOperation::execute_simple_gpu(), blender::nodes::node_composite_zcombine_cc::ZCombineOperation::execute_simple_image_gpu(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_simple_star_horizontal_pass_gpu(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_simple_star_vertical_pass_gpu(), blender::nodes::node_composite_dilate_cc::DilateErodeOperation::execute_step_horizontal_pass_gpu(), blender::nodes::node_composite_dilate_cc::DilateErodeOperation::execute_step_vertical_pass_gpu(), blender::nodes::node_composite_scale_cc::ScaleOperation::execute_variable_size_gpu(), blender::nodes::node_composite_keying_cc::KeyingOperation::extract_input_chroma_gpu(), get_shader(), blender::nodes::node_composite_keying_cc::KeyingOperation::replace_input_chroma_gpu(), and blender::nodes::node_composite_glare_cc::GlareOperation::write_highlights_output_gpu().

get_time()

float blender::compositor::Context::get_time

(

)

const

Definition at line 100 of file compositor/intern/context.cc.

References float, get_frame_number(), and get_render_data().

get_view_name()

StringRef blender::compositor::Context::get_view_name ( ) const

virtual

Reimplemented in blender::draw::compositor_engine::Context, and blender::render::Context.

Definition at line 31 of file compositor/intern/context.cc.

Referenced by blender::nodes::node_composite_file_output_cc::FileOutputOperation::execute_multi_layer(), blender::nodes::node_composite_file_output_cc::FileOutputOperation::execute_single_layer_multi_view_exr(), and use_gpu().

get_viewer_output()

virtual Result blender::compositor::Context::get_viewer_output ( Domain domain, bool is_data, ResultPrecision precision )

pure virtual

Implemented in blender::draw::compositor_engine::Context, blender::render::Context, and blender::seq::CompositorContext.

Referenced by blender::nodes::node_composite_viewer_cc::ViewerOperation::execute_clear(), blender::nodes::node_composite_viewer_cc::ViewerOperation::execute_copy_cpu(), and blender::nodes::node_composite_viewer_cc::ViewerOperation::execute_copy_gpu().

is_canceled()

bool blender::compositor::Context::is_canceled ( ) const

virtual

Definition at line 67 of file compositor/intern/context.cc.

References get_node_tree(), and bNodeTree::runtime.

is_valid_compositing_region()

bool blender::compositor::Context::is_valid_compositing_region

(

)

const

Definition at line 85 of file compositor/intern/context.cc.

References get_compositing_region().

needed_outputs()

virtual OutputTypes blender::compositor::Context::needed_outputs ( ) const

pure virtual

Implemented in blender::draw::compositor_engine::Context, blender::render::Context, and blender::seq::CompositorContext.

populate_meta_data_for_pass()

void blender::compositor::Context::populate_meta_data_for_pass ( const Scene * scene, int view_layer_id, const char * pass_name, MetaData & meta_data ) const

virtual

Reimplemented in blender::render::Context.

Definition at line 48 of file compositor/intern/context.cc.

Referenced by blender::nodes::node_composite_render_layer_cc::RenderLayerOperation::execute().

profiler()

Profiler * blender::compositor::Context::profiler ( ) const

virtual

Reimplemented in blender::render::Context.

Definition at line 60 of file compositor/intern/context.cc.

render_context()

RenderContext * blender::compositor::Context::render_context ( ) const

virtual

Reimplemented in blender::render::Context.

Definition at line 55 of file compositor/intern/context.cc.

Referenced by blender::nodes::node_composite_file_output_cc::FileOutputOperation::execute_multi_layer(), blender::nodes::node_composite_file_output_cc::FileOutputOperation::execute_single_layer(), blender::nodes::node_composite_file_output_cc::FileOutputOperation::execute_single_layer_multi_view_exr(), get_denoise_quality(), and blender::nodes::node_composite_file_output_cc::FileOutputOperation::is_animation_render().

reset()

void blender::compositor::Context::reset

(

)

Definition at line 75 of file compositor/intern/context.cc.

set_info_message()

void blender::compositor::Context::set_info_message ( StringRef message ) const

virtual

Reimplemented in blender::draw::compositor_engine::Context.

Definition at line 41 of file compositor/intern/context.cc.

Referenced by use_gpu().

treat_viewer_as_compositor_output()

bool blender::compositor::Context::treat_viewer_as_compositor_output ( ) const

virtual

Reimplemented in blender::draw::compositor_engine::Context, and blender::seq::CompositorContext.

Definition at line 43 of file compositor/intern/context.cc.

Referenced by use_gpu().

use_context_bounds_for_input_output()

virtual bool blender::compositor::Context::use_context_bounds_for_input_output ( ) const

inlinevirtual

Reimplemented in blender::seq::CompositorContext.

Definition at line 106 of file COM_context.hh.

Referenced by blender::nodes::node_composite_group_input_cc::GroupInputOperation::execute_pass_cpu().

use_gpu()

virtual bool blender::compositor::Context::use_gpu ( ) const

pure virtual

Implemented in blender::draw::compositor_engine::Context, blender::render::Context, and blender::seq::CompositorContext.

References get_pass(), get_precision(), get_render_data(), get_view_name(), name, set_info_message(), and treat_viewer_as_compositor_output().

Referenced by blender::nodes::node_composite_denoise_cc::DenoiseOperation::execute().

---

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

• COM_context.hh
• compositor/intern/context.cc