blender::realtime_compositor::Context Class Reference

#include <COM_context.hh>

Inherited by blender::draw::compositor::Context, and blender::render::Context.

Public Member Functions
	Context (TexturePool &texture_pool)
virtual const Scene &	get_scene () const =0
virtual const bNodeTree &	get_node_tree () const =0
virtual bool	use_gpu () const =0
virtual bool	use_file_output () const =0
virtual bool	should_compute_node_previews () const =0
virtual bool	use_composite_output () const =0
virtual const RenderData &	get_render_data () const =0
virtual int2	get_render_size () const =0
virtual rcti	get_compositing_region () const =0
virtual Result	get_output_result ()=0
virtual Result	get_viewer_output_result (Domain domain, bool is_data, ResultPrecision precision)=0
virtual GPUTexture *	get_input_texture (const Scene *scene, int view_layer, const char *pass_name)=0
virtual StringRef	get_view_name () const =0
virtual ResultPrecision	get_precision () const =0
virtual void	set_info_message (StringRef message) const =0
virtual IDRecalcFlag	query_id_recalc_flag (ID *id) const =0
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
GPUShader *	get_shader (const char *info_name, ResultPrecision precision)
GPUShader *	get_shader (const char *info_name)
Result	create_result (ResultType type, ResultPrecision precision)
Result	create_result (ResultType type)
TexturePool &	texture_pool ()
StaticCacheManager &	cache_manager ()

Detailed Description

Definition at line 37 of file COM_context.hh.

Constructor & Destructor Documentation

Context()

blender::realtime_compositor::Context::Context

(

TexturePool &

texture_pool

)

Definition at line 23 of file compositor/realtime_compositor/intern/context.cc.

Member Function Documentation

cache_manager()

StaticCacheManager & blender::realtime_compositor::Context::cache_manager

(

)

Definition at line 117 of file compositor/realtime_compositor/intern/context.cc.

Referenced by blender::nodes::node_composite_image_cc::ImageOperation::compute_output(), blender::realtime_compositor::Evaluator::evaluate(), blender::nodes::node_composite_bokehimage_cc::BokehImageOperation::execute(), blender::nodes::node_composite_convert_color_space_cc::ConvertColorSpaceOperation::execute(), blender::nodes::node_composite_defocus_cc::DefocusOperation::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_texture_cc::TextureOperation::execute(), blender::nodes::node_composite_blur_cc::BlurOperation::execute_constant_size(), blender::nodes::node_composite_blur_cc::BlurOperation::execute_variable_size(), blender::nodes::node_composite_cryptomatte_cc::CryptoMatteOperation::get_layers_from_image(), and get_shader().

create_result() [1/2]

Result blender::realtime_compositor::Context::create_result

(

ResultType

type

)

Definition at line 107 of file compositor/realtime_compositor/intern/context.cc.

References create_result(), and get_precision().

create_result() [2/2]

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

Definition at line 102 of file compositor/realtime_compositor/intern/context.cc.

