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

#include <COM_BlurBaseOperation.h>

Inheritance diagram for blender::compositor::BlurBaseOperation:
blender::compositor::MultiThreadedOperation blender::compositor::QualityStepHelper blender::compositor::NodeOperation blender::compositor::FastGaussianBlurOperation blender::compositor::GaussianAlphaBlurBaseOperation blender::compositor::GaussianBlurBaseOperation blender::compositor::GaussianBlurReferenceOperation blender::compositor::GaussianBokehBlurOperation blender::compositor::GaussianAlphaXBlurOperation blender::compositor::GaussianAlphaYBlurOperation blender::compositor::GaussianXBlurOperation blender::compositor::GaussianYBlurOperation

Public Member Functions

virtual void init_data () override
 
void init_execution () override
 
void deinit_execution () override
 
void set_data (const NodeBlurData *data)
 
void set_size (float size)
 
void set_extend_bounds (bool extend_bounds)
 
int get_blur_size (eDimension dim) const
 
void determine_canvas (const rcti &preferred_area, rcti &r_area) override
 
virtual void get_area_of_interest (int input_idx, const rcti &output_area, rcti &r_input_area) override
 Get input operation area being read by this operation on rendering given output area. More...
 
- 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 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))
 
void get_area_of_interest (NodeOperation *input_op, const rcti &output_area, rcti &r_input_area)
 
- Public Member Functions inherited from blender::compositor::QualityStepHelper
 QualityStepHelper ()
 
void set_quality (eCompositorQuality quality)
 

Protected Member Functions

 BlurBaseOperation (DataType data_type8)
 
floatmake_gausstab (float rad, int size)
 
floatmake_dist_fac_inverse (float rad, int size, int falloff)
 
void update_size ()
 
- 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 Member Functions inherited from blender::compositor::QualityStepHelper
void init_execution (QualityHelper helper)
 
int get_step () const
 
int get_offset_add () const
 

Protected Attributes

SocketReaderinput_program_
 
SocketReaderinput_size_
 
NodeBlurData data_
 
float size_
 
bool sizeavailable_
 
bool use_variable_size_
 
- 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_
 

Static Protected Attributes

static constexpr int IMAGE_INPUT_INDEX = 0
 
static constexpr int SIZE_INPUT_INDEX = 1
 

Additional Inherited Members

- Static Protected Member Functions inherited from blender::compositor::NodeOperation
static void combine_hashes (size_t &combined, size_t other)
 

Detailed Description

Definition at line 15 of file COM_BlurBaseOperation.h.

Constructor & Destructor Documentation

◆ BlurBaseOperation()

blender::compositor::BlurBaseOperation::BlurBaseOperation ( DataType  data_type8)
protected

Member Function Documentation

◆ deinit_execution()

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

◆ determine_canvas()

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

◆ get_area_of_interest()

void blender::compositor::BlurBaseOperation::get_area_of_interest ( int  input_idx,
const rcti output_area,
rcti r_input_area 
)
overridevirtual

Get input operation area being read by this operation on rendering given output area.

Implementation don't need to ensure r_input_area is within input operation bounds. The caller must clamp it. TODO: See if it's possible to use parameter overloading (input_id for example).

Parameters
input_idxInput operation index for which we want to calculate the area being read.
output_areaArea being rendered by this operation.
r_input_areaReturned input operation area that needs to be read in order to render given output area.

Reimplemented from blender::compositor::NodeOperation.

Reimplemented in blender::compositor::GaussianBlurReferenceOperation, blender::compositor::GaussianBokehBlurOperation, blender::compositor::GaussianBlurBaseOperation, blender::compositor::FastGaussianBlurOperation, and blender::compositor::GaussianAlphaBlurBaseOperation.

Definition at line 224 of file COM_BlurBaseOperation.cc.

References blender::compositor::COM_CONSTANT_INPUT_AREA_OF_INTEREST, and use_variable_size_.

Referenced by blender::compositor::GaussianAlphaBlurBaseOperation::get_area_of_interest(), blender::compositor::FastGaussianBlurOperation::get_area_of_interest(), blender::compositor::GaussianBlurBaseOperation::get_area_of_interest(), blender::compositor::GaussianBokehBlurOperation::get_area_of_interest(), and blender::compositor::GaussianBlurReferenceOperation::get_area_of_interest().

◆ get_blur_size()

int blender::compositor::BlurBaseOperation::get_blur_size ( eDimension  dim) const

◆ init_data()

void blender::compositor::BlurBaseOperation::init_data ( )
overridevirtual

◆ init_execution()

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

◆ make_dist_fac_inverse()

float * blender::compositor::BlurBaseOperation::make_dist_fac_inverse ( float  rad,
int  size,
int  falloff 
)
protected

◆ make_gausstab()

float * blender::compositor::BlurBaseOperation::make_gausstab ( float  rad,
int  size 
)
protected

◆ set_data()

void blender::compositor::BlurBaseOperation::set_data ( const NodeBlurData data)

◆ set_extend_bounds()

void blender::compositor::BlurBaseOperation::set_extend_bounds ( bool  extend_bounds)
inline

◆ set_size()

void blender::compositor::BlurBaseOperation::set_size ( float  size)
inline

◆ update_size()

void blender::compositor::BlurBaseOperation::update_size ( )
protected

Member Data Documentation

◆ data_

NodeBlurData blender::compositor::BlurBaseOperation::data_
protected

◆ IMAGE_INPUT_INDEX

constexpr int blender::compositor::BlurBaseOperation::IMAGE_INPUT_INDEX = 0
staticconstexprprotected

◆ input_program_

SocketReader* blender::compositor::BlurBaseOperation::input_program_
protected

◆ input_size_

SocketReader* blender::compositor::BlurBaseOperation::input_size_
protected

◆ size_

float blender::compositor::BlurBaseOperation::size_
protected

◆ SIZE_INPUT_INDEX

constexpr int blender::compositor::BlurBaseOperation::SIZE_INPUT_INDEX = 1
staticconstexprprotected

◆ sizeavailable_

bool blender::compositor::BlurBaseOperation::sizeavailable_
protected

◆ use_variable_size_

bool blender::compositor::BlurBaseOperation::use_variable_size_
protected

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