#include <COM_KeyingScreenOperation.h>

Inheritance diagram for blender::compositor::KeyingScreenOperation:

Classes
struct	TileData

struct	TriangulationData

Public Member Functions
	KeyingScreenOperation ()

void	init_execution () override

void	deinit_execution () override

void *	initialize_tile_data (rcti *rect) override

void	deinitialize_tile_data (rcti rect, void data) override

void	set_movie_clip (MovieClip *clip)

void	set_tracking_object (const char *object)

void	set_framenumber (int framenumber)

void	execute_pixel (float output[4], int x, int y, void *data) override
	calculate a single pixel More...

void	update_memory_buffer_partial (MemoryBuffer output, const rcti &area, Span< MemoryBuffer > inputs) override

Public Member Functions inherited from blender::compositor::NodeOperation
virtual	~NodeOperation ()

void	set_name (const std::string name)

const std::string	get_name () const

void	set_id (const int id)

const int	get_id () const

float	get_constant_value_default (float default_value)

const float *	get_constant_elem_default (const float *default_elem)

const NodeOperationFlags	get_flags () const

std::optional< NodeOperationHash >	generate_hash ()

unsigned int	get_number_of_input_sockets () const

unsigned int	get_number_of_output_sockets () const

NodeOperationOutput *	get_output_socket (unsigned int index=0)

NodeOperationInput *	get_input_socket (unsigned int index)

NodeOperation *	get_input_operation (int index)

virtual bool	is_output_operation (bool) const
	is_output_operation determines whether this operation is an output of the ExecutionSystem during rendering or editing. More...

void	set_execution_model (const eExecutionModel model)

void	set_bnodetree (const bNodeTree *tree)

void	set_execution_system (ExecutionSystem *system)

virtual void	init_data ()

virtual void	execute_region (rcti *, unsigned int)
	when a chunk is executed by a CPUDevice, this method is called More...

virtual void	execute_opencl_region (OpenCLDevice , rcti , unsigned int, MemoryBuffer *, MemoryBuffer )
	when a chunk is executed by an OpenCLDevice, this method is called More...

virtual void	execute_opencl (OpenCLDevice , MemoryBuffer , cl_mem, MemoryBuffer *, std::list< cl_mem > , std::list< cl_kernel > *)
	custom handle to add new tasks to the OpenCL command queue in order to execute a chunk on an GPUDevice. More...

void	set_canvas (const rcti &canvas_area)

const rcti &	get_canvas () const

void	unset_canvas ()

virtual bool	is_active_viewer_output () const
	is this operation the active viewer output user can select an ViewerNode to be active (the result of this node will be drawn on the backdrop). More...

virtual bool	determine_depending_area_of_interest (rcti input, ReadBufferOperation read_operation, rcti *output)

void	set_canvas_input_index (unsigned int index)
	set the index of the input socket that will determine the canvas of this operation More...

void	set_determined_canvas_modifier (std::function< void(rcti &canvas)> fn)

virtual eCompositorPriority	get_render_priority () const
	get the render priority of this node. More...

bool	is_braked () const

void	update_draw ()

unsigned int	get_width () const

unsigned int	get_height () const

void	read_sampled (float result[4], float x, float y, PixelSampler sampler)

void	read_filtered (float result[4], float x, float y, float dx[2], float dy[2])

void	read (float result[4], int x, int y, void *chunk_data)

virtual MemoryBuffer *	get_input_memory_buffer (MemoryBuffer **)

virtual std::unique_ptr< MetaData >	get_meta_data ()

void	render (MemoryBuffer output_buf, Span< rcti > areas, Span< MemoryBuffer > inputs_bufs)

virtual void	update_memory_buffer (MemoryBuffer UNUSED(output), const rcti &UNUSED(area), Span< MemoryBuffer > UNUSED(inputs))

virtual void	get_area_of_interest (int input_idx, const rcti &output_area, rcti &r_input_area)
	Get input operation area being read by this operation on rendering given output area. More...

void	get_area_of_interest (NodeOperation *input_op, const rcti &output_area, rcti &r_input_area)

Protected Types
typedef struct blender::compositor::KeyingScreenOperation::TriangulationData	TriangulationData

typedef struct blender::compositor::KeyingScreenOperation::TileData	TileData

Protected Member Functions
void	determine_canvas (const rcti &preferred_area, rcti &r_area) override

TriangulationData *	build_voronoi_triangulation ()

Protected Member Functions inherited from blender::compositor::MultiThreadedOperation
	MultiThreadedOperation ()

virtual void	update_memory_buffer_started (MemoryBuffer UNUSED(output), const rcti &UNUSED(area), Span< MemoryBuffer > UNUSED(inputs))

virtual void	update_memory_buffer_finished (MemoryBuffer UNUSED(output), const rcti &UNUSED(area), Span< MemoryBuffer > UNUSED(inputs))

Protected Member Functions inherited from blender::compositor::NodeOperation
	NodeOperation ()

