#include <COM_MaskOperation.h>

Inheritance diagram for blender::compositor::MaskOperation:

Public Member Functions
	MaskOperation ()

void	init_execution () override

void	deinit_execution () override

void	set_mask (Mask *mask)

void	set_mask_width (int width)

void	set_mask_height (int height)

void	set_framenumber (int frame_number)

void	set_feather (bool feather)

void	set_motion_blur_samples (int samples)

void	set_motion_blur_shutter (float shutter)

void	execute_pixel_sampled (float output[4], float x, float y, PixelSampler sampler) 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 void *	initialize_tile_data (rcti *)

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

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

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 (float output[4], int x, int y, void *)
	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
Mask *	mask_

int	mask_width_

int	mask_height_

float	mask_width_inv_

float	mask_height_inv_

float	mask_px_ofs_ [2]

float	frame_shutter_

int	frame_number_

bool	do_feather_

struct MaskRasterHandle *	raster_mask_handles_ [CMP_NODE_MASK_MBLUR_SAMPLES_MAX]

unsigned int	raster_mask_handle_tot_

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 mask rasterization

Definition at line 19 of file COM_MaskOperation.h.

Constructor & Destructor Documentation

◆ MaskOperation()

blender::compositor::MaskOperation::MaskOperation ( )

Definition at line 11 of file COM_MaskOperation.cc.

References blender::compositor::NodeOperation::add_output_socket(), frame_number_, frame_shutter_, mask_, mask_height_, mask_height_inv_, mask_width_, mask_width_inv_, raster_mask_handle_tot_, raster_mask_handles_, and blender::compositor::Value.

Member Function Documentation

◆ deinit_execution()

void blender::compositor::MaskOperation::deinit_execution ( )

overridevirtual

Reimplemented from blender::compositor::NodeOperation.

Definition at line 77 of file COM_MaskOperation.cc.

References BKE_maskrasterize_handle_free(), raster_mask_handle_tot_, and raster_mask_handles_.

◆ determine_canvas()

void blender::compositor::MaskOperation::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 87 of file COM_MaskOperation.cc.

References blender::compositor::COM_AREA_NONE, mask_height_, mask_width_, rcti::xmax, rcti::xmin, rcti::ymax, and rcti::ymin.

◆ execute_pixel_sampled()

void blender::compositor::MaskOperation::execute_pixel_sampled	(	float	[4],
		float	,
		float	,
		PixelSampler
	)

overridevirtual

calculate a single pixel

Note: this method is called for non-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.

Reimplemented from blender::compositor::NodeOperation.

Definition at line 99 of file COM_MaskOperation.cc.

References BKE_maskrasterize_handle_sample(), mask_height_inv_, mask_px_ofs_, mask_width_inv_, output, raster_mask_handle_tot_, raster_mask_handles_, x, xy, and y.