NodeOperation to write to a tile. More...

#include <COM_WriteBufferOperation.h>

Inheritance diagram for blender::compositor::WriteBufferOperation:

Public Member Functions
	WriteBufferOperation (DataType datatype)

	~WriteBufferOperation ()

MemoryProxy *	get_memory_proxy ()

void	execute_pixel_sampled (float output[4], float x, float y, PixelSampler sampler) override
	calculate a single pixel More...

bool	is_single_value () const

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

void	init_execution () override

void	deinit_execution () override

void	execute_opencl_region (OpenCLDevice device, rcti rect, unsigned int chunk_number, MemoryBuffer *memory_buffers, MemoryBuffer output_buffer) override
	when a chunk is executed by an OpenCLDevice, this method is called More...

void	determine_canvas (const rcti &preferred_area, rcti &r_area) override

void	read_resolution_from_input_socket ()

NodeOperation *	get_input ()

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

Additional Inherited Members
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...

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

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

rcti	canvas_ = COM_AREA_NONE

NodeOperationFlags	flags_

ExecutionSystem *	exec_system_

Detailed Description

NodeOperation to write to a tile.

Definition at line 18 of file COM_WriteBufferOperation.h.

Constructor & Destructor Documentation

◆ WriteBufferOperation()

blender::compositor::WriteBufferOperation::WriteBufferOperation ( DataType datatype )

Definition at line 9 of file COM_WriteBufferOperation.cc.

References blender::compositor::NodeOperation::add_input_socket(), blender::compositor::NodeOperation::flags_, blender::compositor::NodeOperationFlags::is_write_buffer_operation, blender::compositor::MemoryProxy::set_executor(), and blender::compositor::MemoryProxy::set_write_buffer_operation().

◆ ~WriteBufferOperation()

blender::compositor::WriteBufferOperation::~WriteBufferOperation ( )

Definition at line 17 of file COM_WriteBufferOperation.cc.

Member Function Documentation

◆ deinit_execution()

void blender::compositor::WriteBufferOperation::deinit_execution ( )

overridevirtual

Reimplemented from blender::compositor::NodeOperation.

Definition at line 39 of file COM_WriteBufferOperation.cc.

References blender::compositor::MemoryProxy::free().

◆ determine_canvas()

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

overridevirtual

Reimplemented from blender::compositor::NodeOperation.

Definition at line 192 of file COM_WriteBufferOperation.cc.

References BLI_rcti_size_x(), BLI_rcti_size_y(), blender::compositor::NodeOperation::determine_canvas(), rcti::xmax, and rcti::ymax.

Referenced by blender::compositor::ReadBufferOperation::determine_canvas().

◆ execute_opencl_region()

void blender::compositor::WriteBufferOperation::execute_opencl_region	(	OpenCLDevice *	,
		rcti *	,
		unsigned int	,
		MemoryBuffer **	,
		MemoryBuffer *
	)

overridevirtual

when a chunk is executed by an OpenCLDevice, this method is called

Note: this method is only implemented in WriteBufferOperation

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
rect	the rectangle of the chunk (location and size)
chunk_number	the chunk_number to be calculated
memory_buffers	all input MemoryBuffer's needed
output_buffer	the outputbuffer to write to

Reimplemented from blender::compositor::NodeOperation.

Definition at line 96 of file COM_WriteBufferOperation.cc.

◆ execute_pixel_sampled()

void blender::compositor::WriteBufferOperation::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 25 of file COM_WriteBufferOperation.cc.

References output, blender::compositor::NodeOperation::read_sampled(), sampler(), x, and y.