virtual void	hash_output_params ()

template<typename T >
void	hash_param (T param)

template<typename T1 , typename T2 >
void	hash_params (T1 param1, T2 param2)

template<typename T1 , typename T2 , typename T3 >
void	hash_params (T1 param1, T2 param2, T3 param3)

void	add_input_socket (DataType datatype, ResizeMode resize_mode=ResizeMode::Center)

void	add_output_socket (DataType datatype)

void	set_width (unsigned int width)

void	set_height (unsigned int height)

SocketReader *	get_input_socket_reader (unsigned int index)

void	deinit_mutex ()

void	init_mutex ()

void	lock_mutex ()

void	unlock_mutex ()

void	set_complex (bool complex)
	set whether this operation is complex More...

virtual void	execute_pixel_sampled (float[4], float, float, PixelSampler)
	calculate a single pixel More...

virtual void	execute_pixel_filtered (float[4], float, float, float[2], float[2])
	calculate a single pixel using an EWA filter More...

Protected Attributes
MovieClip *	movie_clip_

int	framenumber_

TriangulationData *	cached_triangulation_

char	tracking_object_ [64]

Protected Attributes inherited from blender::compositor::MultiThreadedOperation
int	num_passes_

int	current_pass_

Protected Attributes inherited from blender::compositor::NodeOperation
eExecutionModel	execution_model_

rcti	canvas_ = COM_AREA_NONE

NodeOperationFlags	flags_

ExecutionSystem *	exec_system_

Additional Inherited Members
Static Protected Member Functions inherited from blender::compositor::NodeOperation
static void	combine_hashes (size_t &combined, size_t other)

Detailed Description

Class with implementation of green screen gradient rasterization

Definition at line 22 of file COM_KeyingScreenOperation.h.

Member Typedef Documentation

◆ TileData

typedef struct blender::compositor::KeyingScreenOperation::TileData blender::compositor::KeyingScreenOperation::TileData

protected

◆ TriangulationData

typedef struct blender::compositor::KeyingScreenOperation::TriangulationData blender::compositor::KeyingScreenOperation::TriangulationData

protected

Constructor & Destructor Documentation

◆ KeyingScreenOperation()

blender::compositor::KeyingScreenOperation::KeyingScreenOperation ( )

Definition at line 16 of file COM_KeyingScreenOperation.cc.

References blender::compositor::NodeOperation::add_output_socket(), cached_triangulation_, blender::compositor::Color, blender::compositor::NodeOperationFlags::complex, blender::compositor::NodeOperation::flags_, framenumber_, movie_clip_, and tracking_object_.

Member Function Documentation

◆ build_voronoi_triangulation()

KeyingScreenOperation::TriangulationData * blender::compositor::KeyingScreenOperation::build_voronoi_triangulation ( )

protected

Definition at line 63 of file COM_KeyingScreenOperation.cc.

References Freestyle::a, add_v2_v2v2(), add_v3_v3(), usdtokens::b(), BKE_movieclip_get_ibuf(), BKE_movieclip_remap_scene_to_clip_frame(), BKE_movieclip_user_set_frame(), BKE_tracking_get_active_tracks(), BKE_tracking_get_pattern_imbuf(), BKE_tracking_marker_get(), BKE_tracking_object_get_named(), BKE_tracking_object_get_tracks(), BLI_freelistN(), BLI_voronoi_compute(), BLI_voronoi_triangulate(), Freestyle::c, VoronoiSite::co, VoronoiSite::color, DNA_struct_default_get, ListBase::first, MovieTrackingMarker::flag, framenumber_, blender::compositor::NodeOperation::get_height(), blender::compositor::NodeOperation::get_width(), height, IMB_freeImBuf(), IN_RANGE_INCL, INIT_MINMAX2, MARKER_DISABLED, max, MEM_callocN, MEM_freeN, min, minmax_v2v2_v2(), movie_clip_, mul_v3_fl(), MovieTrackingTrack::next, MovieTrackingTrack::offset, pos, MovieTrackingMarker::pos, ImBuf::rect, ImBuf::rect_float, srgb_to_linearrgb(), MovieClip::tracking, tracking_object_, blender::compositor::KeyingScreenOperation::TriangulationData::triangles, blender::compositor::KeyingScreenOperation::TriangulationData::triangles_AABB, blender::compositor::KeyingScreenOperation::TriangulationData::triangles_total, blender::compositor::KeyingScreenOperation::TriangulationData::triangulated_points, blender::compositor::KeyingScreenOperation::TriangulationData::triangulated_points_total, width, ImBuf::x, rcti::xmax, rcti::xmin, ImBuf::y, rcti::ymax, rcti::ymin, and zero_v3().

Referenced by init_execution(), and initialize_tile_data().

◆ deinit_execution()

void blender::compositor::KeyingScreenOperation::deinit_execution ( )

overridevirtual