Referenced by blender::nodes::node_composite_glare_cc::GlareOperation::apply_streak_filter(), blender::nodes::node_composite_glare_cc::GlareOperation::compute_base_ghost(), blender::nodes::node_composite_glare_cc::GlareOperation::compute_bloom_downsample_chain(), blender::nodes::node_composite_keying_cc::KeyingOperation::compute_blurred_input(), blender::nodes::node_composite_keying_cc::KeyingOperation::compute_blurred_matte(), blender::nodes::node_composite_defocus_cc::DefocusOperation::compute_defocus_radius_from_depth(), blender::nodes::node_composite_defocus_cc::DefocusOperation::compute_defocus_radius_from_scale(), blender::nodes::node_composite_keying_cc::KeyingOperation::compute_feathered_matte(), blender::nodes::node_composite_inpaint_cc::InpaintOperation::compute_inpainting_boundary(), blender::nodes::node_composite_zcombine_cc::ZCombineOperation::compute_mask(), blender::nodes::node_composite_base_cryptomatte_cc::BaseCryptoMatteOperation::compute_matte(), blender::nodes::node_composite_keying_cc::KeyingOperation::compute_matte(), blender::nodes::node_composite_vec_blur_cc::VectorBlurOperation::compute_max_tile_velocity(), blender::nodes::node_composite_keying_cc::KeyingOperation::compute_morphed_matte(), blender::nodes::node_composite_cornerpin_cc::CornerPinOperation::compute_plane_mask(), blender::nodes::node_composite_planetrackdeform_cc::PlaneTrackDeformOperation::compute_plane_mask(), blender::nodes::node_composite_kuwahara_cc::ConvertKuwaharaOperation::compute_structure_tensor(), blender::nodes::node_composite_keying_cc::KeyingOperation::compute_tweaked_matte(), create_result(), 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_planetrackdeform_cc::PlaneTrackDeformOperation::execute(), blender::nodes::node_composite_kuwahara_cc::ConvertKuwaharaOperation::execute_anisotropic(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_bloom(), blender::nodes::node_composite_kuwahara_cc::ConvertKuwaharaOperation::execute_classic_summed_area_table(), blender::nodes::node_composite_dilate_cc::DilateErodeOperation::execute_distance_threshold(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_fog_glow(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_ghost(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_glare(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_highlights(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_simple_star_diagonal_pass(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_simple_star_horizontal_pass(), blender::nodes::node_composite_dilate_cc::DilateErodeOperation::execute_step_horizontal_pass(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_streaks(), blender::nodes::node_composite_keying_cc::KeyingOperation::extract_input_chroma(), blender::draw::compositor::Context::get_output_result(), blender::draw::compositor::Context::get_viewer_output_result(), and blender::nodes::node_composite_keying_cc::KeyingOperation::replace_input_chroma().

evaluate_operation_post()

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

virtual

Reimplemented in blender::render::Context.

Definition at line 42 of file compositor/realtime_compositor/intern/context.cc.

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

get_compositing_region()

virtual rcti blender::realtime_compositor::Context::get_compositing_region ( ) const

pure virtual

Implemented in blender::draw::compositor::Context, and blender::render::Context.

Referenced by blender::nodes::node_composite_render_layer_cc::RenderLayerOperation::execute_pass(), 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::realtime_compositor::Context::get_compositing_region_size

(

)

const

Definition at line 58 of file compositor/realtime_compositor/intern/context.cc.

References BLI_rcti_size_x(), BLI_rcti_size_y(), get_compositing_region(), and blender::math::max().

Referenced by blender::nodes::node_composite_mask_cc::MaskOperation::compute_size(), blender::nodes::node_composite_render_layer_cc::RenderLayerOperation::execute_pass(), and blender::draw::compositor::Engine::update_compositing_region_size().

get_frame_number()

int blender::realtime_compositor::Context::get_frame_number

(

)

const

Definition at line 79 of file compositor/realtime_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_texture()

virtual GPUTexture * blender::realtime_compositor::Context::get_input_texture ( const Scene * scene, int view_layer, const char * pass_name )

pure virtual

Implemented in blender::draw::compositor::Context, and blender::render::Context.

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

get_node_tree()

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

pure virtual

Implemented in blender::draw::compositor::Context, and blender::render::Context.

Referenced by blender::realtime_compositor::Evaluator::evaluate(), and is_canceled().

get_output_result()

virtual Result blender::realtime_compositor::Context::get_output_result ( )

pure virtual

Implemented in blender::draw::compositor::Context, and blender::render::Context.

Referenced by blender::nodes::node_composite_composite_cc::CompositeOperation::execute_clear(), blender::nodes::node_composite_composite_cc::CompositeOperation::execute_ignore_alpha_cpu(), and blender::nodes::node_composite_composite_cc::CompositeOperation::execute_ignore_alpha_gpu().

get_precision()

virtual ResultPrecision blender::realtime_compositor::Context::get_precision ( ) const

pure virtual

Implemented in blender::draw::compositor::Context, and blender::render::Context.

Referenced by create_result(), and get_shader().

get_render_data()

virtual const RenderData & blender::realtime_compositor::Context::get_render_data ( ) const

pure virtual

Implemented in blender::draw::compositor::Context, and blender::render::Context.

Referenced by blender::nodes::node_composite_mask_cc::MaskOperation::get_aspect_ratio(), get_frame_number(), get_render_percentage(), and get_time().

get_render_percentage()

float blender::realtime_compositor::Context::get_render_percentage

(

)

const

Definition at line 74 of file compositor/realtime_compositor/intern/context.cc.

References get_render_data(), and RenderData::size.

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

get_render_size()

virtual int2 blender::realtime_compositor::Context::get_render_size ( ) const

pure virtual

Implemented in blender::draw::compositor::Context, and blender::render::Context.

get_scene()

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

pure virtual

Implemented in blender::draw::compositor::Context, and blender::render::Context.

Referenced by blender::nodes::node_composite_defocus_cc::DefocusOperation::get_scene().

get_shader() [1/2]

GPUShader * blender::realtime_compositor::Context::get_shader

(

const char *

info_name

)

Definition at line 97 of file compositor/realtime_compositor/intern/context.cc.

References get_precision(), and get_shader().

get_shader() [2/2]

GPUShader * blender::realtime_compositor::Context::get_shader	(	const char *	info_name,
		ResultPrecision	precision )

Definition at line 92 of file compositor/realtime_compositor/intern/context.cc.

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

Referenced by blender::nodes::node_composite_glare_cc::GlareOperation::apply_streak_filter(), blender::nodes::node_composite_movieclip_cc::MovieClipOperation::compute_alpha(), blender::nodes::node_composite_glare_cc::GlareOperation::compute_base_ghost(), blender::nodes::node_composite_glare_cc::GlareOperation::compute_bloom_downsample_chain(), blender::nodes::node_composite_double_edge_mask_cc::DoubleEdgeMaskOperation::compute_boundary(), blender::nodes::node_composite_defocus_cc::DefocusOperation::compute_defocus_radius_from_depth(), blender::nodes::node_composite_defocus_cc::DefocusOperation::compute_defocus_radius_from_scale(), blender::nodes::node_composite_double_edge_mask_cc::DoubleEdgeMaskOperation::compute_gradient(), blender::nodes::node_composite_base_cryptomatte_cc::BaseCryptoMatteOperation::compute_image(), blender::nodes::node_composite_keying_cc::KeyingOperation::compute_image(), blender::nodes::node_composite_movieclip_cc::MovieClipOperation::compute_image(), blender::nodes::node_composite_inpaint_cc::InpaintOperation::compute_inpainting_boundary(), blender::nodes::node_composite_inpaint_cc::InpaintOperation::compute_inpainting_region(), blender::nodes::node_composite_zcombine_cc::ZCombineOperation::compute_mask(), blender::nodes::node_composite_base_cryptomatte_cc::BaseCryptoMatteOperation::compute_matte(), blender::nodes::node_composite_keying_cc::KeyingOperation::compute_matte(), blender::nodes::node_composite_vec_blur_cc::VectorBlurOperation::compute_max_tile_velocity(), blender::nodes::node_composite_vec_blur_cc::VectorBlurOperation::compute_motion_blur(), blender::nodes::node_composite_base_cryptomatte_cc::BaseCryptoMatteOperation::compute_pick(), blender::nodes::node_composite_cornerpin_cc::CornerPinOperation::compute_plane(), blender::nodes::node_composite_planetrackdeform_cc::PlaneTrackDeformOperation::compute_plane(), blender::nodes::node_composite_cornerpin_cc::CornerPinOperation::compute_plane_mask(), blender::nodes::node_composite_planetrackdeform_cc::PlaneTrackDeformOperation::compute_plane_mask(), blender::nodes::node_composite_kuwahara_cc::ConvertKuwaharaOperation::compute_structure_tensor(), blender::nodes::node_composite_keying_cc::KeyingOperation::compute_tweaked_matte(), blender::nodes::node_composite_vec_blur_cc::VectorBlurOperation::dilate_max_velocity(), blender::nodes::node_composite_bilateralblur_cc::BilateralBlurOperation::execute(), blender::nodes::node_composite_boxmask_cc::BoxMaskOperation::execute(), blender::nodes::node_composite_defocus_cc::DefocusOperation::execute(), blender::nodes::node_composite_despeckle_cc::DespeckleOperation::execute(), blender::nodes::node_composite_directionalblur_cc::DirectionalBlurOperation::execute(), blender::nodes::node_composite_displace_cc::DisplaceOperation::execute(), blender::nodes::node_composite_ellipsemask_cc::EllipseMaskOperation::execute(), blender::nodes::node_composite_filter_cc::FilterOperation::execute(), blender::nodes::node_composite_flip_cc::FlipOperation::execute(), blender::nodes::node_composite_id_mask_cc::IDMaskOperation::execute(), blender::nodes::node_composite_map_uv_cc::MapUVOperation::execute(), blender::nodes::node_composite_moviedistortion_cc::MovieDistortionOperation::execute(), blender::nodes::node_composite_normalize_cc::NormalizeOperation::execute(), blender::nodes::node_composite_pixelate_cc::PixelateOperation::execute(), blender::nodes::node_composite_sunbeams_cc::SunBeamsOperation::execute(), blender::nodes::node_composite_crop_cc::CropOperation::execute_alpha_crop(), blender::nodes::node_composite_kuwahara_cc::ConvertKuwaharaOperation::execute_anisotropic(), blender::nodes::node_composite_zcombine_cc::ZCombineOperation::execute_anti_aliased(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_bloom(), blender::nodes::node_composite_kuwahara_cc::ConvertKuwaharaOperation::execute_classic(), blender::nodes::node_composite_kuwahara_cc::ConvertKuwaharaOperation::execute_classic_summed_area_table(), blender::nodes::node_composite_blur_cc::BlurOperation::execute_constant_size(), blender::nodes::node_composite_bokehblur_cc::BokehBlurOperation::execute_constant_size(), blender::nodes::node_composite_dilate_cc::DilateErodeOperation::execute_distance_threshold(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_ghost(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_highlights(), blender::nodes::node_composite_composite_cc::CompositeOperation::execute_ignore_alpha_gpu(), blender::nodes::node_composite_viewer_cc::ViewerOperation::execute_ignore_alpha_gpu(), blender::nodes::node_composite_crop_cc::CropOperation::execute_image_crop(), blender::nodes::node_composite_render_layer_cc::RenderLayerOperation::execute_pass(), blender::nodes::node_composite_tonemap_cc::ToneMapOperation::execute_photoreceptor(), blender::nodes::node_composite_lensdist_cc::LensDistortionOperation::execute_projector_distortion(), blender::nodes::node_composite_lensdist_cc::LensDistortionOperation::execute_screen_distortion(), blender::nodes::node_composite_tonemap_cc::ToneMapOperation::execute_simple(), blender::nodes::node_composite_zcombine_cc::ZCombineOperation::execute_simple(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_simple_star_axis_aligned(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_simple_star_diagonal(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_simple_star_diagonal_pass(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_simple_star_horizontal_pass(), blender::nodes::node_composite_dilate_cc::DilateErodeOperation::execute_step_horizontal_pass(), blender::nodes::node_composite_dilate_cc::DilateErodeOperation::execute_step_vertical_pass(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_streaks(), blender::nodes::node_composite_blur_cc::BlurOperation::execute_variable_size(), blender::nodes::node_composite_bokehblur_cc::BokehBlurOperation::execute_variable_size(), blender::nodes::node_composite_scale_cc::ScaleOperation::execute_variable_size(), blender::nodes::node_composite_keying_cc::KeyingOperation::extract_input_chroma(), blender::nodes::node_composite_inpaint_cc::InpaintOperation::fill_inpainting_region(), blender::realtime_compositor::ConvertColorToFloatOperation::get_conversion_shader(), blender::realtime_compositor::ConvertColorToVectorOperation::get_conversion_shader(), blender::realtime_compositor::ConvertFloatToColorOperation::get_conversion_shader(), blender::realtime_compositor::ConvertFloatToVectorOperation::get_conversion_shader(), blender::realtime_compositor::ConvertVectorToColorOperation::get_conversion_shader(), blender::realtime_compositor::ConvertVectorToFloatOperation::get_conversion_shader(), get_shader(), blender::nodes::node_composite_split_cc::SplitOperation::get_split_shader(), and blender::nodes::node_composite_keying_cc::KeyingOperation::replace_input_chroma().

get_time()

float blender::realtime_compositor::Context::get_time

(

)

const

Definition at line 84 of file compositor/realtime_compositor/intern/context.cc.

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

get_view_name()

virtual StringRef blender::realtime_compositor::Context::get_view_name ( ) const

pure virtual

Implemented in blender::draw::compositor::Context, and blender::render::Context.

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

get_viewer_output_result()

virtual Result blender::realtime_compositor::Context::get_viewer_output_result ( Domain domain, bool is_data, ResultPrecision precision )

pure virtual

Implemented in blender::draw::compositor::Context, and blender::render::Context.

Referenced by blender::nodes::node_composite_viewer_cc::ViewerOperation::execute_clear(), blender::nodes::node_composite_viewer_cc::ViewerOperation::execute_ignore_alpha_cpu(), and blender::nodes::node_composite_viewer_cc::ViewerOperation::execute_ignore_alpha_gpu().

is_canceled()

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

virtual

Definition at line 44 of file compositor/realtime_compositor/intern/context.cc.

References get_node_tree(), and bNodeTree::runtime.

Referenced by blender::realtime_compositor::Evaluator::evaluate(), and blender::nodes::node_composite_denoise_cc::oidn_progress_monitor_function().

is_valid_compositing_region()

bool blender::realtime_compositor::Context::is_valid_compositing_region

(

)

const

Definition at line 66 of file compositor/realtime_compositor/intern/context.cc.

References BLI_rcti_size_x(), BLI_rcti_size_y(), and get_compositing_region().

populate_meta_data_for_pass()

void blender::realtime_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 25 of file compositor/realtime_compositor/intern/context.cc.

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

profiler()

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

virtual

Reimplemented in blender::render::Context.

Definition at line 37 of file compositor/realtime_compositor/intern/context.cc.

Referenced by blender::realtime_compositor::Evaluator::evaluate(), and blender::realtime_compositor::NodeOperation::evaluate().

query_id_recalc_flag()

virtual IDRecalcFlag blender::realtime_compositor::Context::query_id_recalc_flag ( ID * id ) const

pure virtual

Implemented in blender::draw::compositor::Context, and blender::render::Context.

render_context()

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

virtual

Reimplemented in blender::render::Context.

Definition at line 32 of file compositor/realtime_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(), and blender::nodes::node_composite_file_output_cc::FileOutputOperation::execute_single_layer_multi_view_exr().

reset()

void blender::realtime_compositor::Context::reset

(

)

Definition at line 52 of file compositor/realtime_compositor/intern/context.cc.

References blender::realtime_compositor::StaticCacheManager::reset(), and blender::realtime_compositor::TexturePool::reset().

Referenced by blender::realtime_compositor::Evaluator::evaluate().

set_info_message()

virtual void blender::realtime_compositor::Context::set_info_message ( StringRef message ) const

pure virtual

Implemented in blender::draw::compositor::Context, and blender::render::Context.

Referenced by blender::nodes::node_composite_texture_cc::TextureOperation::execute(), and blender::nodes::node_composite_render_layer_cc::RenderLayerOperation::execute_pass().

should_compute_node_previews()

virtual bool blender::realtime_compositor::Context::should_compute_node_previews ( ) const

pure virtual

Implemented in blender::draw::compositor::Context, and blender::render::Context.

texture_pool()

TexturePool & blender::realtime_compositor::Context::texture_pool

(

)

Definition at line 112 of file compositor/realtime_compositor/intern/context.cc.

Referenced by blender::realtime_compositor::Result::release(), and blender::realtime_compositor::Operation::texture_pool().

use_composite_output()

virtual bool blender::realtime_compositor::Context::use_composite_output ( ) const

pure virtual

Implemented in blender::draw::compositor::Context, and blender::render::Context.

use_file_output()

virtual bool blender::realtime_compositor::Context::use_file_output ( ) const

pure virtual

Implemented in blender::draw::compositor::Context, and blender::render::Context.

use_gpu()

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

pure virtual

Implemented in blender::draw::compositor::Context, and blender::render::Context.

---

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

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