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

Base class for all image operations. More...

#include <COM_ImageOperation.h>

Inheritance diagram for blender::compositor::BaseImageOperation:
blender::compositor::MultiThreadedOperation blender::compositor::NodeOperation blender::compositor::ImageAlphaOperation blender::compositor::ImageDepthOperation blender::compositor::ImageOperation blender::compositor::MultilayerBaseOperation blender::compositor::MultilayerColorOperation blender::compositor::MultilayerValueOperation blender::compositor::MultilayerVectorOperation

Public Member Functions

void init_execution () override
 
void deinit_execution () override
 
void set_image (Image *image)
 
void set_image_user (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
 
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. 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 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)
 
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 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)
 

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 *UNUSED(output), const rcti &UNUSED(area), Span< MemoryBuffer * > UNUSED(inputs))
 
virtual void update_memory_buffer_partial (MemoryBuffer *output, const rcti &area, Span< MemoryBuffer * > inputs)=0
 
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...
 

Protected Attributes

ImBufbuffer_
 
Imageimage_
 
ImageUserimage_user_
 
floatimage_float_buffer_
 
unsigned int * image_byte_buffer_
 
floatimage_depth_buffer_
 
MemoryBufferdepth_buffer_
 
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
eExecutionModel execution_model_
 
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 20 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

◆ 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 93 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()

ImBuf * blender::compositor::BaseImageOperation::get_im_buf ( )
protectedvirtual

◆ init_execution()

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

◆ set_framenumber()

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

Definition at line 65 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 49 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 ( ImageUser imageuser)
inline

Definition at line 53 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 57 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 61 of file COM_ImageOperation.h.

References view_name_.

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

Member Data Documentation

◆ buffer_

ImBuf* blender::compositor::BaseImageOperation::buffer_
protected

◆ depth_buffer_

MemoryBuffer* blender::compositor::BaseImageOperation::depth_buffer_
protected

◆ framenumber_

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

Definition at line 33 of file COM_ImageOperation.h.

Referenced by BaseImageOperation(), and set_framenumber().

◆ image_

Image* blender::compositor::BaseImageOperation::image_
protected

◆ image_byte_buffer_

unsigned int* blender::compositor::BaseImageOperation::image_byte_buffer_
protected

◆ image_depth_buffer_

float* blender::compositor::BaseImageOperation::image_depth_buffer_
protected

◆ image_float_buffer_

float* blender::compositor::BaseImageOperation::image_float_buffer_
protected

◆ image_user_

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

◆ imageheight_

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

Definition at line 31 of file COM_ImageOperation.h.

Referenced by BaseImageOperation(), and init_execution().

◆ imagewidth_

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

Definition at line 32 of file COM_ImageOperation.h.

Referenced by BaseImageOperation(), and init_execution().

◆ number_of_channels_

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

◆ rd_

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

Definition at line 35 of file COM_ImageOperation.h.

Referenced by BaseImageOperation(), get_im_buf(), and set_render_data().

◆ view_name_

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

Definition at line 36 of file COM_ImageOperation.h.

Referenced by BaseImageOperation(), get_im_buf(), and set_view_name().


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