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

Compositor output operation. More...

#include <COM_CompositorOperation.h>

Inheritance diagram for blender::compositor::CompositorOperation:
blender::compositor::MultiThreadedOperation blender::compositor::NodeOperation

Public Member Functions

 CompositorOperation ()
 
bool is_active_compositor_output () 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 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. More...
 
void init_execution () override
 
void deinit_execution () override
 
eCompositorPriority get_render_priority () const override
 get the render priority of this node. More...
 
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
 
float get_constant_value_default (float default_value)
 
const floatget_constant_elem_default (const float *default_elem)
 
const NodeOperationFlags get_flags () const
 
std::optional< NodeOperationHashgenerate_hash ()
 
unsigned int get_number_of_input_sockets () const
 
unsigned int get_number_of_output_sockets () const
 
NodeOperationOutputget_output_socket (unsigned int index=0)
 
NodeOperationInputget_input_socket (unsigned int index)
 
NodeOperationget_input_operation (int index)
 
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_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 rctiget_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)
 
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 voidinitialize_tile_data (rcti *)
 
virtual void deinitialize_tile_data (rcti *, void *)
 
virtual MemoryBufferget_input_memory_buffer (MemoryBuffer **)
 
virtual std::unique_ptr< MetaDataget_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::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)
 
SocketReaderget_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...
 
- 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
eExecutionModel execution_model_
 
rcti canvas_ = COM_AREA_NONE
 
NodeOperationFlags flags_
 
ExecutionSystemexec_system_
 

Detailed Description

Compositor output operation.

Definition at line 15 of file COM_CompositorOperation.h.

Constructor & Destructor Documentation

◆ CompositorOperation()

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

Member Function Documentation

◆ deinit_execution()

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

◆ determine_canvas()

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

◆ execute_region()

void blender::compositor::CompositorOperation::execute_region ( rcti ,
unsigned int   
)
overridevirtual

◆ 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 97 of file COM_CompositorOperation.h.

References blender::compositor::Medium.

◆ init_execution()

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

◆ is_active_compositor_output()

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

Definition at line 70 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 91 of file COM_CompositorOperation.h.

References is_active_compositor_output().

◆ set_active()

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

◆ set_render_data()

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

◆ set_scene()

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

◆ set_scene_name()

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

◆ set_use_alpha_input()

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

◆ set_view_name()

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

◆ update_memory_buffer_partial()

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

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