Blender V4.3
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
blender::compositor::MixBaseOperation Class Reference

#include <COM_MixOperation.h>

Inherits blender::compositor::MultiThreadedOperation.

Inherited by blender::compositor::AlphaOverKeyOperation, blender::compositor::AlphaOverMixedOperation, blender::compositor::AlphaOverPremultiplyOperation, blender::compositor::MixAddOperation, blender::compositor::MixBlendOperation, blender::compositor::MixColorBurnOperation, blender::compositor::MixColorOperation, blender::compositor::MixDarkenOperation, blender::compositor::MixDifferenceOperation, blender::compositor::MixDivideOperation, blender::compositor::MixDodgeOperation, blender::compositor::MixExclusionOperation, blender::compositor::MixGlareOperation, blender::compositor::MixHueOperation, blender::compositor::MixLightenOperation, blender::compositor::MixLinearLightOperation, blender::compositor::MixMultiplyOperation, blender::compositor::MixOverlayOperation, blender::compositor::MixSaturationOperation, blender::compositor::MixScreenOperation, blender::compositor::MixSoftLightOperation, blender::compositor::MixSubtractOperation, and blender::compositor::MixValueOperation.

Classes

struct  PixelCursor
 

Public Member Functions

 MixBaseOperation ()
 
void determine_canvas (const rcti &preferred_area, rcti &r_area) override
 
void set_use_value_alpha_multiply (const bool value)
 
bool use_value_alpha_multiply ()
 
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
 
const void set_node_instance_key (const bNodeInstanceKey &node_instance_key)
 
const bNodeInstanceKey get_node_instance_key () 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.
 
void set_bnodetree (const bNodeTree *tree)
 
void set_execution_system (ExecutionSystem *system)
 
virtual void init_data ()
 
virtual void init_execution ()
 
virtual void deinit_execution ()
 
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).
 
void set_canvas_input_index (unsigned int index)
 set the index of the input socket that will determine the canvas of this operation
 
void set_determined_canvas_modifier (std::function< void(rcti &canvas)> fn)
 
virtual eCompositorPriority get_render_priority () const
 get the render priority of this node.
 
bool is_braked () const
 
void update_draw ()
 
unsigned int get_width () const
 
unsigned int get_height () const
 
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 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.
 
void get_area_of_interest (NodeOperation *input_op, const rcti &output_area, rcti &r_input_area)
 

Protected Member Functions

void clamp_if_needed (float color[4])
 
virtual void update_memory_buffer_row (PixelCursor &p)
 
- Protected Member Functions inherited from blender::compositor::MultiThreadedOperation
 MultiThreadedOperation ()
 
virtual void update_memory_buffer_started (MemoryBuffer *, const rcti &, Span< MemoryBuffer * >)
 
virtual void update_memory_buffer_finished (MemoryBuffer *, const rcti &, Span< MemoryBuffer * >)
 
- 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)
 
SocketReader * get_input_socket_reader (unsigned int index)
 

Protected Attributes

bool value_alpha_multiply_
 
bool use_clamp_
 
- Protected Attributes inherited from blender::compositor::MultiThreadedOperation
int num_passes_
 
int current_pass_
 
- Protected Attributes inherited from blender::compositor::NodeOperation
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

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

Definition at line 15 of file COM_MixOperation.h.

Constructor & Destructor Documentation

◆ MixBaseOperation()

blender::compositor::MixBaseOperation::MixBaseOperation ( )

Definition at line 13 of file COM_MixOperation.cc.

References blender::compositor::NodeOperation::add_input_socket(), blender::compositor::NodeOperation::add_output_socket(), blender::compositor::NodeOperationFlags::can_be_constant, blender::compositor::Color, blender::compositor::NodeOperation::flags_, set_use_clamp(), set_use_value_alpha_multiply(), and blender::compositor::Value.

Member Function Documentation

◆ clamp_if_needed()

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

Definition at line 41 of file COM_MixOperation.h.

References clamp_v4(), and use_clamp_.

Referenced by blender::compositor::MixAddOperation::update_memory_buffer_row(), blender::compositor::MixBlendOperation::update_memory_buffer_row(), blender::compositor::MixColorBurnOperation::update_memory_buffer_row(), blender::compositor::MixColorOperation::update_memory_buffer_row(), blender::compositor::MixDarkenOperation::update_memory_buffer_row(), blender::compositor::MixDifferenceOperation::update_memory_buffer_row(), blender::compositor::MixDivideOperation::update_memory_buffer_row(), blender::compositor::MixDodgeOperation::update_memory_buffer_row(), blender::compositor::MixExclusionOperation::update_memory_buffer_row(), blender::compositor::MixGlareOperation::update_memory_buffer_row(), blender::compositor::MixHueOperation::update_memory_buffer_row(), blender::compositor::MixLightenOperation::update_memory_buffer_row(), blender::compositor::MixLinearLightOperation::update_memory_buffer_row(), blender::compositor::MixMultiplyOperation::update_memory_buffer_row(), blender::compositor::MixOverlayOperation::update_memory_buffer_row(), blender::compositor::MixSaturationOperation::update_memory_buffer_row(), blender::compositor::MixScreenOperation::update_memory_buffer_row(), blender::compositor::MixSoftLightOperation::update_memory_buffer_row(), blender::compositor::MixSubtractOperation::update_memory_buffer_row(), and blender::compositor::MixValueOperation::update_memory_buffer_row().

◆ determine_canvas()

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

Reimplemented from blender::compositor::NodeOperation.

Definition at line 24 of file COM_MixOperation.cc.

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

