blender::compositor::MathBaseOperation Class Reference

#include <COM_MathBaseOperation.h>

Inheritance diagram for blender::compositor::MathBaseOperation:

Public Member Functions
void	init_execution () override
void	deinit_execution () override
void	determine_canvas (const rcti &preferred_area, rcti &r_area) override
void	set_use_clamp (bool value)
void	update_memory_buffer_partial (MemoryBuffer *output, const rcti &area, Span< MemoryBuffer * > inputs) final
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
	MathBaseOperation ()
void	clamp_if_needed (float color[4])
float	clamp_when_enabled (float value)
void	clamp_when_enabled (float *out)
virtual void	update_memory_buffer_partial (BuffersIterator< float > &it)=0
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 (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
SocketReader *	input_value1_operation_
SocketReader *	input_value2_operation_
SocketReader *	input_value3_operation_
bool	use_clamp_
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

this program converts an input color to an output value. it assumes we are in sRGB color space.

Definition at line 14 of file COM_MathBaseOperation.h.

Constructor & Destructor Documentation

MathBaseOperation()

blender::compositor::MathBaseOperation::MathBaseOperation ( )

protected

Default constructor

Definition at line 8 of file COM_MathBaseOperation.cc.

References blender::compositor::NodeOperation::add_input_socket(), blender::compositor::NodeOperation::add_output_socket(), blender::compositor::NodeOperationFlags::can_be_constant, blender::compositor::NodeOperation::flags_, input_value1_operation_, input_value2_operation_, input_value3_operation_, use_clamp_, and blender::compositor::Value.

Member Function Documentation

clamp_if_needed()

void blender::compositor::MathBaseOperation::clamp_if_needed ( float  color[4] )

protected

Definition at line 52 of file COM_MathBaseOperation.cc.

References CLAMP, color, and use_clamp_.

Referenced by blender::compositor::MathAddOperation::execute_pixel_sampled(), blender::compositor::MathSubtractOperation::execute_pixel_sampled(), blender::compositor::MathMultiplyOperation::execute_pixel_sampled(), blender::compositor::MathDivideOperation::execute_pixel_sampled(), blender::compositor::MathSineOperation::execute_pixel_sampled(), blender::compositor::MathCosineOperation::execute_pixel_sampled(), blender::compositor::MathTangentOperation::execute_pixel_sampled(), blender::compositor::MathHyperbolicSineOperation::execute_pixel_sampled(), blender::compositor::MathHyperbolicCosineOperation::execute_pixel_sampled(), blender::compositor::MathHyperbolicTangentOperation::execute_pixel_sampled(), blender::compositor::MathArcSineOperation::execute_pixel_sampled(), blender::compositor::MathArcCosineOperation::execute_pixel_sampled(), blender::compositor::MathArcTangentOperation::execute_pixel_sampled(), blender::compositor::MathPowerOperation::execute_pixel_sampled(), blender::compositor::MathLogarithmOperation::execute_pixel_sampled(), blender::compositor::MathMinimumOperation::execute_pixel_sampled(), blender::compositor::MathMaximumOperation::execute_pixel_sampled(), blender::compositor::MathRoundOperation::execute_pixel_sampled(), blender::compositor::MathLessThanOperation::execute_pixel_sampled(), blender::compositor::MathGreaterThanOperation::execute_pixel_sampled(), blender::compositor::MathModuloOperation::execute_pixel_sampled(), blender::compositor::MathAbsoluteOperation::execute_pixel_sampled(), blender::compositor::MathRadiansOperation::execute_pixel_sampled(), blender::compositor::MathDegreesOperation::execute_pixel_sampled(), blender::compositor::MathArcTan2Operation::execute_pixel_sampled(), blender::compositor::MathFloorOperation::execute_pixel_sampled(), blender::compositor::MathCeilOperation::execute_pixel_sampled(), blender::compositor::MathFractOperation::execute_pixel_sampled(), blender::compositor::MathSqrtOperation::execute_pixel_sampled(), blender::compositor::MathInverseSqrtOperation::execute_pixel_sampled(), blender::compositor::MathSignOperation::execute_pixel_sampled(), blender::compositor::MathExponentOperation::execute_pixel_sampled(), blender::compositor::MathTruncOperation::execute_pixel_sampled(), blender::compositor::MathSnapOperation::execute_pixel_sampled(), blender::compositor::MathWrapOperation::execute_pixel_sampled(), blender::compositor::MathPingpongOperation::execute_pixel_sampled(), blender::compositor::MathCompareOperation::execute_pixel_sampled(), blender::compositor::MathMultiplyAddOperation::execute_pixel_sampled(), blender::compositor::MathSmoothMinOperation::execute_pixel_sampled(), and blender::compositor::MathSmoothMaxOperation::execute_pixel_sampled().

clamp_when_enabled() [1/2]

void blender::compositor::MathBaseOperation::clamp_when_enabled ( float *  out )

inlineprotected

Definition at line 42 of file COM_MathBaseOperation.h.

References CLAMP, usdtokens::out(), and use_clamp_.

clamp_when_enabled() [2/2]

float blender::compositor::MathBaseOperation::clamp_when_enabled ( float  value )

inlineprotected

Definition at line 34 of file COM_MathBaseOperation.h.

References CLAMPIS, and use_clamp_.

Referenced by blender::compositor::MathDivideOperation::update_memory_buffer_partial(), blender::compositor::MathSineOperation::update_memory_buffer_partial(), blender::compositor::MathCosineOperation::update_memory_buffer_partial(), blender::compositor::MathTangentOperation::update_memory_buffer_partial(), blender::compositor::MathHyperbolicSineOperation::update_memory_buffer_partial(), blender::compositor::MathHyperbolicCosineOperation::update_memory_buffer_partial(), blender::compositor::MathHyperbolicTangentOperation::update_memory_buffer_partial(), blender::compositor::MathArcSineOperation::update_memory_buffer_partial(), blender::compositor::MathArcCosineOperation::update_memory_buffer_partial(), blender::compositor::MathArcTangentOperation::update_memory_buffer_partial(), blender::compositor::MathPowerOperation::update_memory_buffer_partial(), blender::compositor::MathLogarithmOperation::update_memory_buffer_partial(), blender::compositor::MathMinimumOperation::update_memory_buffer_partial(), blender::compositor::MathMaximumOperation::update_memory_buffer_partial(), blender::compositor::MathRoundOperation::update_memory_buffer_partial(), blender::compositor::MathModuloOperation::update_memory_buffer_partial(), blender::compositor::MathAbsoluteOperation::update_memory_buffer_partial(), blender::compositor::MathRadiansOperation::update_memory_buffer_partial(), blender::compositor::MathDegreesOperation::update_memory_buffer_partial(), blender::compositor::MathArcTan2Operation::update_memory_buffer_partial(), blender::compositor::MathFloorOperation::update_memory_buffer_partial(), blender::compositor::MathCeilOperation::update_memory_buffer_partial(), blender::compositor::MathFractOperation::update_memory_buffer_partial(), blender::compositor::MathSqrtOperation::update_memory_buffer_partial(), blender::compositor::MathInverseSqrtOperation::update_memory_buffer_partial(), blender::compositor::MathSignOperation::update_memory_buffer_partial(), blender::compositor::MathExponentOperation::update_memory_buffer_partial(), blender::compositor::MathTruncOperation::update_memory_buffer_partial(), blender::compositor::MathSnapOperation::update_memory_buffer_partial(), blender::compositor::MathWrapOperation::update_memory_buffer_partial(), blender::compositor::MathPingpongOperation::update_memory_buffer_partial(), blender::compositor::MathCompareOperation::update_memory_buffer_partial(), blender::compositor::MathMultiplyAddOperation::update_memory_buffer_partial(), blender::compositor::MathSmoothMinOperation::update_memory_buffer_partial(), and blender::compositor::MathSmoothMaxOperation::update_memory_buffer_partial().

deinit_execution()

void blender::compositor::MathBaseOperation::deinit_execution ( )

overridevirtual

Deinitialize the execution

Reimplemented from blender::compositor::NodeOperation.

Definition at line 30 of file COM_MathBaseOperation.cc.

References input_value1_operation_, input_value2_operation_, and input_value3_operation_.

determine_canvas()

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

overridevirtual

Determine resolution

Reimplemented from blender::compositor::NodeOperation.

Definition at line 37 of file COM_MathBaseOperation.cc.

References blender::compositor::COM_AREA_NONE, blender::compositor::NodeOperationInput::determine_canvas(), blender::compositor::NodeOperation::determine_canvas(), blender::compositor::NodeOperation::get_input_socket(), and blender::compositor::NodeOperation::set_canvas_input_index().

init_execution()

void blender::compositor::MathBaseOperation::init_execution ( )

overridevirtual

Initialize the execution

Reimplemented from blender::compositor::NodeOperation.

Definition at line 23 of file COM_MathBaseOperation.cc.

References blender::compositor::NodeOperation::get_input_socket_reader(), input_value1_operation_, input_value2_operation_, and input_value3_operation_.

set_use_clamp()

void blender::compositor::MathBaseOperation::set_use_clamp ( bool  value )

inline

Definition at line 65 of file COM_MathBaseOperation.h.

References use_clamp_.

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

update_memory_buffer_partial() [1/2]

virtual void blender::compositor::MathBaseOperation::update_memory_buffer_partial ( BuffersIterator< float > &  it )

protectedpure virtual

Implemented in blender::compositor::MathSmoothMaxOperation, blender::compositor::MathSmoothMinOperation, blender::compositor::MathMultiplyAddOperation, blender::compositor::MathCompareOperation, blender::compositor::MathPingpongOperation, blender::compositor::MathWrapOperation, blender::compositor::MathSnapOperation, blender::compositor::MathTruncOperation, blender::compositor::MathExponentOperation, blender::compositor::MathSignOperation, blender::compositor::MathInverseSqrtOperation, blender::compositor::MathSqrtOperation, blender::compositor::MathFractOperation, blender::compositor::MathCeilOperation, blender::compositor::MathFloorOperation, blender::compositor::MathArcTan2Operation, blender::compositor::MathDegreesOperation, blender::compositor::MathRadiansOperation, blender::compositor::MathAbsoluteOperation, blender::compositor::MathModuloOperation, blender::compositor::MathRoundOperation, blender::compositor::MathMaximumOperation, blender::compositor::MathMinimumOperation, blender::compositor::MathLogarithmOperation, blender::compositor::MathPowerOperation, blender::compositor::MathArcTangentOperation, blender::compositor::MathArcCosineOperation, blender::compositor::MathArcSineOperation, blender::compositor::MathHyperbolicTangentOperation, blender::compositor::MathHyperbolicCosineOperation, blender::compositor::MathHyperbolicSineOperation, blender::compositor::MathTangentOperation, blender::compositor::MathCosineOperation, blender::compositor::MathSineOperation, and blender::compositor::MathDivideOperation.

update_memory_buffer_partial() [2/2]

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

finalvirtual

Executes operation updating a memory buffer area. Multi-threaded calls.

Implements blender::compositor::MultiThreadedOperation.

Definition at line 59 of file COM_MathBaseOperation.cc.

References blender::compositor::area(), inputs, and output.

Member Data Documentation

input_value1_operation_

SocketReader* blender::compositor::MathBaseOperation::input_value1_operation_

protected

Prefetched reference to the input_program

Definition at line 19 of file COM_MathBaseOperation.h.

Referenced by deinit_execution(), blender::compositor::MathAddOperation::execute_pixel_sampled(), blender::compositor::MathSubtractOperation::execute_pixel_sampled(), blender::compositor::MathMultiplyOperation::execute_pixel_sampled(), blender::compositor::MathDivideOperation::execute_pixel_sampled(), blender::compositor::MathSineOperation::execute_pixel_sampled(), blender::compositor::MathCosineOperation::execute_pixel_sampled(), blender::compositor::MathTangentOperation::execute_pixel_sampled(), blender::compositor::MathHyperbolicSineOperation::execute_pixel_sampled(), blender::compositor::MathHyperbolicCosineOperation::execute_pixel_sampled(), blender::compositor::MathHyperbolicTangentOperation::execute_pixel_sampled(), blender::compositor::MathArcSineOperation::execute_pixel_sampled(), blender::compositor::MathArcCosineOperation::execute_pixel_sampled(), blender::compositor::MathArcTangentOperation::execute_pixel_sampled(), blender::compositor::MathPowerOperation::execute_pixel_sampled(), blender::compositor::MathLogarithmOperation::execute_pixel_sampled(), blender::compositor::MathMinimumOperation::execute_pixel_sampled(), blender::compositor::MathMaximumOperation::execute_pixel_sampled(), blender::compositor::MathRoundOperation::execute_pixel_sampled(), blender::compositor::MathLessThanOperation::execute_pixel_sampled(), blender::compositor::MathGreaterThanOperation::execute_pixel_sampled(), blender::compositor::MathModuloOperation::execute_pixel_sampled(), blender::compositor::MathAbsoluteOperation::execute_pixel_sampled(), blender::compositor::MathRadiansOperation::execute_pixel_sampled(), blender::compositor::MathDegreesOperation::execute_pixel_sampled(), blender::compositor::MathArcTan2Operation::execute_pixel_sampled(), blender::compositor::MathFloorOperation::execute_pixel_sampled(), blender::compositor::MathCeilOperation::execute_pixel_sampled(), blender::compositor::MathFractOperation::execute_pixel_sampled(), blender::compositor::MathSqrtOperation::execute_pixel_sampled(), blender::compositor::MathInverseSqrtOperation::execute_pixel_sampled(), blender::compositor::MathSignOperation::execute_pixel_sampled(), blender::compositor::MathExponentOperation::execute_pixel_sampled(), blender::compositor::MathTruncOperation::execute_pixel_sampled(), blender::compositor::MathSnapOperation::execute_pixel_sampled(), blender::compositor::MathWrapOperation::execute_pixel_sampled(), blender::compositor::MathPingpongOperation::execute_pixel_sampled(), blender::compositor::MathCompareOperation::execute_pixel_sampled(), blender::compositor::MathMultiplyAddOperation::execute_pixel_sampled(), blender::compositor::MathSmoothMinOperation::execute_pixel_sampled(), blender::compositor::MathSmoothMaxOperation::execute_pixel_sampled(), init_execution(), and MathBaseOperation().

input_value2_operation_

SocketReader* blender::compositor::MathBaseOperation::input_value2_operation_

protected

Definition at line 20 of file COM_MathBaseOperation.h.

Referenced by deinit_execution(), blender::compositor::MathAddOperation::execute_pixel_sampled(), blender::compositor::MathSubtractOperation::execute_pixel_sampled(), blender::compositor::MathMultiplyOperation::execute_pixel_sampled(), blender::compositor::MathDivideOperation::execute_pixel_sampled(), blender::compositor::MathSineOperation::execute_pixel_sampled(), blender::compositor::MathCosineOperation::execute_pixel_sampled(), blender::compositor::MathTangentOperation::execute_pixel_sampled(), blender::compositor::MathHyperbolicSineOperation::execute_pixel_sampled(), blender::compositor::MathHyperbolicCosineOperation::execute_pixel_sampled(), blender::compositor::MathHyperbolicTangentOperation::execute_pixel_sampled(), blender::compositor::MathArcSineOperation::execute_pixel_sampled(), blender::compositor::MathArcCosineOperation::execute_pixel_sampled(), blender::compositor::MathArcTangentOperation::execute_pixel_sampled(), blender::compositor::MathPowerOperation::execute_pixel_sampled(), blender::compositor::MathLogarithmOperation::execute_pixel_sampled(), blender::compositor::MathMinimumOperation::execute_pixel_sampled(), blender::compositor::MathMaximumOperation::execute_pixel_sampled(), blender::compositor::MathRoundOperation::execute_pixel_sampled(), blender::compositor::MathLessThanOperation::execute_pixel_sampled(), blender::compositor::MathGreaterThanOperation::execute_pixel_sampled(), blender::compositor::MathModuloOperation::execute_pixel_sampled(), blender::compositor::MathArcTan2Operation::execute_pixel_sampled(), blender::compositor::MathSnapOperation::execute_pixel_sampled(), blender::compositor::MathWrapOperation::execute_pixel_sampled(), blender::compositor::MathPingpongOperation::execute_pixel_sampled(), blender::compositor::MathCompareOperation::execute_pixel_sampled(), blender::compositor::MathMultiplyAddOperation::execute_pixel_sampled(), blender::compositor::MathSmoothMinOperation::execute_pixel_sampled(), blender::compositor::MathSmoothMaxOperation::execute_pixel_sampled(), init_execution(), and MathBaseOperation().

input_value3_operation_

SocketReader* blender::compositor::MathBaseOperation::input_value3_operation_

protected

Definition at line 21 of file COM_MathBaseOperation.h.

Referenced by deinit_execution(), blender::compositor::MathWrapOperation::execute_pixel_sampled(), blender::compositor::MathCompareOperation::execute_pixel_sampled(), blender::compositor::MathMultiplyAddOperation::execute_pixel_sampled(), blender::compositor::MathSmoothMinOperation::execute_pixel_sampled(), blender::compositor::MathSmoothMaxOperation::execute_pixel_sampled(), init_execution(), and MathBaseOperation().

use_clamp_

bool blender::compositor::MathBaseOperation::use_clamp_

protected

Definition at line 23 of file COM_MathBaseOperation.h.

Referenced by clamp_if_needed(), clamp_when_enabled(), MathBaseOperation(), and set_use_clamp().

---

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

• COM_MathBaseOperation.h
• COM_MathBaseOperation.cc