Blender V4.3
blender::compositor::BaseImageOperation Class Reference

Base class for all image operations. More...

#include <COM_ImageOperation.h>

Inherits blender::compositor::MultiThreadedOperation.

Inherited by blender::compositor::ImageAlphaOperation, blender::compositor::ImageOperation, and blender::compositor::MultilayerBaseOperation.

Public Member Functions

void init_execution () override
 
void deinit_execution () override
 
void set_image (Image *image)
 
void set_image_user (const ImageUser &imageuser)
 
void set_render_data (const RenderData *rd)
 
void set_view_name (const char *view_name)
 
void set_framenumber (int framenumber)
 
- 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 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)
 
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 ()
 
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).
 
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 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 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

 BaseImageOperation ()
 
void determine_canvas (const rcti &preferred_area, rcti &r_area) override
 
virtual ImBufget_im_buf ()
 
- 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_partial (MemoryBuffer *output, const rcti &area, Span< MemoryBuffer * > inputs)=0
 
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)
 
SocketReaderget_input_socket_reader (unsigned int index)
 

Protected Attributes

ImBufbuffer_
 
Imageimage_
 
ImageUser image_user_
 
int imageheight_
 
int imagewidth_
 
int framenumber_
 
int number_of_channels_
 
const RenderDatard_
 
const char * view_name_
 
- 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_
 
ExecutionSystemexec_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

Base class for all image operations.

Definition at line 22 of file COM_ImageOperation.h.

Constructor & Destructor Documentation

◆ BaseImageOperation()

blender::compositor::BaseImageOperation::BaseImageOperation ( )
protected

Member Function Documentation

◆ deinit_execution()

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

Reimplemented from blender::compositor::NodeOperation.

Definition at line 61 of file COM_ImageOperation.cc.

References BKE_image_release_ibuf(), buffer_, and image_.

◆ determine_canvas()

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

Determine the output resolution. The resolution is retrieved from the Renderer

Reimplemented from blender::compositor::NodeOperation.

Definition at line 66 of file COM_ImageOperation.cc.

References BKE_image_release_ibuf(), BLI_rcti_init(), blender::compositor::COM_AREA_NONE, get_im_buf(), image_, ImBuf::x, and ImBuf::y.

◆ get_im_buf()

◆ init_execution()

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

◆ set_framenumber()

void blender::compositor::BaseImageOperation::set_framenumber ( int framenumber)
inline

Definition at line 62 of file COM_ImageOperation.h.

References framenumber_.

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

◆ set_image()

void blender::compositor::BaseImageOperation::set_image ( Image * image)
inline

Definition at line 46 of file COM_ImageOperation.h.

References image(), and image_.

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

◆ set_image_user()

void blender::compositor::BaseImageOperation::set_image_user ( const ImageUser & imageuser)
inline

Definition at line 50 of file COM_ImageOperation.h.

References image_user_.

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

◆ set_render_data()

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

Definition at line 54 of file COM_ImageOperation.h.

References rd_.

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

◆ set_view_name()

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

Definition at line 58 of file COM_ImageOperation.h.

References view_name_.

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

Member Data Documentation

◆ buffer_

◆ framenumber_

int blender::compositor::BaseImageOperation::framenumber_
protected

Definition at line 30 of file COM_ImageOperation.h.

Referenced by BaseImageOperation(), and set_framenumber().

◆ image_

◆ image_user_

ImageUser blender::compositor::BaseImageOperation::image_user_
protected

◆ imageheight_

int blender::compositor::BaseImageOperation::imageheight_
protected

Definition at line 28 of file COM_ImageOperation.h.

Referenced by BaseImageOperation(), and init_execution().

◆ imagewidth_

int blender::compositor::BaseImageOperation::imagewidth_
protected

Definition at line 29 of file COM_ImageOperation.h.

Referenced by BaseImageOperation(), and init_execution().

◆ number_of_channels_

int blender::compositor::BaseImageOperation::number_of_channels_
protected

Definition at line 31 of file COM_ImageOperation.h.

Referenced by BaseImageOperation(), and init_execution().

◆ rd_

const RenderData* blender::compositor::BaseImageOperation::rd_
protected

◆ view_name_

const char* blender::compositor::BaseImageOperation::view_name_
protected

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