◆ set_use_clamp()

void blender::compositor::MixBaseOperation::set_use_clamp ( bool value)
inline

Definition at line 61 of file COM_MixOperation.h.

References use_clamp_.

Referenced by blender::compositor::MixNode::convert_to_operations(), and MixBaseOperation().

◆ set_use_value_alpha_multiply()

void blender::compositor::MixBaseOperation::set_use_value_alpha_multiply ( const bool value)
inline

Definition at line 53 of file COM_MixOperation.h.

References value_alpha_multiply_.

Referenced by blender::compositor::AlphaOverNode::convert_to_operations(), blender::compositor::MixNode::convert_to_operations(), and MixBaseOperation().

◆ update_memory_buffer_partial()

void blender::compositor::MixBaseOperation::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 47 of file COM_MixOperation.cc.

References BLI_rcti_size_x(), blender::compositor::MixBaseOperation::PixelCursor::color1, blender::compositor::MixBaseOperation::PixelCursor::color1_stride, blender::compositor::MixBaseOperation::PixelCursor::color2, blender::compositor::MixBaseOperation::PixelCursor::color2_stride, blender::compositor::MemoryBuffer::elem_stride, blender::compositor::MemoryBuffer::get_elem(), blender::compositor::MixBaseOperation::PixelCursor::out, blender::compositor::MixBaseOperation::PixelCursor::out_stride, blender::compositor::MixBaseOperation::PixelCursor::row_end, update_memory_buffer_row(), blender::compositor::MixBaseOperation::PixelCursor::value, and blender::compositor::MixBaseOperation::PixelCursor::value_stride.

◆ update_memory_buffer_row()

void blender::compositor::MixBaseOperation::update_memory_buffer_row ( PixelCursor & p)
protectedvirtual

Reimplemented in blender::compositor::AlphaOverKeyOperation, blender::compositor::AlphaOverMixedOperation, blender::compositor::AlphaOverPremultiplyOperation, blender::compositor::MixAddOperation, blender::compositor::MixBlendOperation, blender::compositor::MixColorBurnOperation, blender::compositor::MixColorOperation, blender::compositor::MixDarkenOperation, blender::compositor::MixDifferenceOperation, blender::compositor::MixDivideOperation, blender::compositor::MixDodgeOperation, blender::compositor::MixExclusionOperation, blender::compositor::MixGlareOperation, blender::compositor::MixHueOperation, blender::compositor::MixLightenOperation, blender::compositor::MixLinearLightOperation, blender::compositor::MixMultiplyOperation, blender::compositor::MixOverlayOperation, blender::compositor::MixSaturationOperation, blender::compositor::MixScreenOperation, blender::compositor::MixSoftLightOperation, blender::compositor::MixSubtractOperation, and blender::compositor::MixValueOperation.

Definition at line 70 of file COM_MixOperation.cc.

References blender::compositor::MixBaseOperation::PixelCursor::color1, blender::compositor::MixBaseOperation::PixelCursor::color2, blender::compositor::MixBaseOperation::PixelCursor::next(), blender::compositor::MixBaseOperation::PixelCursor::out, blender::compositor::MixBaseOperation::PixelCursor::row_end, use_value_alpha_multiply(), and blender::compositor::MixBaseOperation::PixelCursor::value.

Referenced by update_memory_buffer_partial().

◆ use_value_alpha_multiply()

bool blender::compositor::MixBaseOperation::use_value_alpha_multiply ( )
inline

Definition at line 57 of file COM_MixOperation.h.

References value_alpha_multiply_.

Referenced by blender::compositor::MixAddOperation::update_memory_buffer_row(), update_memory_buffer_row(), blender::compositor::MixBlendOperation::update_memory_buffer_row(), blender::compositor::MixColorBurnOperation::update_memory_buffer_row(), blender::compositor::MixColorOperation::update_memory_buffer_row(), blender::compositor::MixDarkenOperation::update_memory_buffer_row(), blender::compositor::MixDifferenceOperation::update_memory_buffer_row(), blender::compositor::MixDivideOperation::update_memory_buffer_row(), blender::compositor::MixDodgeOperation::update_memory_buffer_row(), blender::compositor::MixExclusionOperation::update_memory_buffer_row(), blender::compositor::MixHueOperation::update_memory_buffer_row(), blender::compositor::MixLightenOperation::update_memory_buffer_row(), blender::compositor::MixLinearLightOperation::update_memory_buffer_row(), blender::compositor::MixMultiplyOperation::update_memory_buffer_row(), blender::compositor::MixOverlayOperation::update_memory_buffer_row(), blender::compositor::MixSaturationOperation::update_memory_buffer_row(), blender::compositor::MixScreenOperation::update_memory_buffer_row(), blender::compositor::MixSoftLightOperation::update_memory_buffer_row(), blender::compositor::MixSubtractOperation::update_memory_buffer_row(), and blender::compositor::MixValueOperation::update_memory_buffer_row().

Member Data Documentation

◆ use_clamp_

bool blender::compositor::MixBaseOperation::use_clamp_
protected

Definition at line 39 of file COM_MixOperation.h.

Referenced by clamp_if_needed(), and set_use_clamp().

◆ value_alpha_multiply_

bool blender::compositor::MixBaseOperation::value_alpha_multiply_
protected

Definition at line 38 of file COM_MixOperation.h.

Referenced by set_use_value_alpha_multiply(), and use_value_alpha_multiply().

The documentation for this class was generated from the following files:
Generated on Thu Feb 6 2025 07:36:39 for Blender by  doxygen 1.11.0