Blender V4.3
Public Member Functions | List of all members
blender::compositor::CompositorOperation Class Reference

Compositor output operation. More...

#include <COM_CompositorOperation.h>

Inherits blender::compositor::MultiThreadedOperation.

Public Member Functions

 CompositorOperation ()
 
bool is_active_compositor_output () const
 
void set_scene (const struct Scene *scene)
 
void set_scene_name (const char *scene_name)
 
void set_view_name (const char *view_name)
 
void set_render_data (const RenderData *rd)
 
bool is_output_operation (bool) const override
 is_output_operation determines whether this operation is an output of the ExecutionSystem during rendering or editing.
 
void init_execution () override
 
void deinit_execution () override
 
eCompositorPriority get_render_priority () const override
 get the render priority of this node.
 
void determine_canvas (const rcti &preferred_area, rcti &r_area) override
 
void set_use_alpha_input (bool value)
 
void set_active (bool active)
 
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
 
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)
 
void set_bnodetree (const bNodeTree *tree)
 
void set_execution_system (ExecutionSystem *system)
 
virtual void init_data ()
 
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)
 
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)
 

Additional Inherited Members

- 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)
 
- 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::MultiThreadedOperation
int num_passes_
 
int current_pass_
 
- Protected Attributes inherited from blender::compositor::NodeOperation
rcti canvas_ = COM_AREA_NONE
 
NodeOperationFlags flags_
 
ExecutionSystem * exec_system_
 

Detailed Description

Compositor output operation.

Definition at line 16 of file COM_CompositorOperation.h.

Constructor & Destructor Documentation

◆ CompositorOperation()

blender::compositor::CompositorOperation::CompositorOperation ( )

Definition at line 19 of file COM_CompositorOperation.cc.

References blender::compositor::NodeOperation::add_input_socket(), blender::compositor::Color, blender::compositor::NodeOperation::flags_, set_render_data(), blender::compositor::NodeOperationFlags::use_render_border, and blender::compositor::Value.

Member Function Documentation

◆ deinit_execution()

void blender::compositor::CompositorOperation::deinit_execution ( )
overridevirtual

Reimplemented from blender::compositor::NodeOperation.

Definition at line 50 of file COM_CompositorOperation.cc.

References BKE_image_ensure_viewer(), BKE_image_partial_update_mark_full_update(), BKE_image_signal(), BLI_thread_lock(), BLI_thread_unlock(), G, RenderResult::have_combined, IB_TAKE_OWNERSHIP, IMA_SIGNAL_FREE, IMA_TYPE_R_RESULT, IMB_assign_float_buffer(), blender::compositor::NodeOperation::is_braked(), LOCK_DRAW_IMAGE, MEM_freeN(), RE_AcquireResultWrite(), RE_GetSceneRender(), RE_ReleaseResult(), RE_RenderViewEnsureImBuf(), and RE_RenderViewGetByName().

◆ determine_canvas()

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

Reimplemented from blender::compositor::NodeOperation.

Definition at line 113 of file COM_CompositorOperation.cc.

References BKE_render_resolution(), BLI_rcti_init(), blender::compositor::NodeOperation::determine_canvas(), RE_AcquireResultRead(), RE_GetSceneRender(), RE_ReleaseResult(), RenderResult::rectx, RenderResult::recty, and blender::compositor::NodeOperation::set_determined_canvas_modifier().

◆ get_render_priority()

eCompositorPriority blender::compositor::CompositorOperation::get_render_priority ( ) const
inlineoverridevirtual

get the render priority of this node.

Note
only applicable for output operations like ViewerOperation
Returns
eCompositorPriority

Reimplemented from blender::compositor::NodeOperation.

Definition at line 74 of file COM_CompositorOperation.h.

References blender::compositor::Medium.

◆ init_execution()

void blender::compositor::CompositorOperation::init_execution ( )
overridevirtual

Reimplemented from blender::compositor::NodeOperation.

Definition at line 37 of file COM_CompositorOperation.cc.

References blender::compositor::NodeOperation::get_height(), blender::compositor::NodeOperation::get_width(), and MEM_callocN.

◆ is_active_compositor_output()

bool blender::compositor::CompositorOperation::is_active_compositor_output ( ) const
inline

Definition at line 51 of file COM_CompositorOperation.h.

Referenced by is_output_operation().

◆ is_output_operation()

bool blender::compositor::CompositorOperation::is_output_operation ( bool ) const
inlineoverridevirtual

is_output_operation determines whether this operation is an output of the ExecutionSystem during rendering or editing.

Default behavior if not overridden, this operation will not be evaluated as being an output of the ExecutionSystem.

See also
ExecutionSystem
Parameters
rendering[true false] true: rendering false: editing
Returns
bool the result of this method

Reimplemented from blender::compositor::NodeOperation.

Definition at line 68 of file COM_CompositorOperation.h.

References is_active_compositor_output().

◆ set_active()

void blender::compositor::CompositorOperation::set_active ( bool active)
inline

Definition at line 83 of file COM_CompositorOperation.h.

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

◆ set_render_data()

void blender::compositor::CompositorOperation::set_render_data ( const RenderData * rd)
inline

Definition at line 64 of file COM_CompositorOperation.h.

Referenced by CompositorOperation(), and blender::compositor::CompositorNode::convert_to_operations().

◆ set_scene()

void blender::compositor::CompositorOperation::set_scene ( const struct Scene * scene)
inline

Definition at line 55 of file COM_CompositorOperation.h.

References scene.

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

◆ set_scene_name()

void blender::compositor::CompositorOperation::set_scene_name ( const char * scene_name)

Definition at line 94 of file COM_CompositorOperation.cc.

References STRNCPY.

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

◆ set_use_alpha_input()

void blender::compositor::CompositorOperation::set_use_alpha_input ( bool value)
inline

Definition at line 79 of file COM_CompositorOperation.h.

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

◆ set_view_name()

void blender::compositor::CompositorOperation::set_view_name ( const char * view_name)
inline

Definition at line 60 of file COM_CompositorOperation.h.

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

◆ update_memory_buffer_partial()

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

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

Implements blender::compositor::MultiThreadedOperation.

Definition at line 99 of file COM_CompositorOperation.cc.

References blender::compositor::COM_DATA_TYPE_COLOR_CHANNELS, blender::compositor::COM_DATA_TYPE_VALUE_CHANNELS, blender::compositor::MemoryBuffer::copy_from(), blender::compositor::NodeOperation::get_height(), and blender::compositor::NodeOperation::get_width().

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