#include <COM_DilateErodeOperation.h>

Inheritance diagram for blender::compositor::DilateDistanceOperation:

Classes
struct	PixelData

Public Member Functions
	DilateDistanceOperation ()

void	execute_pixel (float output[4], int x, int y, void *data) override

void	init_data () override

void	init_execution () override

void *	initialize_tile_data (rcti *rect) override

void	deinit_execution () override

void	set_distance (float distance)

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

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

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

virtual 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 void	determine_canvas (const rcti &preferred_area, rcti &r_area)

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	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...

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...

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 void	deinitialize_tile_data (rcti , void )

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))

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

Protected Attributes
SocketReader *	input_program_

float	distance_

int	scope_

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
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...

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

Detailed Description

Definition at line 74 of file COM_DilateErodeOperation.h.

Constructor & Destructor Documentation

◆ DilateDistanceOperation()

blender::compositor::DilateDistanceOperation::DilateDistanceOperation ( )

Definition at line 255 of file COM_DilateErodeOperation.cc.

References blender::compositor::NodeOperation::add_input_socket(), blender::compositor::NodeOperation::add_output_socket(), blender::compositor::NodeOperationFlags::complex, distance_, blender::compositor::NodeOperation::flags_, input_program_, blender::compositor::NodeOperationFlags::open_cl, and blender::compositor::Value.

Member Function Documentation

◆ deinit_execution()

void blender::compositor::DilateDistanceOperation::deinit_execution ( )

overridevirtual

Deinitialize the execution

Reimplemented from blender::compositor::NodeOperation.

Definition at line 316 of file COM_DilateErodeOperation.cc.

References input_program_.

◆ determine_depending_area_of_interest()

bool blender::compositor::DilateDistanceOperation::determine_depending_area_of_interest	(	rcti *	input,
		ReadBufferOperation *	read_operation,
		rcti *	output
	)

overridevirtual

Reimplemented from blender::compositor::NodeOperation.

Definition at line 321 of file COM_DilateErodeOperation.cc.

References blender::compositor::NodeOperation::determine_depending_area_of_interest(), input, output, scope_, rcti::xmax, rcti::xmin, rcti::ymax, and rcti::ymin.

◆ execute_opencl()

void blender::compositor::DilateDistanceOperation::execute_opencl	(	OpenCLDevice *	,
		MemoryBuffer *	,
		cl_mem	,
		MemoryBuffer **	,
		std::list< cl_mem > *	,
		std::list< cl_kernel > *
	)

overridevirtual

custom handle to add new tasks to the OpenCL command queue in order to execute a chunk on an GPUDevice.

Parameters

context	the OpenCL context
program	the OpenCL program containing all compositor kernels
queue	the OpenCL command queue of the device the chunk is executed on
output_memory_buffer	the allocated memory buffer in main CPU memory
cl_output_buffer	the allocated memory buffer in OpenCLDevice memory
input_memory_buffers	all input MemoryBuffer's needed
cl_mem_to_clean_up	all created cl_mem references must be added to this list. Framework will clean this after execution
cl_kernels_to_clean_up	all created cl_kernel references must be added to this list. Framework will clean this after execution

Reimplemented from blender::compositor::NodeOperation.

Reimplemented in blender::compositor::ErodeDistanceOperation.

Definition at line 334 of file COM_DilateErodeOperation.cc.

References blender::compositor::OpenCLDevice::COM_cl_attach_memory_buffer_offset_to_kernel_parameter(), blender::compositor::OpenCLDevice::COM_cl_attach_memory_buffer_to_kernel_parameter(), blender::compositor::OpenCLDevice::COM_cl_attach_output_memory_buffer_to_kernel_parameter(), blender::compositor::OpenCLDevice::COM_cl_attach_size_to_kernel_parameter(), blender::compositor::OpenCLDevice::COM_cl_create_kernel(), blender::compositor::OpenCLDevice::COM_cl_enqueue_range(), distance_, blender::math::distance_squared(), input_program_, and scope_.

◆ execute_pixel()

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

overridevirtual

The inner loop of this operation.

Reimplemented from blender::compositor::NodeOperation.

Reimplemented in blender::compositor::ErodeDistanceOperation.

Definition at line 284 of file COM_DilateErodeOperation.cc.

References buffer, data, blender::math::distance(), distance_, blender::compositor::MemoryBuffer::get_buffer(), blender::compositor::MemoryBuffer::get_rect(), blender::compositor::MemoryBuffer::get_width(), MAX2, MIN2, offset, output, scope_, x, rcti::xmax, rcti::xmin, y, rcti::ymax, and rcti::ymin.

◆ get_area_of_interest()

void blender::compositor::DilateDistanceOperation::get_area_of_interest	(	int	input_idx,
		const rcti &	output_area,
		rcti &	r_input_area
	)

finalvirtual

Get input operation area being read by this operation on rendering given output area.

Implementation don't need to ensure r_input_area is within input operation bounds. The caller must clamp it. TODO: See if it's possible to use parameter overloading (input_id for example).

Parameters

input_idx	Input operation index for which we want to calculate the area being read.
output_area	Area being rendered by this operation.
r_input_area	Returned input operation area that needs to be read in order to render given output area.

Reimplemented from blender::compositor::NodeOperation.

Definition at line 358 of file COM_DilateErodeOperation.cc.

References BLI_assert, scope_, UNUSED_VARS_NDEBUG, rcti::xmax, rcti::xmin, rcti::ymax, and rcti::ymin.

◆ init_data()

void blender::compositor::DilateDistanceOperation::init_data ( )

overridevirtual

Initializes operation data needed after operations are linked and resolutions determined. For rendering heap memory data use init_execution().

Reimplemented from blender::compositor::NodeOperation.

Definition at line 265 of file COM_DilateErodeOperation.cc.

References distance_, and scope_.

◆ init_execution()

void blender::compositor::DilateDistanceOperation::init_execution ( )

overridevirtual

Initialize the execution

Reimplemented from blender::compositor::NodeOperation.

Definition at line 273 of file COM_DilateErodeOperation.cc.

References blender::compositor::NodeOperation::get_input_socket_reader(), and input_program_.

◆ initialize_tile_data()

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

overridevirtual

Reimplemented from blender::compositor::NodeOperation.

Definition at line 278 of file COM_DilateErodeOperation.cc.

References buffer, blender::compositor::NodeOperation::initialize_tile_data(), and input_program_.

◆ set_distance()

void blender::compositor::DilateDistanceOperation::set_distance ( float distance )

inline

Definition at line 107 of file COM_DilateErodeOperation.h.

References blender::math::distance(), and distance_.

Referenced by blender::compositor::DilateErodeNode::convert_to_operations(), and blender::compositor::KeyingNode::setup_dilate_erode().

◆ update_memory_buffer_partial()

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