Reimplemented from blender::compositor::NodeOperation.

Definition at line 40 of file COM_KeyingScreenOperation.cc.

References cached_triangulation_, MEM_freeN, blender::compositor::KeyingScreenOperation::TriangulationData::triangles, blender::compositor::KeyingScreenOperation::TriangulationData::triangles_AABB, and blender::compositor::KeyingScreenOperation::TriangulationData::triangulated_points.

◆ deinitialize_tile_data()

void blender::compositor::KeyingScreenOperation::deinitialize_tile_data	(	rcti *	rect,
		void *	data
	)

overridevirtual

Reimplemented from blender::compositor::NodeOperation.

Definition at line 275 of file COM_KeyingScreenOperation.cc.

References data, MEM_freeN, and blender::compositor::KeyingScreenOperation::TileData::triangles.

◆ determine_canvas()

void blender::compositor::KeyingScreenOperation::determine_canvas	(	const rcti &	preferred_area,
		rcti &	r_area
	)

overrideprotectedvirtual

Determine the output resolution. The resolution is retrieved from the Renderer

Reimplemented from blender::compositor::NodeOperation.

Definition at line 286 of file COM_KeyingScreenOperation.cc.

References BKE_movieclip_get_size(), BKE_movieclip_remap_scene_to_clip_frame(), BKE_movieclip_user_set_frame(), blender::compositor::COM_AREA_NONE, DNA_struct_default_get, framenumber_, height, movie_clip_, width, rcti::xmax, rcti::xmin, rcti::ymax, and rcti::ymin.

◆ execute_pixel()

void blender::compositor::KeyingScreenOperation::execute_pixel	(	float	output[4],
		int	x,
		int	y,
		void *
	)

overridevirtual

calculate a single pixel

Note: this method is called for complex

Parameters

result	is a float[4] array to store the result
x	the x-coordinate of the pixel to calculate in image space
y	the y-coordinate of the pixel to calculate in image space
input_buffers	chunks that can be read by their ReadBufferOperation.
chunk_data	chunk specific data a during execution time.

Reimplemented from blender::compositor::NodeOperation.

Definition at line 303 of file COM_KeyingScreenOperation.cc.

References Freestyle::a, usdtokens::b(), barycentric_coords_v2(), barycentric_inside_triangle_v2(), Freestyle::c, cached_triangulation_, data, float(), IN_RANGE_INCL, movie_clip_, output, blender::compositor::KeyingScreenOperation::TriangulationData::triangles, blender::compositor::KeyingScreenOperation::TileData::triangles, blender::compositor::KeyingScreenOperation::TriangulationData::triangles_AABB, blender::compositor::KeyingScreenOperation::TileData::triangles_total, blender::compositor::KeyingScreenOperation::TriangulationData::triangulated_points, w(), x, rcti::xmax, rcti::xmin, y, rcti::ymax, and rcti::ymin.

◆ init_execution()

void blender::compositor::KeyingScreenOperation::init_execution ( )

overridevirtual

Reimplemented from blender::compositor::NodeOperation.

Definition at line 26 of file COM_KeyingScreenOperation.cc.

References BLI_assert, build_voronoi_triangulation(), cached_triangulation_, blender::compositor::NodeOperation::execution_model_, blender::compositor::FullFrame, blender::compositor::NodeOperation::init_mutex(), and movie_clip_.

◆ initialize_tile_data()

void * blender::compositor::KeyingScreenOperation::initialize_tile_data ( rcti * rect )

overridevirtual

Reimplemented from blender::compositor::NodeOperation.

Definition at line 258 of file COM_KeyingScreenOperation.cc.

References build_voronoi_triangulation(), cached_triangulation_, blender::compositor::NodeOperation::lock_mutex(), movie_clip_, and blender::compositor::NodeOperation::unlock_mutex().

◆ set_framenumber()

void blender::compositor::KeyingScreenOperation::set_framenumber ( int framenumber )

inline

Definition at line 66 of file COM_KeyingScreenOperation.h.

References framenumber_.

Referenced by blender::compositor::KeyingScreenNode::convert_to_operations().

◆ set_movie_clip()

void blender::compositor::KeyingScreenOperation::set_movie_clip ( MovieClip * clip )

inline

Definition at line 58 of file COM_KeyingScreenOperation.h.

References movie_clip_.

Referenced by blender::compositor::KeyingScreenNode::convert_to_operations().

◆ set_tracking_object()

void blender::compositor::KeyingScreenOperation::set_tracking_object ( const char * object )

inline

Definition at line 62 of file COM_KeyingScreenOperation.h.

References BLI_strncpy(), and tracking_object_.

Referenced by blender::compositor::KeyingScreenNode::convert_to_operations().

◆ update_memory_buffer_partial()

void blender::compositor::KeyingScreenOperation::update_memory_buffer_partial	(	MemoryBuffer *	output,
		const rcti &	area,
		Span< MemoryBuffer * >	inputs
	)